katanakit-js / useCreateToggle

Function: useCreateToggle()

function useCreateToggle(initialValue?): [SignalGetter<boolean>, ToggleSignalSetter];

Defined in: src/core/services/reactive.service.ts:232

Creates a boolean toggle signal.

Parameters

Parameter	Type	Default value	Description
initialValue	boolean	false	Starting value (defaults to false).

Returns

[SignalGetter<boolean>, ToggleSignalSetter]

A tuple of [getter, { useSet, useToggle }].

Example

const [isOpen, { useSet, useToggle }] = useCreateToggle();
isOpen();    // false
useToggle();
isOpen();    // true
useSet(false);
isOpen();    // false