mirror of
https://github.com/Snigdha-OS/documentation.git
synced 2025-09-11 20:04:55 +02:00
19 lines
470 B
TypeScript
19 lines
470 B
TypeScript
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;
|
|
};
|