README

useQuickState

useQuickState is a React hook. An easy way to add state without having multiple useState hooks. Too many useState hooks have to be refactored using useReducer. This hook abstracts that conversion from useState to useReducer. It looks like useState but behaves like useReducer.

Features:

Provides getter and setter for a given single-level (non-nested) object.
Getter and setter names are based on the key names of the input object.
See Usage: For a given object with keys name, age and isPopular, the hook returns a set of getters and setters such as name, setName, age, setAge, isPopular, setIsPopular.
Generic get and set function
- The hook also provides a generic getter and setter method called get and set.
- The set function takes two arguments - key name and its value.
- This set function is curriable. See the usage given below.

Installation

npm install --save use-quick-state

Usage

import React from 'react'
import useQuickState from 'use-quick-state'

const eCbk = cbk => ({ target: { type, value, checked } }) =>
  cbk(type === 'checkbox' ? checked : value)

const Example = () => {
  const { name, age, isPopular, setName, setAge, setIsPopular } = useQuickState(
    {
      name: 'JavaScript',
      age: 30,
      isPopular: true
    }
  )

  return (
    <form>
      <div data-testid="name-value">{name}</div>
      <div data-testid="age-value">{age}</div>
      <div data-testid="popular-value">
        {isPopular ? 'Popular' : 'Not popular'}
      </div>
      <hr />
      <label>
        Name:
        <input type="text" name={name} onChange={eCbk(setName)} />
      </label>
      <br />
      <label>
        Is popular?:
        <input
          name="isPopular"
          type="checkbox"
          checked={isPopular}
          onChange={eCbk(setIsPopular)}
        />
      </label>
      <br />
      <label>
        Number of years in use:
        <input name="age" type="number" value={age} onChange={eCbk(setAge)} />
      </label>
    </form>
  )
}

Usage - With generic (curriable) set and get

import React from 'react'
import useQuickState from 'use-quick-state'

const Example = () => {
  const { get, set } = useQuickState({
    name: 'JavaScript',
    age: 30,
    isPopular: true
  }, true), // When you pass true value here, the setters consider its input value as an event object and extracts value out of it.  In this case, you don't need a method like eCbk as used in the previous usage example.
  name = get('name'),
  isPopular = get('isPopular'),
  age = get('age')

  return (
    <form>
      <label>
        Name:
        <input type="text" name={name} onChange={set('name')} />
      </label>
      <br />
      <label>
        Is popular?:
        <input
          name="isPopular"
          type="checkbox"
          checked={isPopular}
          onChange={set('isPopular')} />
      </label>
      <br />
      <label>
        Number of years in use:
        <input
          name="age"
          type="number"
          value={age}
          onChange={value => setAge('age', value)} />
      </label>
    </form>
  )
}

API

useQuickState(initialData, passEventObjectToSetters)

Returns: Object with state and its setters

initialData

Type: Object

This hook takes a single-level (non-nested) object

passEventObjectToSetters

Type: Boolean

With this flag set to true, you can directly use the setters as an onChange function. The setters consider its input value as an event object and extracts value out of it. In this case, you don't need a method like eCbk as used in the first usage example.

use-quick-state

Usage no npm install needed!