npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, πŸ‘‹, I’m Ryan HefnerΒ  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you πŸ™

Β© 2024 – Pkg Stats / Ryan Hefner

react-final-form-hooks

v2.0.2

Published

React Hooks to bind to 🏁 Final Form's high performance subscription-based form state management engine

Downloads

22,295

Readme

🏁 React Final Form Hooks

React Final Form Hooks

Backers on Open Collective Sponsors on Open Collective NPM Version NPM Downloads Build Status codecov.io styled with prettier

βœ… Zero dependencies

βœ… Only peer dependencies: React and 🏁 Final Form

βœ… Opt-in subscriptions - only update on the state you need!

βœ… πŸ’₯ 1.2 kB gzipped πŸ’₯


Installation

npm install --save react-final-form-hooks final-form

or

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.

⚠️ 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. 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:

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 (
    <form onSubmit={handleSubmit}>
      <div>
        <label>First Name</label>
        <input {...firstName.input} placeholder="First Name" />
        {firstName.meta.touched && firstName.meta.error && (
          <span>{firstName.meta.error}</span>
        )}
      </div>
      <div>
        <label>Last Name</label>
        <input {...lastName.input} placeholder="Last Name" />
        {lastName.meta.touched && lastName.meta.error && (
          <span>{lastName.meta.error}</span>
        )}
      </div>
      <button type="submit" disabled={pristine || submitting}>
        Submit
      </button>
    </form>
  )
}

Table of Contents

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 <Form> 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 <Form>, because useField must be inside the <Form>.

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

Shows how to create fields and attach them to <input/> elements.

API

The following can be imported from react-final-form-hooks.

useField

Returns an object similar to 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. Optional.

useForm

Returns an object similar to FormRenderProps.

useForm takes two parameters:

onSubmit : (values:Object) => ?Object | Promise<?Object> | void

See 🏁 Final Form's onSubmit docs for more information. Required.

validate?: (values:Object) => Object | Promise<Object>

A record level validation function. See 🏁 Final Form's validate docs for more information. Optional.


Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! πŸ™ [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]