Skip to content
aq-ui
Back to HooksHook

Use Disclosure

Open-code aq-ui React hook for Use Disclosure.

Installation

pnpm dlx aq-ui@alpha add use-disclosure

API reference

Client module

Import the parts you need, then jump to an export for its contract.

View full source

Quick start

"use client"

import { useDisclosure } from "@/hooks/use-disclosure"

const result = useDisclosure()

DisclosureControls

interfaceSource L13

Type contract for DisclosureControls.

interface DisclosureControls

Members

NameType
open() => void
close() => void
toggle() => void
setOpen(open: boolean) => void

useDisclosure

functionSource L20

Open-code aq-ui React hook for Use Disclosure.

function useDisclosure({ open, defaultOpen = false, onOpenChange, }: UseDisclosureOptions = {}): [boolean, DisclosureControls]
Returns
[boolean, DisclosureControls]

Parameters

NameTypeDefault
options?UseDisclosureOptions{}
const result = useDisclosure()

UseDisclosureOptions

interfaceSource L7

Type contract for UseDisclosureOptions.

interface UseDisclosureOptions

Members

NameTypeDefault
open?boolean—
defaultOpen?booleanfalse
onOpenChange?(open: boolean) => void—

Registry dependencies

use-controllable-state

Files

  • hooks/use-disclosure.ts

Source