fix(use-aria-link): onclick deprecation warning for Button as Link

[wingkwong]

Closes #4493

📝 Description

Users receive [Next UI] [useLink]: onClick is deprecated, please use onPress instead. when using <Button as={Link} href="/">. The onClick was introduced from usePress internally. This onClick would pass to Link and trigger that warning. This PR is to handle this case by checking the role. If using as a polymorphic component, the role will be button.

⛳️ Current behavior (updates)

Got [Next UI] [useLink]: onClick is deprecated, please use onPress instead. while not defining any onClick.

🚀 New behavior

No such warning when using <Button as={Link} href="/">

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

📝 Additional Information

Summary by CodeRabbit

• Bug Fixes

  • Resolved deprecation warning for the Button component when used as a Link
  • Improved handling of onClick event for different element roles

• New Features

  • Added optional role property to customize element behavior
  • Enhanced flexibility for link and button interactions

[linear]

ENG-1825 [BUG] - Button as Link Produces onClick Deprecation Warning

[changeset-bot]

🦋 Changeset detected

Latest commit: a80d563

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages

Name	Type
@nextui-org/use-aria-link	Patch
@nextui-org/link	Patch
@nextui-org/react	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[vercel]

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	Jan 5, 2025 8:45am
nextui-storybook-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 5, 2025 8:45am

[coderabbitai]

Walkthrough

The pull request addresses a deprecation warning for the @nextui-org/use-aria-link package when using a Button component as a Link. The changes introduce an optional role property to the AriaLinkOptions interface and modify the warning logic to only trigger for non-button roles. This ensures that the Button component can be used as a Link without unnecessary warnings, specifically when only an href is provided.

Changes

File	Change Summary
.changeset/sixty-fireants-build.md	Patch for @nextui-org/use-aria-link package
packages/hooks/use-aria-link/src/index.ts	- Added optional role property to AriaLinkOptions interface - Updated useAriaLink function to handle new role property - Modified warning logic for deprecated onClick

Assessment against linked issues

Objective	Addressed	Explanation
Fix deprecation warning for Button as Link [#4493]	✅
Prevent warning when only href is provided	✅

Possibly related PRs

• fix(use-aria-menu): link logic in useMenuItem #3229: Modifications to link logic in useMenuItem hook
• refactor: button & card ripple #4284: Refactoring Button component to use onPress event
• refactor: use onPress event instead (component-wise) #4354: Component-wise refactor for onPress event handling
• fix(alert): mark description optional & revise styles when only children is provided #4447: Optional property changes in Alert component

Suggested reviewers

• jrgarciadev

---

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

🧹 Nitpick comments (1)

packages/hooks/use-aria-link/src/index.ts (1)

22-23: Ensure the role property has a well-defined domain of valid values
While adding an optional role property is reasonable, consider using a restricted set of valid roles (e.g., "link", "button") or providing guidance in the docs about its usage to ensure clarity and correctness.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a43b156 and a80d563.

📒 Files selected for processing (2)

• .changeset/sixty-fireants-build.md (1 hunks)
• packages/hooks/use-aria-link/src/index.ts (3 hunks)

🔇 Additional comments (3)

packages/hooks/use-aria-link/src/index.ts (2)

51-51: Validate role in the calling context
Before destructuring the role prop, you might want to ensure that if role is provided, it matches an expected set of roles. This could help prevent accidental usage of unsupported roles.

---

67-67: Well-handled condition for deprecation warning
Restricting the warning to non-button roles is a sound approach. This logic effectively prevents unnecessary warnings for button-like usage. Great job.

.changeset/sixty-fireants-build.md (1)

1-5: Accurate changeset description
The changeset succinctly explains the fix for the button-as-link deprecation warning. This documentation will help developers understand why the patch was introduced.