@ariakit/core/esm/checkbox/checkbox-store.d.ts

Ariakit core

import type { Store, StoreOptions, StoreProps } from "../utils/store.ts";
import type { PickRequired, SetState, ToPrimitive } from "../utils/types.ts";
/**
 * Creates a checkbox store.
 */
export declare function createCheckboxStore<T extends CheckboxStoreValue = CheckboxStoreValue>(props: PickRequired<CheckboxStoreProps<T>, "value" | "defaultValue">): CheckboxStore<T>;
export declare function createCheckboxStore(props?: CheckboxStoreProps): CheckboxStore;
export type CheckboxStoreValue = boolean | string | number | Array<string | number>;
export interface CheckboxStoreState<T extends CheckboxStoreValue = CheckboxStoreValue> {
    /**
     * The checked state of the checkbox.
     *
     * Live examples:
     * - [Custom Checkbox](https://ariakit.org/examples/checkbox-custom)
     */
    value: ToPrimitive<T>;
}
export interface CheckboxStoreFunctions<T extends CheckboxStoreValue = CheckboxStoreValue> {
    /**
     * Sets the [`value`](https://ariakit.org/reference/checkbox-provider#value)
     * state.
     * @example
     * store.setValue(true);
     * store.setValue((value) => !value);
     */
    setValue: SetState<CheckboxStoreState<T>["value"]>;
}
export interface CheckboxStoreOptions<T extends CheckboxStoreValue = CheckboxStoreValue> extends StoreOptions<CheckboxStoreState<T>, "value"> {
    /**
     * The default
     * [`value`](https://ariakit.org/reference/checkbox-provider#value) state of
     * the checkbox.
     *
     * Live examples:
     * - [Custom Checkbox](https://ariakit.org/examples/checkbox-custom)
     * - [Checkbox group](https://ariakit.org/examples/checkbox-group)
     * @default false
     */
    defaultValue?: CheckboxStoreState<T>["value"];
}
export interface CheckboxStoreProps<T extends CheckboxStoreValue = CheckboxStoreValue> extends CheckboxStoreOptions<T>, StoreProps<CheckboxStoreState<T>> {
}
export interface CheckboxStore<T extends CheckboxStoreValue = CheckboxStoreValue> extends CheckboxStoreFunctions<T>, Store<CheckboxStoreState<T>> {
}