smh-rn-otp-textinput

smh-rn-otp-textinput

Installation

1# Expo
2npx expo install smh-rn-otp-textinput
3
4#React Native
5npm install --save smh-rn-otp-textinput

Props

The Following Props are applicable for the component along with props supported by react native TextInput component

Prop	Type	Optional	Default	Description
defaultValue	string	Yes	''	Default Value that can be set based on OTP / Pin received from parent container.
handleTextChange	func	No	n/a	callback with concated string of all cells as argument.
handleCellTextChange	func	Yes	n/a	callback for text change in individual cell with cell text and cell index as arguments
inputCount	number	Yes	4	Number of Text Input Cells to be present.
tintColor	string	Yes	#3CB371	Color for Cell Border on being focused.
offTintColor	string	Yes	#DCDCDC	Color for Cell Border Border not focused.
inputCellLength	number	Yes	1	Number of character that can be entered inside a single cell.
containerStyle	object	Yes	{}	style for overall container.
textInputStyle	object	Yes	{}	style for text input.
testIDPrefix	string	Yes	'otpinput'	testID prefix, the result will be otp_input_0 until inputCount
autoFocus	bool	Yes	false	Input should automatically get focus when the components loads

Helper Functions

Clearing and Setting values to component

1// using traditional ref
2clearText = () => {
3    this.otpInput.clear();
4}
5
6setText = () => {
7    this.otpInput.setValue("1234");
8}
9
10render() {
11    return (
12        <View>
13            <OTPTextInput ref={e => (this.otpInput = e)} >
14            <Button title="clear" onClick={this.clearText}>
15        </View>
16    );
17}
18
19

1// hooks
2import React, { useRef } from 'react';
3
4const ParentComponent = () => {
5    let otpInput = useRef(null);
6
7    const clearText = () => {
8        otpInput.current.clear();
9    }
10
11    const setText = () => {
12        otpInput.current.setValue("1234");
13    }
14
15    return (
16        <View>
17            <OTPTextView ref={e => (otpInput = e)} >
18            <Button title="clear" onClick={clearText}>
19        </View>
20    );
21}
22

Example

1
2import React, { useRef, useState } from 'react'
3import { OtpTextInput, StyleSheet } from '@/imports';
4import { useTheme } from '@/hooks';
5import { heightPercent, widthPercent } from '@/helpers/functions/responsive';
6import { debugLog } from '@/config/logsConfig';
7import {OTPTextView, OTPTextViewType} from 'smh-rn-otp-textinput';
8
9const OtpInput = () => {
10
11  const theme = useTheme();
12  const { colors, fontSizes, iconSizes } = theme
13
14  const styles = StyleSheet.create({
15    textInputContainer: {
16      marginVertical: 15,
17      justifyContent:'center',
18      padding:widthPercent(0.3)
19    },
20    roundedTextInput: {
21      borderRadius: 10,
22      borderWidth: 1,
23      width:widthPercent(6),
24      height:heightPercent(6),
25      margin:widthPercent(0.2)
26    },
27  })
28
29  const [otpInput, setOtpInput] = useState<string>("");
30  const input = useRef<OTPTextViewType>(null);
31  const handleCellTextChange = async (text: string, i: number) => {
32    debugLog('handleCellTextChange')
33  };
34  return (
35    <OTPTextView
36      handleCellTextChange={handleCellTextChange}
37      handleTextChange={setOtpInput}
38      inputCount={6}
39      keyboardType="numeric"
40      containerStyle={styles.textInputContainer}
41      textInputStyle={styles.roundedTextInput}
42      tintColor={colors.text}
43    />
44  );
45
46}
47
48export default OtpInput
49

And we're done 🎉

Contributing

Contribution are always welcome, no matter how large or small !

We want this community to be friendly and respectful to each other.Please follow it in all your interactions with the project.

Please feel free to drop me a mail S MUNI HARISH

Acknowledgements

Thanks to the authors of these libraries for inspiration

Note

Inspired by react-native-otp-textinput

Sponsor & Support

To keep this library maintained and up-to-date please consider sponsoring it on GitHub. Or if you are looking for a private support or help in customizing the experience, then reach out to me on Linkedin @smuniharish.

License

MIT

---

Made with ❤️