23 lines
846 B
TypeScript
23 lines
846 B
TypeScript
import { HighlightItemData } from "../internals/plugins/featurePlugins/useChartHighlight/useChartHighlight.types.js";
|
|
type UseItemHighlightedReturnType = {
|
|
/**
|
|
* Whether the item is highlighted.
|
|
*/
|
|
isHighlighted: boolean;
|
|
/**
|
|
* Whether the item is faded.
|
|
*/
|
|
isFaded: boolean;
|
|
};
|
|
type UseItemHighlightedParams = HighlightItemData | null;
|
|
/**
|
|
* 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 `useItemHighlightedGetter` hook instead.
|
|
*
|
|
* @param {HighlightItemData | null} item is the item to check
|
|
* @returns {UseItemHighlightedReturnType} the state of the item
|
|
*/
|
|
export declare function useItemHighlighted(item: UseItemHighlightedParams): UseItemHighlightedReturnType;
|
|
export {}; |