@base-ui-components/react/esm/composite/list/CompositeList.d.ts

Base UI is a library of headless ('unstyled') React components and low-level hooks. You gain complete control over your app's CSS and accessibility features.

import * as React from 'react';
export type CompositeMetadata<CustomMetadata> = {
    index?: number | null;
} & CustomMetadata;
/**
 * Provides context for a list of items in a composite component.
 * @ignore - internal component.
 */
declare function CompositeList<Metadata>(props: CompositeList.Props<Metadata>): React.JSX.Element;
declare namespace CompositeList {
    var propTypes: any;
}
declare namespace CompositeList {
    interface Props<Metadata> {
        children: React.ReactNode;
        /**
         * A ref to the list of HTML elements, ordered by their index.
         * `useListNavigation`'s `listRef` prop.
         */
        elementsRef: React.RefObject<Array<HTMLElement | null>>;
        /**
         * A ref to the list of element labels, ordered by their index.
         * `useTypeahead`'s `listRef` prop.
         */
        labelsRef?: React.RefObject<Array<string | null>>;
        onMapChange?: (newMap: Map<Node, CompositeMetadata<Metadata> | null>) => void;
    }
}
export { CompositeList };