Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/final-form/react-final-form-hooks
React Hooks to bind to 🏁 Final Form's high performance subscription-based form state management engine
https://github.com/final-form/react-final-form-hooks
Last synced: 3 months ago
JSON representation
React Hooks to bind to 🏁 Final Form's high performance subscription-based form state management engine
- Host: GitHub
- URL: https://github.com/final-form/react-final-form-hooks
- Owner: final-form
- License: mit
- Created: 2018-11-04T11:33:31.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T15:18:42.000Z (almost 2 years ago)
- Last Synced: 2024-05-16T20:24:52.397Z (6 months ago)
- Language: JavaScript
- Size: 2.22 MB
- Stars: 471
- Watchers: 6
- Forks: 19
- Open Issues: 36
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 🏁 React Final Form Hooks
[](#backers) [](#sponsors) [](https://www.npmjs.com/package/react-final-form-hooks)
[](https://www.npmjs.com/package/react-final-form-hooks)
[](https://travis-ci.org/final-form/react-final-form-hooks)
[](https://codecov.io/gh/final-form/react-final-form-hooks)
[](https://github.com/prettier/prettier)
✅ Zero dependencies
✅ Only peer dependencies: React and
[🏁 Final Form](https://github.com/final-form/final-form#-final-form)
✅ Opt-in subscriptions - only update on the state you need!
✅ 💥 [**1.2 kB gzipped**](https://bundlephobia.com/result?p=react-final-form-hooks) 💥
---
## Installation
```bash
npm install --save react-final-form-hooks final-form
```
or
```bash
yarn add react-final-form-hooks final-form
```
## Getting Started
🏁 React Final Form Hooks is the leanest possible way to connect 🏁 Final Form to React, to acheive subscriptions-based form state management using the [Observer pattern](https://en.wikipedia.org/wiki/Observer_pattern).
#### ⚠️ This library will re-render your entire form on every state change, _as you type_. ⚠️
If performance is your goal, you are recommended to use [🏁 React Final Form](https://github.com/final-form/react-final-form). Also, that library does many other things for you, like managing checkbox and radio buttons properly. RFFHooks leaves all of that work to you. By default, 🏁 React Final Form Hooks subscribes to _all_ changes, but if you want to fine tune your form, you may specify only the form state that you care about for rendering your gorgeous UI.
Here's what it looks like in your code:
```jsx
import { useForm, useField } from 'react-final-form-hooks'
const MyForm = () => {
const { form, handleSubmit, values, pristine, submitting } = useForm({
onSubmit, // the function to call with your form values upon valid submit
validate // a record-level validation function to check all form values
})
const firstName = useField('firstName', form)
const lastName = useField('lastName', form)
return (
First Name
{firstName.meta.touched && firstName.meta.error && (
{firstName.meta.error}
)}
Last Name
{lastName.meta.touched && lastName.meta.error && (
{lastName.meta.error}
)}
Submit
)
}
```
## Table of Contents
- [What's the difference between `react-final-form-hooks` and the hooks introduced in `react-final-form v5`?](#whats-the-difference-between-react-final-form-hooks-and-the-hooks-introduced-in-react-final-form-v5)
- [Examples](#examples)
- [Simple Example](#simple-example)
- [API](#api)
- [`useField`](#usefield)
- [`name : string`](#name--string)
- [`form : Form`](#form--form)
- [`validate? : (value:any) => any`](#validate--valueany--any)
- [`subscription? : FieldSubscription`](#subscription--fieldsubscription)
- [`useForm`](#useform)
- [`onSubmit : (values:Object) => ?Object | Promise | void`](#onsubmit--valuesobject--object--promiseobject--void)
- [`validate?: (values:Object) => Object | Promise`](#validate-valuesobject--object--promiseobject)
- [Contributors](#contributors)
- [Backers](#backers)
- [Sponsors](#sponsors)
## What's the difference between `react-final-form-hooks` and the hooks introduced in `react-final-form v5`?
Great question. The TL;DR is this:
- `react-final-form-hooks` is a lightweight, simple solution for quickly getting a form up and running _in a single render function_, but allows for no performance optimization.
- `react-final-form v5` is a more robust, battle-tested solution that involves creating more components and structure around your form.
`react-final-form-hooks` does not put the `form` instance into the React context, but rather forces you to pass the `form` instance to `useField` so that the field can register itself with the form. This allows you to create your entire form in a single functional component, like the `MyForm` example above. It will also, by necessity, rerender your entire form on every value change.
`react-final-form v5` requires that you wrap your entire form in a `` component that provides the `form` instance via context to its descendants. This means that you cannot use `useField` in the same function that is rendering your ``, because `useField` must be inside the ``.
**Conclusion**: If your app has a couple of small (< 20 inputs) forms where you aren't doing anything fancy with reusable custom input components, `react-final-form-hooks` might be all you need. But if your app is bigger and more sophisticated, or you need to optimize for performance, you should probably use `react-final-form`.
## Examples
### [Simple Example](https://codesandbox.io/s/r4j042m694)
Shows how to create fields and attach them to `` elements.
## API
The following can be imported from `react-final-form-hooks`.
### `useField`
Returns an object similar to [`FieldRenderProps`](https://github.com/final-form/react-final-form#fieldrenderprops).
`useField` takes four parameters:
#### `name : string`
> The name of the field. Required.
#### `form : Form`
> The object returned from `useForm`. Required.
#### `validate? : (value:any) => any`
> A field-level validation function that takes the current value and returns `undefined` if it is valid, or the error if it is not. Optional.
#### `subscription? : FieldSubscription`
> A subscription of which parts of field state to be notified about. See [`FieldSubscription`](https://github.com/final-form/final-form#fieldsubscription--string-boolean-). Optional.
### `useForm`
Returns an object similar to [`FormRenderProps`](https://github.com/final-form/react-final-form#formrenderprops).
`useForm` takes two parameters:
#### `onSubmit : (values:Object) => ?Object | Promise | void`
See [🏁 Final Form's `onSubmit` docs](https://github.com/final-form/final-form#onsubmit-values-object-form-formapi-callback-errors-object--void--object--promiseobject--void) for more information. Required.
#### `validate?: (values:Object) => Object | Promise`
A record level validation function. See [🏁 Final Form's `validate` docs](https://github.com/final-form/final-form#validate-values-object--object--promiseobject) for more information. Optional.
---
## Contributors
This project exists thanks to all the people who contribute. [[Contribute](.github/CONTRIBUTING.md)].
## Backers
Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/final-form#backer)]
## Sponsors
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/final-form#sponsor)]
