useToggle ​
Hook that create toggle
utilities
test coverage
Last changed: last month
Installation ​
Library
CLI
Manual
typescript
import { useToggle } from '@siberiacancode/reactuse';
Usage ​
typescript
const [on, toggle] = useToggle();
// or
const [value, toggle] = useToggle(['light', 'dark'] as const);
Demo ​
Api ​
Parameters
Name | Type | Default | Note |
---|---|---|---|
values? | Value[] | [false, true] | The values to toggle |
Type declaration ​
typescript
import type { SetStateAction } from 'react';
export type UseToggleReturn<Value> = readonly [Value, (value?: Value) => void];
Source ​
Source • DemoContributors ​
D
H