Signature
About this widget
ThereverseSnippet
function returns any attribute from a hit into its snippeted form, when relevant.
This function leverages the snippeting feature of Algolia
and is designed to work with the hits
or infiniteHits
widget.
The attribute
must be set in attributesToSnippet
,
either inside the Algolia dashboard or at runtime:
JavaScript
Examples
JavaScript
Options
The attribute of the record to snippet.
You can give a dot-separated value for deeply nested objects, like
description.full
.JavaScript
Original
hit
object provided to the function.
The value is already bound to the function inside a string template, so you don’t have to provide it.
For this to work, the provided object must have a _snippetResult[attribute].value
property.JavaScript
The name of the HTML element to wrap the snippeted parts of the string.
JavaScript
The HTML element that wraps the non-highlighted parts of the string.
JavaScript
The character between each item when the attribute to highlight is an array.
JavaScript
The CSS classes you can override:
root
. The component’s root element.highlighted
. The highlighted parts.nonHighlighted
. The non-highlighted parts.separator
. The separator elements between highlighted parts.
JavaScript
HTML output
HTML