feat: phone number input validation on input and paste events #2906
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 0d67b62 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
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 |
Contributor
|
✅ PR title follows Conventional Commits specification. |
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit ff2f0dc:
|
Collaborator
🛡️ Coverage ReportSummaryFull Coverage Details |
jaywalker21
requested review from
anuraghazra,
chaitanyadeorukhkar,
kamleshchandnani,
ravikumar-rajagopalan,
saurabhdaware,
swapnil-kr1 and
tewarig
as code owners
Comment on lines
+30
to
+42
| const { key, ctrlKey, metaKey } = event; | ||
|
|
||
| // Check if the entered key is a number; if not, prevent the default action | ||
| const isCharacterKey = key.length === 1; | ||
|
|
||
| // return for non-character keys | ||
| if (ctrlKey || metaKey || !isCharacterKey) { | ||
| return; | ||
| } | ||
|
|
||
| if (!isNumericInput(key)) { | ||
| event.preventDefault(); | ||
| } |
Member
There was a problem hiding this comment.
Suggested change
| const { key, ctrlKey, metaKey } = event; | |
| // Check if the entered key is a number; if not, prevent the default action | |
| const isCharacterKey = key.length === 1; | |
| // return for non-character keys | |
| if (ctrlKey || metaKey || !isCharacterKey) { | |
| return; | |
| } | |
| if (!isNumericInput(key)) { | |
| event.preventDefault(); | |
| } | |
| const { key, ctrlKey, metaKey } = event; | |
| // return for non-character keys | |
| if (ctrlKey || metaKey || !isNumericInput(key)) { | |
| return; | |
| } | |
| event.preventDefault(); |
Will this do the same thing? isCharacterKey check seems a little hacky
Contributor
Author
There was a problem hiding this comment.
I think this should work, will validate once before accepting suggestion.
Contributor
Author
There was a problem hiding this comment.
I missed one aspect in your comment. In case of non-numeric input, we need to prevent default handlers for event, so condition will simply be to return in case of ctrlKey and metaKey.
In case of non-numeric input, we will do event.preventDefault()
| const handlePaste = (pasteEvent: FormInputOnPasteEvent): void => { | ||
| const pastedText = pasteEvent.value?.clipboardData?.getData('text') ?? ''; | ||
|
|
||
| // Only allow pastedText if it only has numeric characters |
Member
There was a problem hiding this comment.
I am not sure if we should stop people from pasting numbers like +91 9999 999999. If you copy from whatsapp or a lot of other websites, it often comes with spaces, -, or +. We can let people paste things as is or we can replace the unsupported characters before pasting and paste the numbers, spaces, hyphens, and plus, etc.
Member
There was a problem hiding this comment.
You can check the <input type="number" /> behaviour actually. We can replicate that.
Contributor
Author
There was a problem hiding this comment.
I was thinking about this, the only problem is to understand the amount of characters to skip.
For example, for India, it would be ideal to skip +91 and update only the part after that. Was planning to handle it for current dial code maintained in the state and for any other country code to skip the + sign and paste the remaining part.
Member
There was a problem hiding this comment.
Yeah skipping plus and space also fine. Overall its fine if wrongly formatted number is pasted. People can remove the 91 manually. We should just avoid blocking the paste
Contributor
Author
There was a problem hiding this comment.
Checked what <input type="number" /> does. It strips the string from all non-numeric inputs, adding the same logic here.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds validation to disallow non-numeric inputs in
PhoneNumberInputcomponent.It also ensures that the same is handled when any text is pasted into the input.
Changes
onPasteevent support forBaseInputcomponent for web viahandleOnPastehandleronKeyDownevent and ensures that onlynumericcharacters are allowedonPasteevent and ensures that text only containsnumbersAdditional Information
diallingCodeandnumber. This is not covered within the scope of this PRComponent Checklist
DevRev Ticket Link