https://github.com/web-ridge/react-native-use-form
Simple form library for React Native with great UX for developer and end-user
https://github.com/web-ridge/react-native-use-form
Last synced: 2 months ago
JSON representation
Simple form library for React Native with great UX for developer and end-user
- Host: GitHub
- URL: https://github.com/web-ridge/react-native-use-form
- Owner: web-ridge
- License: mit
- Created: 2020-12-29T21:37:23.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-17T09:29:50.000Z (5 months ago)
- Last Synced: 2025-03-29T07:04:26.470Z (3 months ago)
- Language: TypeScript
- Homepage: https://www.reactnativeuseform.com
- Size: 2.58 MB
- Stars: 93
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
react-native-use-form
Simple form library for React Native with great UX for developer and end-user api and some code inspired by [wsmd/react-native-use-form](https://github.com/wsmd/react-native-use-form)
- Autoscroll to next fields with keyboard (iOS/Android)
- Validation
- Autoscroll to errors in form if submit validation fails
- Automatically adds a lot of props e.g. when you use the telephone('telNumber') it will open up the right keyboard + autocomplete
- Email, username, password, number, numberText, decimal, decimalText,
- Great typescript support!
- Nested object with dot notation
- Locale decimal support
- Great decimal support with support for , notation and automatically convert it to a Number object (based on locale)
See an (older) demo: https://twitter.com/RichardLindhout/status/1344009881863516165
## Installation
```sh
yarn add react-native-use-form
```
or
```sh
npm install react-native-use-form
```
## Import some localized strings
Ideally you do this somewhere in your `index.js` before `react-native-use-form` is used.
Currently we have en/nl/de/pl/pt/ar/ko/frf translations but it's really easy to add one extra since it are only some labels and error messages.
```tsx
// e.g in your index.js
import {
en,
registerTranslation,
registerDefaultLocale
} from 'react-native-use-form'
registerTranslation('en', en)
// you can override the locale per form
registerDefaultLocale('en') // optional (default = en)
// registerTranslation('nl', nl)
```
### or register your own
Please send a PR with your language to make sure all locales are there next time
```tsx
import {
registerTranslation,
} from 'react-native-use-form'
registerTranslation("en", {
required: (params) => `${params.label || params.fieldKey} is required`,
lengtShouldBeLongerThan: (params) =>
`${params.label || params.fieldKey} length should be longer than ${
params.requiredLength
}`,
lengthShouldBeShorterThan: (params) =>
`${params.label || params.fieldKey} length should be shorter than ${
params.requiredLength
}`,
shouldFollowRegex: (params) =>
params.errorMessage ||
`${params.label || params.fieldKey} is not in the right format`,
})
```
## Advanced example
Also see /demo folder in this repository to see advanced usage!
```tsx
import * as React from 'react';
import { View, ScrollView } from 'react-native';
import { useFormState, Form } from 'react-native-use-form';
import { Button, HelperText, TextInput } from 'react-native-paper';
export default function App() {
const scrollViewRef = useRef(null);
const [
{ errors, submit, formProps, hasError },
{ email, telephone, password },
] = useFormState(
{
email: '',
telephone: '',
password: '',
},
{
scrollViewRef, // optional if you want to scroll to error on submit (long forms)
locale: 'en', // optional override
onChange: (latestValues) => {
// optional: do something with latestValues
},
onSubmit: (submittedValues) => {
// do something with submittedValues
},
}
);
return (
{
return looksLikeMail(v) ? true : 'Email-address is invalid';
},
label: "E-mail"
})}
/>
Save
);
}
function TextInputWithError({ errorMessage, ...rest }: React.ComponentProps & { errorMessage?: string }) {
return (
<>
{errorMessage || ' '}
>
);
}
const telephoneRegex = {
regex: new RegExp(/^\d+$/),
errorMessage: 'Telephone is invalid',
};
// you can add your own validate functions
function looksLikeMail(str: string): boolean {
let lastAtPos = str.lastIndexOf('@');
let lastDotPos = str.lastIndexOf('.');
return (
lastAtPos < lastDotPos &&
lastAtPos > 0 &&
str.indexOf('@@') === -1 &&
lastDotPos > 2 &&
str.length - lastDotPos > 2
);
}
```
## Contributing
See the [contributing guide](../CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
## License
MIT
### Checkout our other libraries
- Simple cross platform navigation library for React Native: [react-native-ridge-navigation](https://github.com/web-ridge/react-native-ridge-navigation)
- Smooth and fast cross platform Material Design date and time picker for React Native Paper: [react-native-paper-dates](https://github.com/web-ridge/react-native-paper-dates)
- Smooth and fast cross platform Material Design Tabs for React Native Paper: [react-native-paper-tabs](https://github.com/web-ridge/react-native-paper-tabs)
- Simple translations in React (Native): [react-ridge-translations](https://github.com/web-ridge/react-ridge-translations)