Skip to content

🎣 A hook whose setter can be directly given to HTML inputs

License

Notifications You must be signed in to change notification settings

robcalcroft/react-use-input

Repository files navigation

react-use-input

A hook 🎣 whose setter can be directly given to HTML inputs

This package is designed to be super simple and small; it won't add any bloat to your project. However, feel free to copy and paste the code if you'd like to avoid another dependency 😄

Other packages use object spread syntax to achieve a similar result, but this package doesn't because:

  • This way is much easier to read
  • You don't end up with bloat in your props for super simple use cases

Install

yarn add react-use-input

Use

By default, useInput() returns a tuple of the current value and a setter which will pick the value key out of an Event object.

useInput(<initialValue (defaults to '') (optional)>, <valueKey (defaults to 'value') (optional)>)

A simple example

import useInput from 'react-use-input';

function Component() {
  const [name, setName] = useInput();
  
  return <input value={name} onChange={setName} />;
}

Checkbox type input with non default state

import useInput from 'react-use-input';

function Component() {
  const [selected, setSelected] = useInput(false, 'checked');
  
  return (
    <input type="checkbox" checked={selected} onChange={setSelected} />
  );
}

Feel free to raise an issue to discuss other use cases that aren't covered here

About

🎣 A hook whose setter can be directly given to HTML inputs

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published