Back to React Spectrum

useDisclosureState

packages/react-stately/docs/disclosure/useDisclosureState.mdx

2022-12-161.4 KB
Original Source

{/* Copyright 2024 Adobe. All rights reserved. This file is licensed to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */}

import {Layout} from '@react-spectrum/docs'; export default Layout;

import docs from 'docs:@react-stately/disclosure'; import {ClassAPI, HeaderInfo, TypeContext, FunctionAPI, TypeLink, PageDescription} from '@react-spectrum/docs'; import packageData from '@react-stately/disclosure/package.json';


category: Navigation keywords: [disclosure, state]

useDisclosureState

<PageDescription>{docs.exports.useDisclosureState.description}</PageDescription>

<HeaderInfo packageData={packageData} componentNames={['useDisclosureState']} />

API

<FunctionAPI function={docs.exports.useDisclosureState} links={docs.links} />

Interface

<ClassAPI links={docs.links} class={docs.links[docs.exports.useDisclosureState.return.id]} />

Example

See the docs for useDisclosure in react-aria for an example of useDisclosureState.