docs(algolia): add doc for highlighting utils

algolia · Sep 9, 2020 · 00e2227 · 00e2227
1 parent a70f80d
commit 00e2227
Show file tree

Hide file tree

Showing 5 changed files with 84 additions and 0 deletions.
diff --git a/packages/website/docs/highlightAlgoliaHit.md b/packages/website/docs/highlightAlgoliaHit.md
@@ -26,18 +26,28 @@ const highlightedAlgoliaHit = highlightAlgoliaHit({
 
 > `AlgoliaHit` | required
 
+The Algolia hit to retrieve the attribute value from.
+
 ### `attribute`
 
 > `string` | required
 
+The attribute to retrieve the highlight value from.
+
 ### `highlightPreTag`
 
 > `string` | defaults to `<mark>`
 
+The HTML tag to prefix the value with.
+
 ### `highlightPostTag`
 
 > `string` | defaults to `</mark>`
 
+The HTML tag to suffix the value with.
+
 ### `ignoreEscape`
 
 > `string[]` | defaults to `[]`
+
+The characters to skip from escaping.
diff --git a/packages/website/docs/reverseHighlightAlgoliaHit.md b/packages/website/docs/reverseHighlightAlgoliaHit.md
@@ -26,18 +26,28 @@ const reverseHighlightedAlgoliaHit = reverseHighlightAlgoliaHit({
 
 > `AlgoliaHit` | required
 
+The Algolia hit to retrieve the attribute value from.
+
 ### `attribute`
 
 > `string` | required
 
+The attribute to retrieve the reverse highlight value from.
+
 ### `highlightPreTag`
 
 > `string` | defaults to `<mark>`
 
+The HTML tag to prefix the value with.
+
 ### `highlightPostTag`
 
 > `string` | defaults to `</mark>`
 
+The HTML tag to suffix the value with.
+
 ### `ignoreEscape`
 
 > `string[]` | defaults to `[]`
+
+The characters to skip from escaping.
diff --git a/packages/website/docs/reverseSnippetAlgoliaHit.md b/packages/website/docs/reverseSnippetAlgoliaHit.md
@@ -0,0 +1,53 @@
+---
+id: reverseSnippetAlgoliaHit
+---
+
+Highlights and escapes the non-matching parts of an Algolia hit snippet.
+
+This function can be used to display the differences of a hit match.
+
+# Example
+
+```js
+import { reverseSnippetAlgoliaHit } from '@algolia/autocomplete-preset-algolia';
+
+const hit = {}; // fetch an Algolia hit
+const reverseSnippetedAlgoliaHit = reverseSnippetAlgoliaHit({
+  hit,
+  attribute: 'query',
+});
+```
+
+# Reference
+
+## Params
+
+### `hit`
+
+> `AlgoliaHit` | required
+
+The Algolia hit to retrieve the attribute value from.
+
+### `attribute`
+
+> `string` | required
+
+The attribute to retrieve the reverse snippet value from.
+
+### `highlightPreTag`
+
+> `string` | defaults to `<mark>`
+
+The HTML tag to prefix the value with.
+
+### `highlightPostTag`
+
+> `string` | defaults to `</mark>`
+
+The HTML tag to suffix the value with.
+
+### `ignoreEscape`
+
+> `string[]` | defaults to `[]`
+
+The characters to skip from escaping.
diff --git a/packages/website/docs/snippetAlgoliaHit.md b/packages/website/docs/snippetAlgoliaHit.md
@@ -26,18 +26,28 @@ const snippetedAlgoliaHit = snippetAlgoliaHit({
 
 > `AlgoliaHit` | required
 
+The Algolia hit to retrieve the attribute value from.
+
 ### `attribute`
 
 > `string` | required
 
+The attribute to retrieve the snippet value from.
+
 ### `highlightPreTag`
 
 > `string` | defaults to `<mark>`
 
+The HTML tag to prefix the value with.
+
 ### `highlightPostTag`
 
 > `string` | defaults to `</mark>`
 
+The HTML tag to suffix the value with.
+
 ### `ignoreEscape`
 
 > `string[]` | defaults to `[]`
+
+The characters to skip from escaping.
diff --git a/packages/website/sidebars.js b/packages/website/sidebars.js
@@ -32,6 +32,7 @@ module.exports = {
           'highlightAlgoliaHit',
           'reverseHighlightAlgoliaHit',
           'snippetAlgoliaHit',
+          'reverseSnippetAlgoliaHit',
           'getAlgoliaHits',
           'getAlgoliaResults',
         ],