unkey icon indicating copy to clipboard operation
unkey copied to clipboard

fix: first click on nav

Open revogabe opened this issue 7 months ago • 5 comments

What does this PR do?

Fixes #3223

First click now works the first time when the bar is collapsed.

https://github.com/user-attachments/assets/14aa10f2-cd3e-4f2c-8f13-28ac769ad0c2

If there is not an issue for this, please create one first. This is used to tracking purposes and also helps use understand why this PR exists

Type of change

  • [X] Bug fix (non-breaking change which fixes an issue)
  • [ ] Chore (refactoring code, technical debt, workflow improvements)
  • [ ] Enhancement (small improvements)
  • [ ] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • [ ] This change requires a documentation update

How should this be tested?

  • Test A
  • Test B

Checklist

Required

  • [ ] Filled out the "How to test" section in this PR
  • [ ] Read Contributing Guide
  • [ ] Self-reviewed my own code
  • [ ] Commented on my code in hard-to-understand areas
  • [ ] Ran pnpm build
  • [ ] Ran pnpm fmt
  • [ ] Checked for warnings, there are none
  • [ ] Removed all console.logs
  • [ ] Merged the latest changes from main onto my branch with git pull origin main
  • [ ] My changes don't cause any responsiveness issues

Appreciated

  • [ ] If a UI change was made: Added a screen recording or screenshots to this PR
  • [ ] Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

  • Bug Fixes
    • Improved menu item behavior in the sidebar so that nested items only toggle when the sidebar is open, preventing unintended toggling when the sidebar is closed.

revogabe avatar May 06 '25 16:05 revogabe

⚠️ No Changeset found

Latest commit: 4e6093999b61bbb52bae53a859dbdf051e03acb4

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

changeset-bot[bot] avatar May 06 '25 16:05 changeset-bot[bot]

@revogabe is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

vercel[bot] avatar May 06 '25 16:05 vercel[bot]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
dashboard ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 9, 2025 8:32pm
engineering ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 9, 2025 8:32pm

vercel[bot] avatar May 06 '25 16:05 vercel[bot]

📝 Walkthrough

Walkthrough

The change updates the NestedNavItem component to utilize the useSidebar hook for accessing the sidebar's open state. The click handler now checks if the sidebar is open before toggling the menu item's open state, preventing toggling when the sidebar is collapsed.

Changes

File(s) Change Summary
apps/dashboard/components/navigation/sidebar/app-sidebar/components/nav-items/nested-nav-item.tsx Added useSidebar hook usage; updated click handler to check sidebar open state before toggling menu item children

Assessment against linked issues

Objective Addressed Explanation
Prevent child menu toggling when sidebar is collapsed (#3223)

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6d94d59c58a06f9e6d9963c52e03cbf83f5e3d54 and 4e6093999b61bbb52bae53a859dbdf051e03acb4.

📒 Files selected for processing (1)
  • apps/dashboard/components/navigation/sidebar/app-sidebar/components/nav-items/nested-nav-item.tsx (3 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
apps/dashboard/components/navigation/sidebar/app-sidebar/components/nav-items/nested-nav-item.tsx (1)
apps/dashboard/components/ui/sidebar.tsx (1)
  • useSidebar (602-602)
🔇 Additional comments (3)
apps/dashboard/components/navigation/sidebar/app-sidebar/components/nav-items/nested-nav-item.tsx (3)

6-6: Added useSidebar hook import

The new import is necessary to access the sidebar state, which is needed for the fix.


34-34: Correctly initialized sidebar state

Using the useSidebar hook to access the sidebar's open state for conditional rendering.


65-65: Fixed first click issue with navigation items

This change addresses the core issue by only toggling the navigation item's open state when the sidebar itself is open. This prevents the confusing behavior where clicking a nav item while the sidebar is collapsed doesn't produce the expected result on first click.

✨ Finishing Touches
  • [ ] 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

coderabbitai[bot] avatar May 06 '25 16:05 coderabbitai[bot]

Thank you for following the naming conventions for pull request titles! 🙏

github-actions[bot] avatar May 06 '25 16:05 github-actions[bot]