feat: add fn win alt keys

[winchesHe]

Closes #4499

📝 Description

⛳️ Current behavior (updates)

🚀 New behavior

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

📝 Additional Information

Summary by CodeRabbit

• New Features

  • Enhanced Keyboard Key (Kbd) component with support for additional keys:
    • Added "fn" (Function) key
    • Added "win" (Windows) key
    • Expanded "alt" key functionality

• Documentation

  • Updated API documentation to reflect new key type definitions

[linear]

ENG-1828 [Feature Request] Add `Fn` `Win` `Alt` Key to `<Kbd>`

[changeset-bot]

🦋 Changeset detected

Latest commit: 98f63ed

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

This PR includes changesets to release 2 packages

Name	Type
@heroui/kbd	Patch
@heroui/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)
heroui	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 30, 2025 9:17am
heroui-sb	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 30, 2025 9:17am

[coderabbitai]

Walkthrough

The pull request introduces support for additional keyboard keys (Fn, Win, and Alt) in the Keyboard (Kbd) component across multiple files. This enhancement expands the existing keyboard key functionality by updating type definitions, key mappings, and Storybook configuration to include the new key types. The changes are consistent across documentation, component utilities, and component stories.

Changes

File	Change Summary
.changeset/stale-tips-kneel.md	Added patch for @heroui/kbd dependency
apps/docs/content/docs/components/kbd.mdx	Updated KbdKey type to include "fn", "win", and "alt" keys
packages/components/kbd/src/utils.ts	Extended KbdKey type and updated kbdKeysMap and kbdKeysLabelMap with new key mappings
packages/components/kbd/stories/kbd.stories.tsx	Added "fn", "win", and "alt" options to keys in Storybook configuration

Assessment against linked issues

Objective	Addressed	Explanation
Add Fn, Win, and Alt keys to <Kbd> [#4499]	✅

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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/components/kbd/src/utils.ts (1)

45-47: Consider using a more appropriate symbol for the Windows key.

Currently, the Windows key uses "⌘" which is typically associated with the Command key on Mac. This could be confusing for users. Consider using a more platform-agnostic symbol like "⊞" for the Windows key.

-  win: "⌘",
+  win: "⊞",

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between cddba82 and 98f63ed.

📒 Files selected for processing (4)

• .changeset/stale-tips-kneel.md (1 hunks)
• apps/docs/content/docs/components/kbd.mdx (1 hunks)
• packages/components/kbd/src/utils.ts (3 hunks)
• packages/components/kbd/stories/kbd.stories.tsx (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (2)

• GitHub Check: TypeScript
• GitHub Check: Build

🔇 Additional comments (4)

packages/components/kbd/stories/kbd.stories.tsx (1)

34-36: LGTM! New key options added consistently.

The addition of "fn", "win", and "alt" options aligns with the type definitions and maintains consistency across the component.

packages/components/kbd/src/utils.ts (1)

70-72: LGTM! Clear and consistent key labels.

The label mappings use standard keyboard terminology that will be familiar to users.

.changeset/stale-tips-kneel.md (1)

1-5: LGTM! Appropriate version bump and clear reference to issue.

The patch version bump is appropriate for this feature addition, and the changeset correctly references the related issue.

apps/docs/content/docs/components/kbd.mdx (1)

115-118: LGTM! Documentation updated consistently.

The KbdKey type definition in the documentation has been updated to match the implementation, maintaining consistency across the codebase.