useToggle

Boolean state toggle helper with convenience methods.

Import

import { useToggle } from "neoterm-ui";

Usage

const sidebar = useToggle(true);

<Button onClick={sidebar.toggle}>Toggle Sidebar</Button>
<Button onClick={sidebar.setOff}>Close</Button>
{sidebar.value && <Sidebar />}

Signature

function useToggle(initial?: boolean): {
  value: boolean;
  toggle: () => void;
  setOn: () => void;
  setOff: () => void;
  setValue: (v: boolean) => void;
}

Returns

Prop	Type	Default	Description
value	boolean	—	Current state.
toggle	() => void	—	Flip the value.
setOn	() => void	—	Set to true.
setOff	() => void	—	Set to false.
setValue	(v: boolean) => void	—	Set to explicit value.