@mui/x-charts/context/HighlightedProvider/useItemHighlighted.d.ts

The community edition of the Charts components (MUI X).

import { HighlightItemData } from './HighlightedContext';
export type ItemHighlightedState = {
    /**
     * Whether the item is highlighted.
     */
    isHighlighted: boolean;
    /**
     * Whether the item is faded.
     */
    isFaded: boolean;
};
/**
 * A hook to check the highlighted state of the item.
 * This function already calculates that an item is not faded if it is highlighted.
 *
 * If you need fine control over the state, use the `useHighlighted` hook instead.
 *
 * @param {HighlightItemData} item is the item to check
 * @returns {ItemHighlightedState} the state of the item
 */
export declare function useItemHighlighted(item: HighlightItemData | null): ItemHighlightedState;