# react-native-confirmation-code-field [![react-native-confirmation-code-field on npm](https://badgen.net/npm/v/react-native-confirmation-code-field)](https://www.npmjs.com/package/react-native-confirmation-code-field) [![react-native-confirmation-code-field downloads](https://badgen.net/npm/dm/react-native-confirmation-code-field)](https://www.npmtrends.com/react-native-confirmation-code-field) [![react-native-confirmation-code-field install size](https://packagephobia.com/badge?p=react-native-confirmation-code-field)](https://packagephobia.com/result?p=react-native-confirmation-code-field) [![CI status](https://github.com/retyui/react-native-confirmation-code-field/actions/workflows/nodejs.yml/badge.svg)](https://github.com/retyui/react-native-confirmation-code-field/actions/workflows/nodejs.yml) A simple react-native confirmation code field compatible with iOS, Android. ### Links - [Documentation](API.md) - [Example app](examples/DemoCodeField) - [Live Expo app](https://snack.expo.io/Zil!jCFft) ### Component features: - 🔮 Simple and tiny `3.8 KB`. Easy to use; - 🚮 Clearing part of the code by clicking on the cell; - 🍎 Support "fast paste SMS-code" on iOS. And custom code paste for Android; - ⚡ TextInput `ref` support; - 🛠 Highly customizable. Can be used as masked TextInput; - 🤓 Readable [changelog](CHANGELOG.md). ## Screenshots | | | | --- | --- | | [![react-native-confirmation-code-field animated example](https://media.giphy.com/media/huJrqF0YRrNJBTwUmz/giphy.gif)](examples/DemoCodeField/src/AnimatedExample) | [![react-native-confirmation-code-field mask example](https://media.giphy.com/media/L4HHvT9Rwdlcdj59np/giphy.gif)](examples/DemoCodeField/src/MaskExample)
[![react-native-confirmation-code-field unmask example](https://media.giphy.com/media/jslJYqajRARsyANwdf/giphy.gif)](examples/DemoCodeField/src/UnmaskExample)
[![react-native-confirmation-code-field underline example](https://media.giphy.com/media/XEazF64IwELNV8wZge/giphy.gif)](examples/DemoCodeField/src/UnderlineExample)
[![react-native-confirmation-code-field formatting example](https://media.giphy.com/media/Y1TB1fSFtWHAdKSpZY/giphy.gif)](examples/DemoCodeField/src/FormattingExample) | ## Install ```sh yarn add react-native-confirmation-code-field ``` ## How it works I use an invisible `` component that will be stretched over `` components. JSX structure looks like that: ```jsx // Root view (rectangle with a red border on 3d visualization below) // Each Cell element is result of a `renderCell` function (gray boxes) 1 2 3 | // Invisible Text Input with absolute position (gray rectangle with text '123') ``` [![3d layout of component](https://media.giphy.com/media/oyYoYUwM3t9O7BuPDO/giphy.gif)](https://codepen.io/retyui/pen/WNGdNdJ) It needs to solve next problems: - When user pastes code from SMS on iOS [issue#25](https://github.com/retyui/react-native-confirmation-code-field/issues/25#issuecomment-446497934) - Better UX when user types fast, or system sluggish, characters might lost when component switching focus between ``. ## Basic example I took a minimal implementation approach. It mean that this component provides low-level functionality so you can create incredible UI without tears 😭. I recommend you start with creating your own wrapper where you apply all styles and basic configuration. You can use a ready-made solution out of the box: - [Animated variant](examples/DemoCodeField/src/AnimatedExample) - [Formatting example](examples/DemoCodeField/src/FormattingExample) - [Underline variant](examples/DemoCodeField/src/UnderlineExample) - [Show & Hide password](examples/DemoCodeField/src/UnmaskExample) - [Mask variant](examples/DemoCodeField/src/MaskExample) ```js import React, {useState} from 'react'; import {SafeAreaView, Text, StyleSheet} from 'react-native'; import { CodeField, Cursor, useBlurOnFulfill, useClearByFocusCell, } from 'react-native-confirmation-code-field'; const styles = StyleSheet.create({ root: {flex: 1, padding: 20}, title: {textAlign: 'center', fontSize: 30}, codeFieldRoot: {marginTop: 20}, cell: { width: 40, height: 40, lineHeight: 38, fontSize: 24, borderWidth: 2, borderColor: '#00000030', textAlign: 'center', }, focusCell: { borderColor: '#000', }, }); const CELL_COUNT = 6; const App = () => { const [value, setValue] = useState(''); const ref = useBlurOnFulfill({value, cellCount: CELL_COUNT}); const [props, getCellOnLayoutHandler] = useClearByFocusCell({ value, setValue, }); return ( Verification ( {symbol || (isFocused ? : null)} )} /> ); }; export default App; ``` ### Compatibility For `react-native@0.63.x` and below use `yarn add react-native-confirmation-code-field@6`, otherwise use the latest version `yarn add react-native-confirmation-code-field`

	Stars	Issues	Version	Updated	Created
react-native-confirmation-code-field	1,022	1	7.4.0	2 months ago	6 years ago
react-native-fbt	3,848	55	0.0.7	3 years ago	4 years ago
react-native-pin-code	53	3	0.5.3	6 years ago	7 years ago

react-native-confirmation-code-field vs react-native-fbt vs react-native-pin-code

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Sick of boring JavaScript newsletters?

Downloads in past