Skip to content

useInputState

useInputState is a React hook that manages an input state with optional value transformation.

Interface

ts
function useInputState(
  initialValue: string = '',
  transformValue: (value: string) => string = (v: string) => v
): [value: string, onChange: (value: string) => void];

Parameters

  • initialValuestring

    The initial value of the input. Defaults to an empty string ("").

  • transformValue(value: string) => string

    A function to transform the input value. Defaults to an identity function that returns the input unchanged.

Return Value

  • [value: string, onChange: (value: string) => void]

    tuple containing:

    • valuestring

      The current state value.

    • onChange(value: string) => void

      A function to update the state.

Example

tsx
function Example() {
  const [value, setValue] = useInputState('');
  return <input type="text" value={value} onChange={setValue} />;
}

Released under the MIT License.