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.

Sign up for GitHub

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

follow up on PR #448 #452

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

follow up on PR #448 #452

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d3aa273
fix: Values always added from first input even when another input is …
ahmed-s-fatahallah May 12, 2024
67e6195
fix: Assign the pasted value from the clipboard auto paste to the otp…
ahmed-s-fatahallah Jul 11, 2024
12b4acf
feat: Handle when the pasted value is longer or shorter than the inpu…
ahmed-s-fatahallah Jul 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 27 additions & 20 deletions src/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,8 @@ const OTPInput = ({
const [activeInput, setActiveInput] = React.useState(0);
const inputRefs = React.useRef<Array<HTMLInputElement | null>>([]);

const getOTPValue = () => (value ? value.toString().split('') : []);
// Save Otp value in a ref to persist it between rerenders to update the value in the current focused input
const otpValueRef = React.useRef(value ? value.toString().split('') : Array(numInputs));

const isInputNum = inputType === 'number' || inputType === 'tel';

Expand All @@ -84,6 +85,11 @@ const OTPInput = ({
}
}, [shouldAutoFocus]);

// On each Rerender check if the value is an empty string we reset the otpValueRef value
if (value.trim() === '') {
otpValueRef.current = Array(numInputs);
}
Comment on lines +89 to +91
Copy link

Choose a reason for hiding this comment

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

Resetting otpValueRef.current to an empty array on every render when value is an empty string can cause unnecessary re-renders and may not be efficient. Consider using a useEffect hook to handle this condition.


const getPlaceholderValue = () => {
if (typeof placeholder === 'string') {
if (placeholder.length === numInputs) {
Expand Down Expand Up @@ -114,16 +120,18 @@ const OTPInput = ({
const handleInputChange = (event: React.ChangeEvent<HTMLInputElement>) => {
const { nativeEvent } = event;
const value = event.target.value;

if (!isInputValueValid(value)) {
// Pasting from the native autofill suggestion on a mobile device can pass
// the pasted string as one long input to one of the cells. This ensures
// that we handle the full input and not just the first character.
if (value.length === numInputs) {
const hasInvalidInput = value.split('').some((cellInput) => !isInputValueValid(cellInput));

if (value.length > 1) {
const valueArr = value.split('', numInputs);
const hasInvalidInput = valueArr.some((cellInput) => !isInputValueValid(cellInput));
if (!hasInvalidInput) {
handleOTPChange(value.split(''));
focusInput(numInputs - 1);
handleOTPChange(valueArr);
focusInput(value.length - 1);
ahmed-s-fatahallah marked this conversation as resolved.
Show resolved Hide resolved
otpValueRef.current = valueArr;
}
}

Expand Down Expand Up @@ -152,7 +160,8 @@ const OTPInput = ({
};

const handleKeyDown = (event: React.KeyboardEvent<HTMLInputElement>) => {
const otp = getOTPValue();
const currentOtpValue = otpValueRef.current;

if ([event.code, event.key].includes('Backspace')) {
event.preventDefault();
changeCodeAtFocus('');
Expand All @@ -169,7 +178,7 @@ const OTPInput = ({
}
// React does not trigger onChange when the same value is entered
// again. So we need to focus the next input manually in this case.
else if (event.key === otp[activeInput]) {
else if (event.key === currentOtpValue[activeInput]) {
event.preventDefault();
focusInput(activeInput + 1);
} else if (
Expand All @@ -193,9 +202,10 @@ const OTPInput = ({
};

const changeCodeAtFocus = (value: string) => {
const otp = getOTPValue();
otp[activeInput] = value[0];
handleOTPChange(otp);
const currentOtpValue = otpValueRef.current;
currentOtpValue[activeInput] = value[0];

handleOTPChange(currentOtpValue);
};

const handleOTPChange = (otp: Array<string>) => {
Expand All @@ -206,14 +216,11 @@ const OTPInput = ({
const handlePaste = (event: React.ClipboardEvent<HTMLInputElement>) => {
event.preventDefault();

const otp = getOTPValue();
const currentOtpValue = otpValueRef.current;
let nextActiveInput = activeInput;

// Get pastedData in an array of max size (num of inputs - current position)
const pastedData = event.clipboardData
.getData('text/plain')
.slice(0, numInputs - activeInput)
.split('');
const pastedData = event.clipboardData.getData('text/plain').slice(0, numInputs).split('');
Copy link

Choose a reason for hiding this comment

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

pastedData.slice(0, numInputs) should be pastedData.slice(0, numInputs - activeInput) to ensure the pasted data fits within the remaining input fields.


// Prevent pasting if the clipboard data contains non-numeric values for number inputs
if (isInputNum && pastedData.some((value) => isNaN(Number(value)))) {
Expand All @@ -222,14 +229,14 @@ const OTPInput = ({

// Paste data from focused input onwards
for (let pos = 0; pos < numInputs; ++pos) {
if (pos >= activeInput && pastedData.length > 0) {
otp[pos] = pastedData.shift() ?? '';
if (pastedData.length > 0) {
currentOtpValue[pos] = pastedData.shift() ?? '';
Copy link

Choose a reason for hiding this comment

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

The loop should start from activeInput instead of 0 to ensure the pasted data starts from the currently focused input.

nextActiveInput++;
}
}

focusInput(nextActiveInput);
handleOTPChange(otp);
handleOTPChange(currentOtpValue);
};

return (
Expand All @@ -242,7 +249,7 @@ const OTPInput = ({
<React.Fragment key={index}>
{renderInput(
{
value: getOTPValue()[index] ?? '',
value: otpValueRef.current[index] ?? '',
placeholder: getPlaceholderValue()?.[index] ?? undefined,
ref: (element) => (inputRefs.current[index] = element),
onChange: handleChange,
Expand Down