useToggle

Hook that create toggle

state

high

test coverage

Last changed: 7 months ago

Installation

Library

CLI

Manual

import { useToggle } from '@siberiacancode/reactuse';

Usage

const [on, toggle] = useToggle();
// or
const [value, toggle] = useToggle(['light', 'dark'] as const);

Demo

source

Api

Parameters

Name	Type	Default	Note
values?	Value[]	[false, true]	The values to toggle

Type declaration

import type { SetStateAction } from 'react';

export type UseToggleReturn<Value> = readonly [Value, (value?: Value) => void];

Source

Source • Demo

Contributors

D

debabin

H

hywax