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(docs): tabs.mdx #4113

Closed
wants to merge 1 commit into from
Closed

fix(docs): tabs.mdx #4113

wants to merge 1 commit into from

Conversation

0xKunah
Copy link

@0xKunah 0xKunah commented Nov 19, 2024

📝 Description

Updated the react router tabs using example, the id prop of Tab component isn't working with selectedKey, the working one is key

⛳️ Current behavior (updates)

Tabs docs provides an example with react router, but this example doesn't work properly, the selectedKey doesn't affect the component UI if no key prop is given

## 🚀 New behavior

Tabs docs now provides a working example with react router

💣 Is this a breaking change (Yes/No):

No

Summary by CodeRabbit

  • Documentation
    • Updated the Tabs component documentation to include a key prop for the Tab component, enhancing tab identification.
    • Expanded usage examples for integrating the Tabs component with routing libraries like Next.js and React Router.
    • Improved clarity and completeness of examples, particularly on synchronizing the selected tab with the current URL.
    • Retained existing sections on dynamic rendering, disabled tabs, and accessibility compliance.

Updated the react router tabs using example, the 'id' prop of Tab component isn't working with selectedKey, the working one is 'key'
@0xKunah 0xKunah requested a review from jrgarciadev as a code owner November 19, 2024 04:21
Copy link

changeset-bot bot commented Nov 19, 2024

⚠️ No Changeset found

Latest commit: 24ca5b9

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

Copy link

vercel bot commented Nov 19, 2024

@0xKunah is attempting to deploy a commit to the NextUI Inc Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Nov 19, 2024

Walkthrough

The changes in this pull request involve updates to the documentation of the Tabs component, specifically enhancing the Tab component's signature to include a key prop. This adjustment is reflected in the React Router examples, where each Tab instance now has a unique key. The documentation has been expanded to include more detailed usage examples for integrating the Tabs component with routing libraries like Next.js and React Router, focusing on the selectedKey prop. Other sections remain unchanged, ensuring comprehensive guidance on the component's usage.

Changes

File Path Change Summary
apps/docs/content/docs/components/tabs.mdx Updated Tab component signatures to include a key prop in React Router examples; expanded documentation with detailed usage examples for routing integration.

Possibly related PRs

Suggested labels

📋 Scope : Docs, ✨ Type: Enhancement

Suggested reviewers

  • wingkwong
  • jrgarciadev

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c6326d1 and 24ca5b9.

📒 Files selected for processing (1)
  • apps/docs/content/docs/components/tabs.mdx (1 hunks)
🔇 Additional comments (1)
apps/docs/content/docs/components/tabs.mdx (1)

172-175: LGTM! The React Router example now correctly uses the key prop.

The changes correctly demonstrate how to synchronize tabs with React Router using the key prop instead of id. This aligns with the component's implementation and ensures proper tab selection based on the current route.

Let's verify if any other examples in the file need similar updates:

✅ Verification successful

All Tab components in the file are correctly using the key prop

The verification confirms that there are no remaining instances of Tab components using the id prop in the documentation. All Tab components are consistently using the key prop, which aligns with the component's implementation.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any remaining instances of Tab components using 'id' prop
# that might need to be updated to use 'key' prop instead

# Search for Tab components with id prop in the file
rg --type mdx '<Tab\s+id=' apps/docs/content/docs/components/

Length of output: 91


Script:

#!/bin/bash
# Search for Tab components with id prop in the file, using ripgrep without file type filter
rg '<Tab\s+id=' apps/docs/content/docs/components/tabs.mdx

# Also search for any other Tab components in the file for context
rg '<Tab\s+' apps/docs/content/docs/components/tabs.mdx

Length of output: 503


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

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

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.

@wingkwong
Copy link
Member

duplicate - #2405. besides, we're revamping the overall docs structure. will handle that there.

@wingkwong wingkwong closed this Nov 19, 2024
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.

2 participants