Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: duplicate modal instances from hotkey activation #1058

Merged
merged 10 commits into from
Apr 16, 2024

Conversation

deepgolani4
Copy link
Contributor

@deepgolani4 deepgolani4 commented Mar 26, 2024

Description

Currently, when the command menu is opened using the Command+K hotkey, two modals are getting rendered.
This is because the modals are mounted in two components: header and desktop-nav. Upon triggering the hotkey, both modals are rendered.

Related Issue

#1032

Changes Made

The changes I made are in the desktop nav component. If the desktop nav receives the command menu state value and the state setter function, it will trigger only that. If not, it will trigger the state setter that is defined in the desktop nav. This way, we are preventing the modal from mounting two times.

Testing Performed

  • Tested behaviour of command menu in the portal
  • Tested on browsers chrome, arc, safari, chrome, firefox

Checklist

  • I have tested these changes locally and they work as expected.
  • I have added/updated tests that prove the effectiveness of these changes.
  • I have updated the documentation to reflect these changes, if applicable.
  • I have followed the project's coding style guidelines.
  • I have addressed the code review feedback from the previous submission, if applicable.

Summary by CodeRabbit

  • New Features
    • Enhanced the navigation experience by integrating command menu state management directly within the DesktopNav component, allowing for smoother interactions and control.
  • Refactor
    • Simplified the handling of the command menu by removing the CommandMenu component and managing its functionality within DesktopNav.

Copy link

vercel bot commented Mar 26, 2024

@deepgolani4 is attempting to deploy a commit to the Documenso Team Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Mar 26, 2024

Walkthrough

The update involves enhancing the DesktopNav component to manage the command menu's state via new props isCommandMenuOpen and setIsCommandMenuOpen. These changes allow the component to control the visibility of the command menu dynamically. The Header component is also updated to pass these new props to DesktopNav, ensuring proper state management and interaction between components.

Changes

File Path Change Summary
.../desktop-nav.tsx, .../header.tsx DesktopNav component in desktop-nav.tsx now includes isCommandMenuOpen and setIsCommandMenuOpen props for managing command menu state. Updated state initialization and menu toggle handling. Header component in header.tsx updated to pass these props to DesktopNav.

Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between aaccf12 and 4263408.
Files selected for processing (2)
  • apps/web/src/components/(dashboard)/layout/desktop-nav.tsx (4 hunks)
  • apps/web/src/components/(dashboard)/layout/header.tsx (1 hunks)
Files skipped from review as they are similar to previous changes (2)
  • apps/web/src/components/(dashboard)/layout/desktop-nav.tsx
  • apps/web/src/components/(dashboard)/layout/header.tsx

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

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

Copy link

github-actions bot commented Mar 26, 2024

Hey There! and thank you for opening this pull request! 📝👋🏼

We require pull request titles to follow the Conventional Commits Spec and it looks like your proposed title needs to be adjusted.

Details:

Unknown release type "Fix" found in pull request title "Fix: duplicate modal instances from hotkey activation". 

Available types:
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
 - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 - refactor: A code change that neither fixes a bug nor adds a feature
 - perf: A code change that improves performance
 - test: Adding missing tests or correcting existing tests
 - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
 - chore: Other changes that don't modify src or test files
 - revert: Reverts a previous commit

@github-actions github-actions bot added the apps: web Issues related to the webapp label Mar 26, 2024
@Mythie
Copy link
Collaborator

Mythie commented Mar 26, 2024

Hey there, it looks like you haven't accepted our contributor license agreement yet. In order for us to accept your pull request we ask that you please fill out the CLA:

https://documen.so/cla

@deepgolani4 deepgolani4 changed the title Fix: Duplicate Modal Instances from Hotkey Activation Fix: duplicate modal instances from hotkey activation Mar 26, 2024
@deepgolani4 deepgolani4 changed the title Fix: duplicate modal instances from hotkey activation fix: duplicate modal instances from hotkey activation Mar 26, 2024
@deepgolani4
Copy link
Contributor Author

@Mythie , apologies for the direct ping, but I would appreciate your input on handling an edge case or suggesting a more suitable approach for this codebase.
It would be great if you could review this PR.

Comment on lines 29 to 30
isCommandMenuOpen?: boolean;
setIsCommandMenuOpen?: (value: boolean) => void;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's fine to just force these to not be undefined since this component isn't reused (and isn't planned to be reused) anywhere else

This would let us clean up the code a little and remove the open state here and get rid of the CommandMenu

Copy link
Collaborator

@dguyen dguyen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks 🙏

@dguyen dguyen merged commit db9899d into documenso:main Apr 16, 2024
9 of 13 checks passed
@ElTimuro
Copy link
Member

@deepgolani4 thank you this bothered my a lot, especially in demos :D

@deepgolani4
Copy link
Contributor Author

Thanks 🙏

I just got back from my trip and saw the updates @dguyen made on the PR based on the review comments.
Thank you so much once again and happy to contribute @dguyen.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
apps: web Issues related to the webapp
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants