Display shortcuts correctly in attribute annotation mode

[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

  • Enhanced the AttrValuesList component for improved management and display of attribute values and their associated shortcuts.
  • Introduced dynamic key generation for shortcuts, resulting in a more user-friendly interface.

• Bug Fixes

  • Updated rendering logic to ensure consistent display of shortcut keys across different contexts.

[coderabbitai]

Walkthrough

The changes involve enhancements to the AttrValuesList component in the attribute-editor.tsx file. A new utility function, makeKey, has been introduced for dynamic key generation based on an index, replacing hardcoded keys. The handling of component shortcuts has been updated to use this new function, improving consistency. The variable processedValues has been renamed to valuesWithShortcuts for clarity. Additionally, the rendering logic now incorporates normalizedKeyMap, allowing for a more dynamic display of key sequences associated with attribute values.

Changes

Files	Change Summary
cvat-ui/src/components/.../attribute-editor.tsx	Introduced makeKey function for dynamic key generation; updated shortcut handling; renamed variable processedValues to valuesWithShortcuts; modified rendering logic to use normalizedKeyMap.

Poem

🐇 In the garden of code, changes bloom bright,
Keys dance and twirl, a delightful sight.
With shortcuts anew, the interface sings,
A symphony of functions, oh, what joy it brings!
So hop along, friends, let’s celebrate this cheer,
For every small change makes our vision clear! 🌼

---

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>.
  • 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 show all the console.log statements in this repository.
  • @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.

[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

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c8f57e3 and 1a523c0.

Files selected for processing (1)

• cvat-ui/src/components/annotation-page/attribute-annotation-workspace/attribute-annotation-sidebar/attribute-editor.tsx (7 hunks)

Additional comments not posted (3)

cvat-ui/src/components/annotation-page/attribute-annotation-workspace/attribute-annotation-sidebar/attribute-editor.tsx (3)

35-35: Approved: New utility function makeKey.

The introduction of makeKey enhances maintainability by centralizing key generation. This change aligns with the PR objectives to improve the handling of keyboard shortcuts.

---

37-39: Approved: Consistent key generation in component shortcuts.

Using makeKey within the loop ensures that keys are dynamically and consistently generated, which is crucial for the scalability and maintainability of shortcut handling.

---

Line range hint 214-325: Approved: Enhanced handling and display of shortcuts in AttrValuesList.

The modifications in AttrValuesList utilize the makeKey function for dynamic key generation and incorporate normalizedKeyMap for displaying key sequences. These changes significantly improve the clarity and functionality of the component, aligning with the PR's objectives to enhance user experience.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.58%. Comparing base (c8f57e3) to head (1a523c0).

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #8415      +/-   ##
===========================================
- Coverage    83.58%   83.58%   -0.01%     
===========================================
  Files          396      396              
  Lines        41906    41906              
  Branches      3881     3881              
===========================================
- Hits         35027    35026       -1     
- Misses        6879     6880       +1     

Components	Coverage Δ
cvat-ui	79.53% <ø> (-0.01%)	⬇️
cvat-server	87.18% <ø> (ø)