Skip to content

feat(input-otp): add new input-otp component #30386

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Open
wants to merge 74 commits into
base: feature-8.6
Choose a base branch
from

Conversation

brandyscarney
Copy link
Member

@brandyscarney brandyscarney commented Apr 30, 2025

Issue number: internal


What is the current behavior?

In order to re-create an OTP Input component users have to custom style an <ion-input>, possibly multiple, to get the design and functionality they want.

What is the new behavior?

  • Adds a new component ion-input-otp which provides the OTP input functionality
    • Displays as an input group with multiple boxes accepting a single character
    • Accepts type which determines whether the boxes accept numbers or text/numbers and determines the keyboard to display
    • Supports changing the displayed keyboard using the inputmode property
    • Accepts a length property to control the number of input boxes
    • Accepts the following properties to change the design: fill, shape, size, color
    • Accepts a separators property to show a separator between 1 or more input boxes
    • Supports the disabled, readonly and invalid states
    • Supports limiting the accepted input via the pattern property
    • Emits the following events: ionInput, ionChange, ionComplete, ionBlur, ionFocus
    • Exposes the following methods: reset, setFocus

Does this introduce a breaking change?

  • Yes
  • No

Other information

Dev build: 8.5.7-dev.11747772857.11c9c939

Previews

Documentation

Copy link

vercel bot commented Apr 30, 2025

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

Name Status Preview Comments Updated (UTC)
ionic-framework ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 27, 2025 7:21pm

@github-actions github-actions bot added package: core @ionic/core package package: angular @ionic/angular package package: vue @ionic/vue package package: react @ionic/react package labels Apr 30, 2025
@exorex
Copy link

exorex commented May 2, 2025

Thank you, @brandyscarney, for your work on this component.

One feature suggestion: pressing CTRL+A (or CMD+A on macOS) inside the component could select and clear all input fields at once. This would align with common input behavior and improve UX for users needing to re-enter their code quickly.

Example: https://input-otp.rodz.dev/

<div class="grid">
<div class="grid-item">
<h2>Default</h2>
<ion-input-otp> Didn't get a code? <a href="#">Resend the code</a> </ion-input-otp>
Copy link
Contributor

Choose a reason for hiding this comment

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

I found the following bug:

  1. I type "5" and "3" with the keyboard
  2. I highlight "5" with the mouse
  3. I press the BACKSPACE key on the keyboard
  4. Now the OTP has "3" and "3"

I would expect to only see the "3" in the first input.

Screen.Recording.2025-05-21.at.11.09.17.AM.mov

Copy link
Member Author

Choose a reason for hiding this comment

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

Can you tell me what browser you used or how you reproduced this? I am not able to reproduce in Chrome or Firefox:

input-otp-bug.mp4

Copy link
Contributor

Choose a reason for hiding this comment

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

Weird, I can't replicate it anymore. 🤔 It was Firefox, maybe there was a patch on the browser.

<h2>Default</h2>
<ion-input-otp> Didn't get a code? <a href="#">Resend the code</a> </ion-input-otp>
<ion-input-otp length="2"> Didn't get a code? <a href="#">Resend the code</a> </ion-input-otp>
<ion-input-otp id="numberValue" length="6">
Copy link
Contributor

Choose a reason for hiding this comment

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

When I highlight the "3" and type "6", the "3" is replaced with "6". This makes sense.

But when I highlight "6" and paste my "123" value, the "123" value is placed after the "6". I would expect the "6" to be replaced with "123" -> "12123"

Screen.Recording.2025-05-21.at.11.26.17.AM.mov

What is the correct expectation?

Copy link
Member Author

Choose a reason for hiding this comment

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

I took a look at what some of the other libraries do, and it seems that I am not handling this the right way. Other libraries always paste from the 1st input, no matter how many input boxes have text in them. I have updated this behavior & the tests and will update it in the documentation. Let me know if you disagree with this approach or if you'd like me to send you some examples from the other libraries!

The fix: 8c29200

Copy link
Contributor

Choose a reason for hiding this comment

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

No complaints from me since it follows how other libraries do it! Thank you!

Copy link
Contributor

@thetaPC thetaPC left a comment

Choose a reason for hiding this comment

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

No issues found with core and Angular. I'm waiting on React and Vue to be ready for review.

Copy link
Contributor

Choose a reason for hiding this comment

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

It might be best to make these changes in a separate PR.

Copy link
Contributor

Choose a reason for hiding this comment

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

It might be best to make these changes in a separate PR.

Copy link
Contributor

Choose a reason for hiding this comment

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

Why are these changes needed?

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
package: angular @ionic/angular package package: core @ionic/core package package: react @ionic/react package package: vue @ionic/vue package
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants