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-stateful-form-component

v0.0.7

Published

From component for React using react state hooks

Downloads

8

Readme

React Stateful Form Component

React Stateful Form Component is designed to be a wrapper that takes an object of fields that it handles the state for and form submission.

It can be used to create controller inputs or you can use the built in inputs.

Usage

import {StatefulForm} from 'react-stateful-form-component'

const MyComponent = () => {
  return <StatefulForm
    data={{
      name: '',
      email: ''
    }}
    validator={({field, value}) => {
      switch(field){
        case "name":
          return value.length > 0
        case "email":
          return value.length > 5
      }
    }}
    onSubmit={(data) => {
      // Send off your data to an API or use it in this components state
    }}
  >
    {({input, valid}) => {
      return <div>
        {input('name', ({value, update, valid}) => {
          return <input
            type="text"
            name="name"
            value={value}
            onChange={(e) => update(e.target.value)}
            className={valid() ? 'valid' : 'invalid'}
          />
        })}
        {input('email', ({value, update, valid}) => {
          return <input
            type="text"
            name="name"
            value={value}
            onChange={(e) => update(e.target.value)}
            className={valid() ? 'valid' : 'invalid'}
          />
        })}
        <input type="submit" disabled={!valid()} value="Submit" />
      </div>
    }}
  </StatefulForm>
}

StatefulForm

This is the main component and the only export you normally need to use.

data

The object that describes the form. The values in the object are used as the initial values for the form.

{
  name: 'Something',
  email: '[email protected]'
}

onSubmit

The callback that gets called when the form is submitted.

It receives 2 paramters:

  • data - The current state of the form.
  • reset - A function to reset the form to its original values.
(data) => {
  SomeAPI.save(data)
}

validator

The function used to check if a field is valid. If it is not supplied all values are considered valid.

The function is passed an object with 3 properties, field the field to check, value its current value and fields the current form state.

({field, value}) => {
  switch(field){
    case "name":
      return value.length > 0
    case "email":
      return value.length > 5
  }
}

Invalid data will still be passed to the onSubmit handler, make sure that you use valid() to ensure that the form cannot be submitted whilst invalid.

Render function

The children of StatefulForm is a function not a collection of JSX elements like you would expect.

The function is passed an object with 4 properties:

  • fields - The current form state
  • input - The Input Handler Function
  • Input - A component that wraps input
  • valid - The validation checker function.

Input Handler Function

The input function is used to create your form inputs. It is merely a wrapper that provides field specific functions for you yo build input components.

It has 2 arguments, field which is the field you want this input to be and a function that renders the input.

The function is passed an object with 5 properties:

  • fields - The current form state.
  • field - The field this input is controlling.
  • update - A function that updates the value in the forms state.
  • value - The fields current value.
  • valid - A function that returns a boolean value for the validation status of this field.