hexagon

useDisclosure is a custom hook used to help handle common open, close, or toggle scenarios. It can be used to control feedback component such as Modal, AlertDialog, Drawer, etc.

This is an re-export of the useDisclosure hook from ChakraUI, see here for more information

Import


import { useDisclosure, Text } from '@passfort/castle'
content_copyCopy

Return value

The useDisclosure hook returns an object with the following fields:

Name	Type	Default	Description
`isOpen`	`boolean`	`false`	If `true`, it sets the controlled component to its visible state.
`onClose`	`function`		Callback function to set a falsy value for the `isOpen` parameter.
`onOpen`	`function`		Callback function to set a truthy value for the `isOpen` parameter.
`onToggle`	`function`		Callback function to toggle the value of the `isOpen` parameter.

Usage


function Example() {
  const { isOpen, onOpen, onClose } = useDisclosure()

  return (
    <>
      <Text> TODO</Text>
    </>
  )
}function Example() {
  const { isOpen, onOpen, onClose } = useDisclosure()

  return (
    <>
      <Text> TODO</Text>
    </>
  )
}
content_copyCopy
live example

CASTLE UI

Core

Information

Fundamentals

Core

API

Hooks

Components

Input

Layout

Page Layout

Data Display

Table

Navigation

Feedback

Overlay

Utils

KYC

Guides

Templates

Import

Return value

Usage

Contents