fix(docs) routing.mdx

[CanRau]

buildLocation expects an object docs

Summary by CodeRabbit

• New Features

  • Enhanced client-side routing integration with NextUI components through the new useHref prop in the NextUIProvider.
  • Updated instructions for using useRouter with Next.js and useNavigate with React Router.

• Documentation

  • Clarified setup instructions for routing in Next.js and React Router.
  • Updated TanStack Router section to accurately reflect changes in the useHref function.

[changeset-bot]

⚠️ No Changeset found

Latest commit: f84a160

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

[vercel]

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

A member of the Team first needs to authorize it.

[coderabbitai]

Walkthrough

The changes involve updates to the documentation regarding client-side routing integration with NextUI components. The NextUIProvider component now accepts a useHref prop for custom href generation, enhancing compatibility with Next.js and React Router. The documentation clarifies the use of the useRouter hook in Next.js and emphasizes the context requirements for React Router. Additionally, updates to the TanStack Router section ensure correct href generation. Overall, these modifications aim to streamline routing setup and provide clearer implementation examples.

Changes

File Path	Change Summary
apps/docs/content/docs/guide/routing.mdx	Updated to include the useHref prop in NextUIProvider, clarified Next.js and React Router integration, and modified TanStack Router instructions.

Possibly related PRs

• fix(system): missing useHref logic #2943: This PR addresses missing useHref logic in the @nextui-org/system package, which is directly related to the changes made in the main PR regarding the useHref prop in the NextUIProvider component.
• feat(docs): added tanstack router to the routing section in the documentation #3271: This PR enhances the documentation for integrating the TanStack Router with NextUI, specifically mentioning the useHref prop, which aligns with the main PR's updates on routing documentation and the useHref functionality.

Suggested labels

📋 Scope : Docs

Suggested reviewers

• tianenpang
• wingkwong

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

apps/docs/content/docs/guide/routing.mdx (1)

272-272: LGTM! Consider adding documentation references.

The fix correctly implements buildLocation by passing the required object parameter. To help future developers, consider adding:

1. A code comment explaining that buildLocation expects an object
2. A link to the TanStack Router documentation for buildLocation

+      // buildLocation expects an object with `to` property
+      // See: https://tanstack.com/router/latest/docs/api/router#buildlocation
       useHref={(to) => router.buildLocation({ to }).href}

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 8c8b70d and f84a160.

📒 Files selected for processing (1)

• apps/docs/content/docs/guide/routing.mdx (1 hunks)