@ariakit/core/cjs/radio/radio-store.d.ts

Ariakit core

import type { CompositeStoreFunctions, CompositeStoreOptions, CompositeStoreState } from "../composite/composite-store.ts";
import type { Store, StoreOptions, StoreProps } from "../utils/store.ts";
import type { SetState } from "../utils/types.ts";
/**
 * Creates a radio store.
 */
export declare function createRadioStore({ ...props }?: RadioStoreProps): RadioStore;
export interface RadioStoreState extends CompositeStoreState {
    /** @default true */
    focusLoop: CompositeStoreState["focusLoop"];
    /**
     * The value of the radio group.
     * @default null
     */
    value: string | number | null;
}
export interface RadioStoreFunctions extends CompositeStoreFunctions {
    /**
     * Sets the [`value`](https://ariakit.org/reference/radio-provider#value)
     * state.
     * @example
     * store.setValue("apple");
     * store.setValue((value) => value === "apple" ? "orange" : "apple");
     */
    setValue: SetState<RadioStoreState["value"]>;
}
export interface RadioStoreOptions extends StoreOptions<RadioStoreState, "focusLoop" | "value">, CompositeStoreOptions {
    /**
     * The default value of the radio group.
     * @default null
     */
    defaultValue?: RadioStoreState["value"];
}
export interface RadioStoreProps extends RadioStoreOptions, StoreProps<RadioStoreState> {
}
export interface RadioStore extends RadioStoreFunctions, Store<RadioStoreState> {
}