aq-uiToggleControls
interfaceSource L13Type contract for ToggleControls.
interface ToggleControlsMembers
| Name | Type |
|---|---|
toggle | () => void |
setOn | () => void |
setOff | () => void |
setValue | (value: boolean) => void |
Use Toggle
Open-code aq-ui React hook for Use Toggle.
Installation
pnpm dlx aq-ui@alpha add use-toggleAPI reference
Client moduleImport the parts you need, then jump to an export for its contract.
Quick start
"use client"
import { useToggle } from "@/hooks/use-toggle"
const result = useToggle()useToggle
functionSource L20Open-code aq-ui React hook for Use Toggle.
function useToggle({ value, defaultValue = false, onChange, }: UseToggleOptions = {}): [boolean, ToggleControls]- Returns
[boolean, ToggleControls]
Parameters
| Name | Type | Default |
|---|---|---|
options? | UseToggleOptions | {} |
const result = useToggle()
UseToggleOptions
interfaceSource L7Type contract for UseToggleOptions.
interface UseToggleOptionsMembers
| Name | Type | Default |
|---|---|---|
value? | boolean | — |
defaultValue? | boolean | false |
onChange? | (value: boolean) => void | — |
Registry dependencies
use-controllable-state
Files
- hooks/use-toggle.ts