@ariakit/react-core/esm/collection/collection-provider.d.ts

Ariakit React core

import type { PickRequired } from "@ariakit/core/utils/types";
import type { ReactElement, ReactNode } from "react";
import type { CollectionStoreItem, CollectionStoreProps } from "./collection-store.ts";
/**
 * Provides a collection store to
 * [`CollectionItem`](https://ariakit.org/reference/collection-item) components.
 * @see https://ariakit.org/components/collection
 * @example
 * ```jsx
 * <CollectionProvider>
 *   <CollectionItem />
 *   <CollectionItem />
 *   <CollectionItem />
 * </CollectionProvider>
 * ```
 */
export declare function CollectionProvider<T extends CollectionStoreItem = CollectionStoreItem>(props: PickRequired<CollectionProviderProps<T>, "items" | "defaultItems">): ReactElement;
export declare function CollectionProvider(props?: CollectionProviderProps): ReactElement;
export interface CollectionProviderProps<T extends CollectionStoreItem = CollectionStoreItem> extends CollectionStoreProps<T> {
    children?: ReactNode;
}