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

docs(blog): v2.6.0 link typo #4342

Merged
merged 1 commit into from
Dec 12, 2024

Conversation

OwLu0905
Copy link
Contributor

@OwLu0905 OwLu0905 commented Dec 12, 2024

Closes #

📝 Description

⛳️ Current behavior (updates)

form-typo
route-link-typo

🚀 New behavior

link should work

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

No

📝 Additional Information

Summary by CodeRabbit

  • New Features

    • Introduced four new components: Form, Drawer, Input OTP, and Alert.
    • Added a use-theme hook for runtime theme management.
    • Enhanced Select, Autocomplete, and Listbox components with virtualization for better performance with large datasets.
    • Implemented draggable support for modals.
  • Bug Fixes

    • Numerous bug fixes and improvements for better functionality and performance.
  • Documentation

    • Improved clarity and usability of documentation to enhance the developer experience.

Copy link

changeset-bot bot commented Dec 12, 2024

⚠️ No Changeset found

Latest commit: fb65234

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 Dec 12, 2024

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

Name Status Preview Comments Updated (UTC)
nextui-docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 12, 2024 8:00am
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 12, 2024 8:00am

Copy link
Contributor

coderabbitai bot commented Dec 12, 2024

Walkthrough

The pull request updates the documentation for NextUI version 2.6.0, highlighting the addition of four new components: Form, Drawer, Input OTP, and Alert. It introduces support for React 19 and Next.js 15, alongside performance improvements and bug fixes. The release includes new hooks and updated method signatures across various components, enhancing functionality and usability. Additionally, breaking changes are noted, particularly concerning the Table component and Tailwind variants.

Changes

File Path Change Summary
apps/docs/content/blog/v2.6.0.mdx Updated to reflect NextUI version 2.6.0, detailing new components, features, bug fixes, and breaking changes.
src/components/form New component added: Form with built-in validation and submission handling.
src/components/drawer New component added: Drawer with sliding panel functionality.
src/components/input-otp New component added: Input OTP for one-time password entry.
src/components/alert New component added: Alert for displaying messages.
src/hooks/use-theme New hook added: use-theme for runtime theme management.
src/providers/NextUIProvider Method signature updated: NextUIProvider.navigate now includes routerOptions.
src/components/DatePicker Method signature updated: DatePicker.selectorButtonPlacement added.
src/components/Tabs Method signature updated: Tabs.tabRef added.
src/components/Popover Method signature updated: Popover.shouldCloseOnScroll added.
src/components/Table Method signature updated: Table.isKeyboardNavigationDisabled added; breaking changes noted.
src/components/Textarea Method signature updated: Textarea.isClearable added.
src/components/Select Method signature updated: Select.hideEmptyContent added.
src/components/Autocomplete Method signature updated: now supports virtualization.
src/components/Listbox Method signature updated: now supports virtualization.
src/components/Modal Method signature updated: now supports draggable functionality.

Possibly related PRs

  • docs: add forms guide #3822: This PR introduces a comprehensive guide on handling forms using NextUI components, which is directly related to the new Form component added in the main PR.
  • chore(docs): update component link #3737: The changes in this PR involve the Navbar component, which may relate to the overall documentation updates in the main PR that includes new components and enhancements.
  • chore(docs): v2.4.0 #3084: This PR updates the documentation for version 2.4.0, which may provide context or background relevant to the changes introduced in the main PR for version 2.6.0.

Suggested reviewers

  • wingkwong
  • jrgarciadev

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 747d523 and fb65234.

📒 Files selected for processing (1)
  • apps/docs/content/blog/v2.6.0.mdx (3 hunks)
🔇 Additional comments (3)
apps/docs/content/blog/v2.6.0.mdx (3)

90-90: LGTM: Form component documentation link is correctly referenced

The link to the Form component documentation is properly structured and matches the component being introduced.


316-316: LGTM: Form documentation deep-dive link is accurate

The link to the detailed Form documentation is appropriately placed after the component overview.


569-569: LGTM: Routing documentation link is well-placed

The link to the Routing documentation is correctly referenced in the context of router improvements.


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 generate docstrings to generate docstrings for this PR. (Experiment)
  • @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.

Copy link

vercel bot commented Dec 12, 2024

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

A member of the Team first needs to authorize it.

@wingkwong wingkwong added the 📋 Scope : Docs Related to the documentation label Dec 12, 2024
@OwLu0905 OwLu0905 force-pushed the docs/blog-link-typo branch from 747d523 to fb65234 Compare December 12, 2024 07:58
@jrgarciadev jrgarciadev merged commit 68d5b27 into heroui-inc:main Dec 12, 2024
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📋 Scope : Docs Related to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants