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: virtual keyboard on mobile should be based on the allowed keys #4411

Conversation

macci001
Copy link
Contributor

@macci001 macci001 commented Dec 19, 2024

Closes #4408

📝 Description

Fixing the virtual keyboard based on the allowedKeys.

⛳️ Current behavior (updates)

VIDEO-2024-12-20-00-34-18.mp4

🚀 New behavior

VIDEO-2024-12-20-00-32-50.mp4

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

Summary by CodeRabbit

  • New Features

    • Enhanced virtual keyboard functionality for the OTP input, displaying only allowed keys.
    • Improved input handling for numeric patterns in the OTP input component.
    • New regex utility function added for pattern validation.
  • Bug Fixes

    • Addressed issues with input validation and control for the virtual keyboard.
  • Documentation

    • Updated exports to include a new regex utility for enhanced functionality.

Copy link

changeset-bot bot commented Dec 19, 2024

🦋 Changeset detected

Latest commit: 3862259

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

This PR includes changesets to release 57 packages
Name Type
@nextui-org/input-otp Patch
@nextui-org/shared-utils Patch
@nextui-org/react Patch
@nextui-org/accordion Patch
@nextui-org/alert Patch
@nextui-org/autocomplete Patch
@nextui-org/avatar Patch
@nextui-org/badge Patch
@nextui-org/breadcrumbs Patch
@nextui-org/button Patch
@nextui-org/calendar Patch
@nextui-org/card Patch
@nextui-org/checkbox Patch
@nextui-org/chip Patch
@nextui-org/code Patch
@nextui-org/date-input Patch
@nextui-org/date-picker Patch
@nextui-org/divider Patch
@nextui-org/drawer Patch
@nextui-org/dropdown Patch
@nextui-org/form Patch
@nextui-org/image Patch
@nextui-org/input Patch
@nextui-org/kbd Patch
@nextui-org/link Patch
@nextui-org/listbox Patch
@nextui-org/menu Patch
@nextui-org/modal Patch
@nextui-org/navbar Patch
@nextui-org/pagination Patch
@nextui-org/popover Patch
@nextui-org/progress Patch
@nextui-org/radio Patch
@nextui-org/ripple Patch
@nextui-org/scroll-shadow Patch
@nextui-org/select Patch
@nextui-org/skeleton Patch
@nextui-org/slider Patch
@nextui-org/snippet Patch
@nextui-org/spacer Patch
@nextui-org/spinner Patch
@nextui-org/switch Patch
@nextui-org/table Patch
@nextui-org/tabs Patch
@nextui-org/tooltip Patch
@nextui-org/user Patch
@nextui-org/theme Patch
@nextui-org/use-aria-button Patch
@nextui-org/use-aria-link Patch
@nextui-org/use-data-scroll-overflow Patch
@nextui-org/use-infinite-scroll Patch
@nextui-org/use-pagination Patch
@nextui-org/aria-utils Patch
@nextui-org/framer-utils Patch
@nextui-org/react-utils Patch
@nextui-org/system Patch
@nextui-org/use-real-shape 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

Copy link

vercel bot commented Dec 19, 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 22, 2024 2:40pm
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 22, 2024 2:40pm

Copy link
Contributor

coderabbitai bot commented Dec 19, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request introduces a patch for the @nextui-org/input-otp and @nextui-org/shared-utils packages, addressing an issue with the virtual keyboard functionality on mobile devices. It implements a new utility function, isPatternNumeric, which helps determine the appropriate input mode for the OTP input component based on the specified allowedKeys. The changes enhance input validation by restricting keyboard input to allowed characters, ensuring a better user experience.

Changes

File Change Summary
packages/components/input-otp/src/use-input-otp.ts Updated getInputOtpProps to conditionally set inputMode based on isPatternNumeric.
packages/utilities/shared-utils/src/index.ts Added export for the new regex module.
packages/utilities/shared-utils/src/regex.ts Introduced isPatternNumeric function to validate numeric patterns.

Assessment against linked issues

Objective Addressed Explanation
Mobile keyboard input for mixed alphanumeric input [#4408]
Allow typing numbers and letters on mobile

Possibly related PRs

Suggested reviewers

  • wingkwong

📜 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 6ae4db7 and 3862259.

📒 Files selected for processing (2)
  • .changeset/cyan-donkeys-swim.md (1 hunks)
  • packages/components/input-otp/src/use-input-otp.ts (3 hunks)

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

Comment on lines 226 to 231
const isNumeric = (pattern: string) => {
const numericPattern = /(^|\W)[0-9](\W|$)/;

return numericPattern.test(pattern) && !/[^\d\^$\[\]\(\)\*\+\-\.\|]/.test(pattern);
};

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@macci001, please move this to the shared-utils package, Also, ensure that the pattern string is validated to confirm it exists (i.e., it should not be null).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved the check function to shared-utils.
Also, I think allowedKeys would not be null as we are setting the default value in L110

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5494fa2 and 6ae4db7.

📒 Files selected for processing (4)
  • .changeset/cyan-donkeys-swim.md (1 hunks)
  • packages/components/input-otp/src/use-input-otp.ts (2 hunks)
  • packages/utilities/shared-utils/src/index.ts (1 hunks)
  • packages/utilities/shared-utils/src/regex.ts (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • packages/utilities/shared-utils/src/index.ts
🔇 Additional comments (3)
.changeset/cyan-donkeys-swim.md (1)

1-5: LGTM! Appropriate version bump and clear description.

The patch version bump is correct for this bug fix, and the description clearly links to the issue being fixed.

packages/components/input-otp/src/use-input-otp.ts (2)

16-16: LGTM! Clean import of the new utility.

The isPatternNumeric utility is correctly imported from shared-utils.


249-249: Verify the virtual keyboard behavior on different mobile browsers.

The implementation looks correct, but it's important to verify the behavior across different mobile browsers as they might handle inputMode differently.

Let's check if there are any browser-specific workarounds in the codebase:

packages/utilities/shared-utils/src/regex.ts Show resolved Hide resolved
packages/components/input-otp/src/use-input-otp.ts Outdated Show resolved Hide resolved
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.

[BUG] - InputOtp keyboard on mobile
4 participants