///
import type { CreateNewItem } from "./listItemsUtils";
/**
* An object describing how to render the list of items.
* An `itemListRenderer` receives this object as its sole argument.
*/
export interface ItemListRendererProps {
/**
* The currently focused item (for keyboard interactions), or `null` to
* indicate that no item is active.
*/
activeItem: T | CreateNewItem | null;
/**
* Array of items filtered by `itemListPredicate` or `itemPredicate`.
* See `items` for the full list of items.
*
* Use `renderFilteredItems()` utility function from this library to
* map each item in this array through `renderItem`, with support for
* optional `noResults` and `initialContent` states.
*/
filteredItems: T[];
/**
* Array of all items in the list.
* See `filteredItems` for a filtered array based on `query` and predicate props.
*/
items: T[];
/**
* The current query string.
*/
query: string;
/**
* A ref handler that should be attached to the parent HTML element of the menu items.
* This is required for the active item to scroll into view automatically.
*/
itemsParentRef: React.Ref;
/**
* Props to apply to the `Menu` created within the `itemListRenderer`
*/
menuProps?: React.HTMLAttributes;
/**
* Call this function to render an item.
* This retrieves the modifiers for the item and delegates actual rendering
* to the owner component's `itemRenderer` prop.
*/
renderItem: (item: T, index: number) => React.JSX.Element | null;
/**
* Call this function to render the "create new item" view component.
*
* @returns null when creating a new item is not available, and undefined if the createNewItemRenderer returns undefined
*/
renderCreateItem: () => React.JSX.Element | null | undefined;
}
/** Type alias for a function that renders the list of items. */
export type ItemListRenderer = (itemListProps: ItemListRendererProps) => React.JSX.Element | null;
/**
* `ItemListRenderer` helper method for rendering each item in `filteredItems`,
* with optional support for `noResults` (when filtered items is empty)
* and `initialContent` (when query is empty).
*/
export declare function renderFilteredItems(props: ItemListRendererProps, noResults?: React.ReactNode, initialContent?: React.ReactNode | null): React.ReactNode;