ais-snippet

Signature

<ais-snippet
  attribute="string"
  :hit="object"
  // Optional parameters
  highlighted-tag-name="string"
  :class-names="object"
/>

About this widget

The ais-snippet widget displays snippeted attributes of your search results.

This component leverages the snippeting feature of Algolia and is designed to work with the ais-hits or ais-infinite-hits widget.

The attribute must be set in attributesToSnippet, either inside the Algolia dashboard or at runtime:

Copy
<ais-configure :attributesToSnippet="['description']"/>

Copy
<ais-snippet attribute="description" :hit="hit" />

Given this record:

Copy
{
  "objectID": 1,
  "meta": {
    "description": "my description"
  }
}

You can access the snippeted version by specifying the path separating levels with dots:

Copy
<ais-snippet attribute="meta.description" :hit="hit" />


            attribute

type: string

Required

The attribute of the record to snippet. You can give a dot-separated value for deeply nested objects, like actor.name.

Copy
<ais-snippet
  [...]
  attribute="description"
/>

hit

type: object

Required

The original hit object provided to the function. For this to work, the provided object must have a _snippetResult[attribute].value property.

Copy
<ais-snippet
  [...]
  :hit="hit"
/>


            highlighted-tag-name

type: string

default: "mark"

Optional

The name of the HTML element to wrap the highlighted parts of the string.

Copy
<ais-snippet
  [...]
  highlighted-tag-name="em"
/>


            class-names

type: object

default: {}

Optional

The CSS classes to override.

Copy
<ais-snippet
  [...]
  :class-names="{
    'ais-Snippet': 'MyCustomSnippet',
  }"
/>

Copy
<span class="ais-Snippet">This is the <mark class="ais-Snippet-highlighted">highlighted text</mark></span>

Did you find this page helpful?