search

chakra-ui / chakra-ui-docs

Documentation website for chakra ui
https://chakra-ui.com
MIT License
301 stars 477 forks source link

Parameters of useDisclosure hook are not documented #1540

Closed gauravsoni119 closed 1 year ago

gauravsoni119 commented 1 year ago

Description

When I am looking into the parameter section of useDisclosure hook, I am not able to see any table for the parameters. After the line: The useDisclosure hook accepts an optional object with the following properties: nothing is there. As a user, I am expecting parameter names with descriptions and their default value.

Parameter Type Description
isOpen (Optional) boolean If true, the controlled component is responsible for changing the visible state via onClose and onOpen props.
defaultIsOpen (Optional) boolean If true, it sets the controlled component to its visible state
onClose function Function to set a falsy value for the isOpen parameter.
onOpen function Function to set a truthy value for the isOpen parameter.

If accepted, I am happy to contribute.:)

aacevski commented 1 year ago

Hey @gauravsoni119, this looks good to be worked on! You can go ahead.