API Reference / Vue InstantSearch / ais-snippet

ais-snippet

Signature 
<ais-snippet
  attribute="string"
  :hit="object"
  // Optional parameters
  highlighted-tag-name="string"
  :class-names="object"
/>
Import
Copy 
1
2
3
4
5
6
7
8
9

import { AisSnippet } from 'vue-instantsearch';
// Use 'vue-instantsearch/vue3/es' for Vue 3

export default {
  components: {
    AisSnippet
  },
  // ...
};

1. Follow additional steps in Optimize build size to ensure your code is correctly bundled.
2. This imports all the widgets, even the ones you don’t use. Read the Getting started guide for more information.

See code examples
See live example

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 
1

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

Examples

Basic usage

Copy 
1

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

Access a nested property

Given this record:

Copy 
1
2
3
4
5
6

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

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

Copy 
1

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

Props

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 
1
2
3
4

<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 
1
2
3
4

<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 
1
2
3
4

<ais-snippet
  [...]
  highlighted-tag-name="em"
/>
class-names
type: object
default: {}
Optional

The CSS classes to override.

  • ais-Snippet: the root element of the widget.
Copy 
1
2
3
4
5
6

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

HTML output

Copy 
1

<span class="ais-Snippet">This is the <mark class="ais-Snippet-highlighted">highlighted text</mark></span>
Did you find this page helpful?
Vue InstantSearch v4