voxel51 / fiftyone

Refine high-quality datasets and visual AI models
https://fiftyone.ai
Apache License 2.0
8.72k stars 551 forks source link

close more items of AdaptiveMenu on pressing ESC #4606

Closed imanjra closed 2 months ago

imanjra commented 2 months ago

What changes are proposed in this pull request?

Close "More Items" popover of adaptive menu when ESC is pressed

How is this patch tested? If it is not, please explain why.

Using ActionRow in split panel view

Release Notes

Is this a user-facing change that should be mentioned in the release notes?

(Details in 1-2 sentences. You can just refer to another PR with a description if this PR is part of a larger change.)

What areas of FiftyOne does this PR affect?

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The recent updates enhance the AdaptiveMenu component by integrating the useKeyDown hook for improved keyboard event handling, allowing the menu to close with the "Escape" key. This significantly enhances user experience. Additionally, the export of the hook promotes reusability across the application, while performance optimizations through memoization reduce unnecessary re-renders. Other components, like ActionsRow and DynamicGroupAction, have been updated to respond better to state changes.

Changes

Files Change Summary
app/packages/components/src/components/AdaptiveMenu/index.tsx Added useCallback for a memoized close function and integrated useKeyDown to close the menu with the "Escape" key. Updated PopoutButton to use the new close function.
app/packages/state/src/hooks/index.ts Added export for the useKeyDown hook, enhancing modularity and enabling keyboard event handling in other components.
app/packages/state/src/hooks/useKeyDown.tsx Introduced a custom useKeyDown hook that listens for specified key presses and invokes a handler, improving keyboard interaction capabilities in React applications.
app/packages/core/src/components/Actions/ActionsRow.tsx Updated Selected component to destructure refresh from adaptiveMenuItemProps and added useEffect to call refresh when samples change, enhancing responsiveness.
app/packages/core/src/components/Actions/DynamicGroupAction.tsx Integrated a refresh method from adaptiveMenuItemProps in a useEffect to trigger updates based on isProcessing state changes and improved loading indicator styling.
app/packages/core/src/components/Grid/useEscape.ts Modified useEscape function to check for active escape key handlers before executing its logic, enhancing control flow and responsiveness.
app/packages/state/src/recoil/atoms.ts Introduced escapeKeyHandlerIdsAtom to manage escape key handlers in Recoil state, adding to the state management functionality.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant AdaptiveMenu
    participant useKeyDown

    User->>AdaptiveMenu: Press "Escape"
    activate AdaptiveMenu
    AdaptiveMenu->>useKeyDown: Check for key press
    useKeyDown-->>AdaptiveMenu: Key detected
    AdaptiveMenu->>AdaptiveMenu: Set open state to false
    deactivate AdaptiveMenu

🐰 In a menu so adaptive and bright,
It listens for keys, both day and night.
With "Escape" it closes, oh what a delight,
A hop and a skip, everything feels right!
So here’s to the changes, both clever and neat,
A joyous little dance, let’s all take a seat! 🎉


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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
imanjra commented 2 months ago

Works! I'm noticing that ESC now clears sample selection and closes the action row popout (first recording)

This will be interesting to solve. Thinking out loud, we would need a common stack for key-down handler and as you press, things are popped off the stack as they handled

Maybe out of scope, but I'm also seeing some wrapping occur in certain actions when creating dynamic groups.

Nice catch! I wonder if we should instead use the three loading dots instead of that loading text... Will check it out

imanjra commented 2 months ago

@benjaminpkane fixed both wrapping of dynamic group button's loading state and escape clearing selected samples when adaptive menu's more items popout is opened.