Customizable components now handled via store

[bsekachev]

Motivation and context

How has this been tested?

Checklist

• I submit my changes into the develop branch
• I have created a changelog fragment
• I have updated the documentation accordingly
• I have added tests to cover my changes
• I have linked related issues (see GitHub docs)
• I have increased versions of npm packages if it is necessary
  (cvat-canvas,
  cvat-core,
  cvat-data and
  cvat-ui)

License

• I submit my code changes under the same MIT License that covers the project.
  Feel free to contact the maintainers if that's a concern.

Summary by CodeRabbit

• New Features

  • Introduced a new action type for overriding UI components in the plugin system.
  • Added a dedicated button for saving annotations with keyboard shortcut support.
  • Enhanced flexibility in managing UI components through plugins.

• Bug Fixes

  • Removed unnecessary props and streamlined the save functionality in various components.

• Refactor

  • Simplified component structures and improved rendering logic across multiple components.
  • Updated state management for plugins and UI components.

• Documentation

  • Updated export declarations for better usability and clarity.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes encompass the introduction of a new action type, OVERRIDE_UI_COMPONENT, enhancing the plugin system's capabilities for managing UI components. Several components have been refactored, including the removal of outdated props and the introduction of new components like SaveAnnotationsButton. The state management structure has been updated to accommodate new properties for overridable components, and various imports and rendering logic have been simplified across multiple files. Overall, these modifications streamline the codebase and enhance the flexibility of UI interactions.

Changes

Files	Change Summary
cvat-ui/src/actions/plugins-actions.ts	Added OVERRIDE_UI_COMPONENT to PluginsActionTypes, modified removeUICallback parameter, and added overrideUIComponent method.
cvat-ui/src/components/annotation-page/top-bar/left-group.tsx	Removed onSaveAnnotation prop and replaced SaveButtonComponent with SaveAnnotationsButton.
cvat-ui/src/components/annotation-page/top-bar/save-annotations-button.tsx	Introduced SaveAnnotationsButton component for saving annotations with keyboard shortcuts and visual feedback. Added SaveAnnotationsButtonWrap for overrides.
cvat-ui/src/components/annotation-page/top-bar/top-bar.tsx	Removed onSaveAnnotation prop and associated logic.
cvat-ui/src/components/customizable-components/index.tsx	Removed SAVE_ANNOTATION_BUTTON component and related logic.
cvat-ui/src/components/cvat-app.tsx	Eliminated handling and rendering of loggedInModals.
cvat-ui/src/components/plugins-entrypoint.tsx	Removed CustomizableComponents import and added overrideUIComponent to PluginActionCreators.
cvat-ui/src/components/projects-page/project-item.tsx	Changed import of Project type to cvat-core-wrapper.
cvat-ui/src/components/quality-control/task-quality/allocation-table.tsx	Renamed AllocationTableComponent to AllocationTable and added AllocationTableWrap for state-driven rendering.
cvat-ui/src/components/quality-control/task-quality/quality-magement-tab.tsx	Replaced customizable component for allocation table with direct import of AllocationTable.
cvat-ui/src/components/quality-control/task-quality/quality-overview-tab.tsx	Restructured QualityOverviewTab to return PaidFeaturePlaceholder and added QualityOverviewTabWrap.
cvat-ui/src/components/quality-control/task-quality/summary.tsx	Changed SummaryComponent to a default export.
cvat-ui/src/containers/annotation-page/top-bar/top-bar.tsx	Removed onSaveAnnotation method from AnnotationTopBarContainer.
cvat-ui/src/reducers/index.ts	Added overridableComponents to PluginsState interface and removed old structure for annotationPage.
cvat-ui/src/reducers/plugins-reducer.ts	Updated defaultState with overridableComponents, modified findContainerFromPath, and added case for OVERRIDE_UI_COMPONENT.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant SaveAnnotationsButton
    participant Redux
    participant Server

    User->>SaveAnnotationsButton: Click Save
    SaveAnnotationsButton->>Redux: Dispatch saveAnnotationsAsync
    Redux->>Server: Send save request
    Server-->>Redux: Acknowledge save
    Redux-->>SaveAnnotationsButton: Update saving state
    SaveAnnotationsButton-->>User: Show "Saving..." or "Save"

Loading

🐰 In the code, we hop and play,
New buttons for saving, hip-hip-hooray!
With plugins that dance and components that sing,
Our UI's now bright, like the joy of spring!
Let's celebrate changes, both big and small,
For a rabbit's delight is the best change of all! 🌼✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  -- I pushed a fix in commit <commit_id>, please review it.
  -- Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  -- @coderabbitai generate unit testing code for this file.
  -- @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  -- @coderabbitai generate interesting stats about this repository and render them as a table.
  -- @coderabbitai read src/utils.ts and generate unit testing code.
  -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  -- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 0% with 17 lines in your changes missing coverage. Please review.

Project coverage is 83.14%. Comparing base (beee177) to head (3386ee9).

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #8435      +/-   ##
===========================================
- Coverage    83.14%   83.14%   -0.01%     
===========================================
  Files          397      397              
  Lines        41891    41907      +16     
  Branches      3879     3882       +3     
===========================================
+ Hits         34831    34842      +11     
- Misses        7060     7065       +5     

Components	Coverage Δ
cvat-ui	78.54% <0.00%> (-0.01%)	⬇️
cvat-server	87.22% <ø> (ø)

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud