[WEB-2047] refactor: editor side menu

[aaryan610]

Summary by CodeRabbit

• New Features

  • Enhanced the AI Features Menu with improved visibility state management.
  • Added functionality to clear ongoing tasks and responses when the AI menu is closed.

• Bug Fixes

  • Disabled unintended closure of the side menu during keyboard interactions.

• Refactor

  • Reorganized export statements for improved clarity and maintainability.
  • Memoized the AI menu rendering function for better performance.

• Types

  • Updated type definitions to streamline prop management and improve component interaction.

[coderabbitai]

Walkthrough

The recent changes enhance the AIFeaturesMenu and related components by introducing an isOpen property to manage the visibility state of menus effectively. This addition allows for improved state handling and user experience by ensuring components respond dynamically to user interactions. Additionally, the restructuring of export statements and the introduction of new helper functions optimize performance and maintainability throughout the codebase.

Changes

Files	Change Summary
packages/editor/src/core/components/menus/ai-menu.tsx	Added isOpen property to AIFeaturesMenu, enhancing visibility management.
packages/editor/src/core/components/menus/index.ts	Reordered export statements for clarity, moving bubble-menu to the top.
packages/editor/src/core/extensions/side-menu.tsx	Commented out the keydown event handler in SideMenu, preventing unintended side menu closures via keyboard interactions.
packages/editor/src/core/types/ai.ts	Renamed TMenuProps to TAIMenuProps, added isOpen property, and updated TAIHandler to use the new type.
web/ce/components/pages/editor/ai/menu.tsx	Introduced isOpen to EditorAIMenu props and added a useEffect to reset activeTask and response on menu close for better state management.
web/core/components/pages/editor/editor-body.tsx	Added getAIMenu function using useCallback to optimize rendering of EditorAIMenu, improving performance by reducing unnecessary re-renders.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant AIFeaturesMenu
    participant EditorAIMenu
    participant PageEditorBody

    User->>PageEditorBody: Open Menu
    PageEditorBody->>AIFeaturesMenu: set isOpen(true)
    AIFeaturesMenu->>EditorAIMenu: Render with isOpen=true
    User->>EditorAIMenu: Interact with Menu
    User->>PageEditorBody: Close Menu
    PageEditorBody->>AIFeaturesMenu: set isOpen(false)
    AIFeaturesMenu->>EditorAIMenu: Reset activeTask and response

Loading

Poem

🐇 In the garden where menus bloom,
A new toggle whispers, "No more gloom!"
With each click and each delightful sway,
Open and close, we dance and play.
A rabbit's joy, a feature refined,
In this code, a harmony we find! 🌼

---

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 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 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.

[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 5fc99c9 and dd9e645.

Files selected for processing (6)

• packages/editor/src/core/components/menus/ai-menu.tsx (1 hunks)
• packages/editor/src/core/components/menus/index.ts (1 hunks)
• packages/editor/src/core/extensions/side-menu.tsx (1 hunks)
• packages/editor/src/core/types/ai.ts (1 hunks)
• web/ce/components/pages/editor/ai/menu.tsx (4 hunks)
• web/core/components/pages/editor/editor-body.tsx (4 hunks)

Files skipped from review due to trivial changes (1)

• packages/editor/src/core/components/menus/index.ts

Additional comments not posted (5)

packages/editor/src/core/types/ai.ts (1)

1-7: Type definition updates are correct.

The renaming of TMenuProps to TAIMenuProps and the addition of the isOpen property are consistent with the changes described. Ensure that these changes are reflected in all relevant parts of the codebase.

packages/editor/src/core/components/menus/ai-menu.tsx (1)

90-92: Integration of isOpen property is well-implemented.

The addition of the isOpen property to the menu function enhances the component's state management. Ensure that the isOpen property is utilized consistently across all components that use this function.

packages/editor/src/core/extensions/side-menu.tsx (1)

185-185: Verify the impact of commenting out the keydown event handler.

Commenting out the keydown event handler may affect the user experience by preventing the side menu from closing on keyboard interactions. Verify that this change aligns with the intended behavior and does not introduce any usability issues.

Run the following script to check for any other references to hideSideMenu that may need adjustments:

web/core/components/pages/editor/editor-body.tsx (1)

99-103: Memoization of getAIMenu using useCallback is effective.

The use of useCallback for getAIMenu enhances performance by preventing unnecessary re-renders. Ensure that the dependencies are correctly specified and that the function is used consistently.

web/ce/components/pages/editor/ai/menu.tsx (1)

23-23: State management improvements in EditorAIMenu are well-implemented.

The addition of the isOpen prop and the useEffect hook to reset states enhances the component's responsiveness. Ensure that these changes are consistently applied and do not introduce any unintended side effects.

Also applies to: 61-61, 130-137