UNPKG

567 BTypeScriptView Raw
1import { UseListItemParameters, UseListItemReturnValue } from './useListItem.types';
2/**
3 * Contains the logic for an item of a list-like component (e.g. Select, Menu, etc.).
4 * It provides information about the item's state (selected, highlighted) and
5 * handles the item's mouse events.
6 *
7 * @template ItemValue The type of the item's value. This should be consistent with the type of useList's `items` parameter.
8 * @ignore - internal hook.
9 */
10export default function useListItem<ItemValue>(parameters: UseListItemParameters<ItemValue>): UseListItemReturnValue;