fix: automatic opening while browsing
What does this PR do?
fixes the bug where if the nav is closed and you are navigating between the children it does not open automatically
Fixes #3183
https://github.com/user-attachments/assets/80739d32-0c2a-4847-a8c6-a124e19ff7aa
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
- [ ] 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
- Refactor
- Improved the logic for automatically opening navigation items based on the current page, making navigation behavior more dynamic and responsive to route changes.
⚠️ No Changeset found
Latest commit: ad44ef3f0364624c4bd27adf471a4a0188a4c4ac
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
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 13, 2025 4:01pm |
| engineering | ✅ Ready (Inspect) | Visit Preview | 💬 Add feedback | May 13, 2025 4:01pm |
@revogabe is attempting to deploy a commit to the Unkey Team on Vercel.
A member of the Team first needs to authorize it.
📝 Walkthrough
"""
Walkthrough
The change updates the dashboard sidebar navigation item open state logic by removing a hardcoded paths array and instead dynamically generating a path from the item's label using slugification. The open condition now checks if the current pathname starts with this generated path.
Changes
| File(s) | Change Summary |
|---|---|
| apps/dashboard/components/navigation/sidebar/app-sidebar/components/nav-items/nested-nav-item.tsx | Replaced hardcoded paths array with dynamic slugified path from item label to determine navigation item open state. |
| apps/dashboard/package.json | Added slugify dependency version ^1.6.6. |
Possibly related PRs
- unkeyed/unkey#3199: Both PRs modify the sidebar nested navigation item component to control open/collapse state based on the current pathname, with the main PR simplifying path matching logic while the retrieved PR refactors and expands the state management for automatic collapse behavior.
Suggested labels
Dashboard, Bug
Suggested reviewers
- mcstepp
- ogzhanolguncu
- perkinsjr """
[!TIP]
⚡️ Faster reviews with caching
- CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure
Review - Disable Cacheat either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off theData Retentionsetting under your Organization Settings.Enjoy the performance boost—your workflow just got faster.
📜 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 ad44ef3f0364624c4bd27adf471a4a0188a4c4ac and 00124087d9e1b8454b48f2a2bec863f0c1fb997a.
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (2)
apps/dashboard/components/navigation/sidebar/app-sidebar/components/nav-items/nested-nav-item.tsx(2 hunks)apps/dashboard/package.json(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- apps/dashboard/package.json
🚧 Files skipped from review as they are similar to previous changes (1)
- apps/dashboard/components/navigation/sidebar/app-sidebar/components/nav-items/nested-nav-item.tsx
✨ 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.
🪧 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
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR.@coderabbitai generate sequence diagramto generate a sequence diagram of the changes in this PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.
Thank you for following the naming conventions for pull request titles! 🙏
I tried to do the same things from your video, both in main and in your PR and results were similar. Am I missing something?
This PR already did most of the work #3199
However, we encountered a bug where, if the navItem was closed and we navigated through the breadcrumbs, it should reopen the nav—but that wasn’t happening.
This PR fixes that.
adding slugify to handle use cases when the label has spaces e.g. Audit Log
Note why I used item.label instead of href
Since the default
hreffor settings and authorization are not unique like/settingsbut/settings/general, I had to use the label itself to make the comparison easier instead of using the href.In the case of
/apisit works because the main href is/apis