useToggle

v0.0.1testeddemo

A composable that provides a boolean toggle with customizable truthy/falsy values

Examples

const { value, toggle } = useToggle();

const { value, toggle } = useToggle(false, { truthyValue: 'on', falsyValue: 'off' });

Demo

Loading demo…

Signature

export function useToggle<Truthy = true, Falsy = false>(
  initialValue: MaybeRef<Truthy | Falsy> = false as Truthy | Falsy,
  options: UseToggleOptions<Truthy, Falsy> ={ ... }

Type Parameters

Truthy= true

Falsy= false

Parameters

Parameter	Type	Default	Description
`initialValue`?	`MaybeRef<Truthy \| Falsy>`	`false as Truthy \| Falsy`	The initial value
`options`?	`UseToggleOptions<Truthy, Falsy>`	`{}`	Options for custom truthy/falsy values

Returns

UseToggleReturn<Truthy, Falsy>The toggle state and function