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

Added active class to alpha mail sidebar #202

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Vishvsalvi
Copy link

@Vishvsalvi Vishvsalvi commented Jul 19, 2024

image

The active class remains on the sidebar

Summary by CodeRabbit

  • New Features

    • Enhanced sidebar navigation to incorporate search parameters for dynamic link generation.
    • Improved logic for active link styling, allowing for more accurate indication of selected items.
  • Bug Fixes

    • Refined active state determination for navigation links to support both exact and partial matches, enhancing usability.

Copy link

vercel bot commented Jul 19, 2024

@Vishvsalvi is attempting to deploy a commit to the Inbox Zero Team on Vercel.

A member of the Team first needs to authorize it.

@CLAassistant
Copy link

CLAassistant commented Jul 19, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

coderabbitai bot commented Jul 19, 2024

Walkthrough

The updates to the SideNav component enhance its navigation capabilities by integrating search parameters into the sidebar links. The introduction of the useSearchParams hook allows the component to dynamically adjust the links based on the current URL's query parameters. This change improves user experience by ensuring that the active states of navigation links accurately reflect both exact and partial matches, thereby making the navigation more intuitive and context-aware.

Changes

Files Change Summary
apps/web/components/SideNav.tsx Enhanced Sidebar, Links, and NavLink components to utilize search parameters for dynamic navigation. Logic for determining active link states improved.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Sidebar
    participant Links
    participant NavLink

    User->>Sidebar: Navigates to a page
    Sidebar->>Links: Fetch current path and search parameters
    Links->>NavLink: Generate links with typeParams
    NavLink->>Links: Determine active state based on path and typeParams
    Links-->>User: Display updated navigation links
Loading

🐰 In the sidebar, where links now dance,
🐇 Type parameters give users a chance.
🌼 With a hop and a skip, the paths align,
🌈 Active states shine, oh how they intertwine!
🥕 Hooray for the changes, a joyful cheer,
🐾 Our navigation's clearer, come hop over here!


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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

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 4206367 and 396c2bb.

Files selected for processing (1)
  • apps/web/components/SideNav.tsx (4 hunks)
Additional comments not posted (4)
apps/web/components/SideNav.tsx (4)

4-4: LGTM! The new import statement is appropriate.

The useSearchParams hook is correctly imported from next/navigation.


300-302: LGTM! The new logic for capturing search parameters is correct.

The useSearchParams hook is used to retrieve the "type" parameter from the URL.


338-346: LGTM! The new logic for constructing the path prop is correct.

The path prop now includes the typeParams, ensuring that the links reflect the current type parameter.


401-401: Verify the new logic for determining the active state.

The isActive variable now checks for both exact matches and partial matches. Ensure that this logic correctly identifies the active state.

Verification successful

Verified the new logic for determining the active state.

The isActive variable now correctly checks for both exact matches and partial matches, ensuring the correct identification of the active state.

  • isActive is used to determine the class of the link element, toggling between "bg-gray-800" for active links and "hover:bg-gray-800" for inactive links.
Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the logic for determining the active state of navigation links.

# Test: Search for the usage of the `isActive` variable. Expect: Correct identification of active state.
rg --type javascript -A 5 $'const isActive'

Length of output: 79


Script:

#!/bin/bash
# Description: Verify the logic for determining the active state of navigation links.

# Test: Search for the usage of the `isActive` variable. Expect: Correct identification of active state.
rg --type ts -A 10 $'const isActive'

Length of output: 773

Copy link
Owner

@elie222 elie222 left a comment

Choose a reason for hiding this comment

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

One question

@@ -392,14 +398,15 @@ function Links(props: { path: string; links: NavItem[] }) {

function NavLink(props: { path: string; link: NavItem }) {
const { link } = props;
const isActive = props.path === link.href || props.path.includes(link.href);
Copy link
Owner

Choose a reason for hiding this comment

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

What was the reason for includes here?
But also includes would match === too.

Copy link
Author

@Vishvsalvi Vishvsalvi Jul 28, 2024

Choose a reason for hiding this comment

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

The includes matches the query string, === doesn't match the query string it is for the paths.

Copy link
Owner

@elie222 elie222 Aug 1, 2024

Choose a reason for hiding this comment

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

If props.path.includes(link.href) is true then it must be that props.path === link.href is true

Copy link
Author

Choose a reason for hiding this comment

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

Ohh I haven't checked that yet! If that's the case I'll make the changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants