@ariakit/react-core
Version:
Ariakit React core
27 lines (26 loc) • 996 B
text/typescript
import type { PickRequired } from "@ariakit/core/utils/types";
import type { ReactElement, ReactNode } from "react";
import type { SelectStoreProps, SelectStoreValue } from "./select-store.ts";
type Value = SelectStoreValue;
/**
* Provides a select store to [Select](https://ariakit.org/components/select)
* components.
* @see https://ariakit.org/components/select
* @example
* ```jsx
* <SelectProvider defaultValue="Apple">
* <Select />
* <SelectPopover>
* <SelectItem value="Apple" />
* <SelectItem value="Banana" />
* <SelectItem value="Orange" />
* </SelectPopover>
* </SelectProvider>
* ```
*/
export declare function SelectProvider<T extends Value = Value>(props: PickRequired<SelectProviderProps<T>, "value" | "defaultValue">): ReactElement;
export declare function SelectProvider(props?: SelectProviderProps): ReactElement;
export interface SelectProviderProps<T extends Value = Value> extends SelectStoreProps<T> {
children?: ReactNode;
}
export {};