ResultHighlight
Home > @backstage/plugin-search-common > ResultHighlight
Metadata for result relevant document fields with matched terms highlighted via wrapping in associated pre/post tags. The UI is expected to parse these field excerpts by replacing wrapping tags with applicable UI elements for rendering.
Signature:
export interface ResultHighlight
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| fields | { [field: string]: string; } | ||
| postTag | string | Postfix tag for wrapping terms to be highlighted. | |
| preTag | string | Prefix tag for wrapping terms to be highlighted. |