Warp/node_modules/@algolia/autocomplete-shared/dist/esm/js/HighlightHitParams.d.ts

19 lines
470 B
TypeScript
Raw Permalink Normal View History

2024-01-05 12:14:38 +00:00
export declare type HighlightHitParams<THit> = {
/**
* The Algolia hit whose attribute to retrieve the highlighted parts from.
*/
hit: THit;
/**
* The attribute to retrieve the highlighted parts from.
*
* You can use the array syntax to reference nested attributes.
*/
attribute: keyof THit | string[];
/**
* The tag name to use for highlighted parts.
*
* @default "mark"
*/
tagName?: string;
};