@guoba-ai/hook / useToggle

Function: useToggle()

function useToggle(initialValue?): [boolean, (next?) => void];

Defined in: useToggle.ts:24

Toggle a boolean value.

Parameters

initialValue?

boolean = false

The initial boolean value (defaults to false)

Returns

[boolean, (next?) => void]

A tuple of [value, toggle] where toggle flips the value or sets it to a specific boolean

Example

const [isOpen, toggleOpen] = useToggle()
toggleOpen()     // true
toggleOpen()     // false
toggleOpen(true) // true

const [enabled, setEnabled] = useToggle(true)
setEnabled(false) // false

const [visible, toggleVisible] = useToggle()
toggleVisible(undefined) // toggles, same as toggleVisible()

Warning

initialValue is only used for the initial render. Pass a boolean to the setter when you need an explicit state.