@ariakit/react-core/cjs/disclosure/disclosure-store.d.ts

Ariakit React core

import * as Core from "@ariakit/core/disclosure/disclosure-store";
import type { Store } from "../utils/store.tsx";
export declare function useDisclosureStoreProps<T extends Core.DisclosureStore>(store: T, update: () => void, props: DisclosureStoreProps): T & {
    disclosure: DisclosureStore | null | undefined;
};
/**
 * Creates a disclosure store to control the state of
 * [Disclosure](https://ariakit.org/components/disclosure) components.
 * @see https://ariakit.org/components/disclosure
 * @example
 * ```jsx
 * const disclosure = useDisclosureStore();
 *
 * <Disclosure store={disclosure}>Disclosure</Disclosure>
 * <DisclosureContent store={disclosure}>Content</DisclosureContent>
 * ```
 */
export declare function useDisclosureStore(props?: DisclosureStoreProps): DisclosureStore;
export interface DisclosureStoreState extends Core.DisclosureStoreState {
}
export interface DisclosureStoreFunctions extends Pick<DisclosureStoreOptions, "disclosure">, Omit<Core.DisclosureStoreFunctions, "disclosure"> {
}
export interface DisclosureStoreOptions extends Core.DisclosureStoreOptions {
    /**
     * A callback that gets called when the
     * [`open`](https://ariakit.org/reference/disclosure-provider#open) state
     * changes.
     * @example
     * const [open, setOpen] = useState(false);
     * const disclosure = useDisclosureStore({ open, setOpen });
     */
    setOpen?: (open: DisclosureStoreState["open"]) => void;
    /**
     * A callback that gets called when the `mounted` state changes.
     * @example
     * const [mounted, setMounted] = useState(false);
     * const disclosure = useDisclosureStore({ setMounted });
     */
    setMounted?: (mounted: DisclosureStoreState["mounted"]) => void;
    /**
     * A reference to another disclosure store that controls another disclosure
     * component to keep them in sync. Element states like `contentElement` and
     * `disclosureElement` won't be synced. For that, use the
     * [`store`](https://ariakit.org/reference/disclosure-provider#store) prop
     * instead.
     *
     * Live examples:
     * - [Command Menu](https://ariakit.org/examples/dialog-combobox-command-menu)
     * - [Command Menu with
     *   Tabs](https://ariakit.org/examples/dialog-combobox-tab-command-menu)
     */
    disclosure?: DisclosureStore | null;
}
export interface DisclosureStoreProps extends DisclosureStoreOptions, Omit<Core.DisclosureStoreProps, "disclosure"> {
}
export interface DisclosureStore extends DisclosureStoreFunctions, Omit<Store<Core.DisclosureStore>, "disclosure"> {
}