You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,7 +41,7 @@ NB: If you don't have any Meilisearch instance running and containing your data,
41
41
-[🔧 Installation](#-installation)
42
42
-[🎬 Usage](#-usage)
43
43
-[💅 Customization](#-customization)
44
-
-[⚡️ Example with InstantSearch](#-example-with-instantSearch)
44
+
-[⚡️ Example with InstantSearch](#-example-with-instantsearch)
45
45
-[🤖 Compatibility with Meilisearch and InstantSearch](#-compatibility-with-meilisearch-and-instantsearch)
46
46
-[📜 API Resources](#-api-resources)
47
47
-[⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
@@ -312,14 +312,14 @@ List of all the components that are available in [instantSearch](https://github.
312
312
`instantSearch` is the main component. It manages the widget and lets you add new ones.
313
313
314
314
- ✅ IndexName: [`uid` of your index](https://docs.meilisearch.com/learn/core_concepts/indexes.html#indexes). _required_
315
-
- ✅ SearchClient: Search client, in our case instant-meilisearch. See [customization](#customization) for details on options. _required_
315
+
- ✅ SearchClient: Search client, in our case instant-meilisearch. See [customization](#-customization) for details on options. _required_
316
316
- ❌ numberLocale: Does not work with both Algoliasearch and instant-meilisearch.
317
317
- ✅ searchFunction: Surcharge the search function provided by the search client.
318
318
- ✅ initialUiState: Determine the search state on app start.
319
319
- ✅ onStateChange: Change search state on change (see option above).
320
320
- ✅ stalledSearchDelay: Time in ms before search is considered stalled. [Used for loader](https://www.algolia.com/doc/guides/building-search-ui/going-further/improve-performance/js/#using-the-searchbox).
321
321
- ✅ routing: browser URL synchronization, search parameters appear in current URL ([guide](https://www.algolia.com/doc/guides/building-search-ui/going-further/routing-urls/js/)).
@@ -513,7 +513,7 @@ The `highlight` function returns an attribute from a hit into its highlighted fo
513
513
- ✅ hit: Hit object. _required_
514
514
- ✅ highlightedTagName: HTML element to wrap the highlighted parts of the string.
515
515
516
-
See [Hits](#hits) for an example.
516
+
See [Hits](#-hits) for an example.
517
517
518
518
### ✅ Snippet
519
519
@@ -525,7 +525,7 @@ The `snippet` function returns an attribute from a hit into its snippet form, wh
525
525
- ✅ hit: Hit object. _required_
526
526
- ✅ highlightedTagName: HTML element to wrap the highlighted parts of the string.
527
527
528
-
Note that the attribute has to be added to `attributesToSnippet` in [configuration](#configuration). Highlight is applied on snippeted fields.
528
+
Note that the attribute has to be added to `attributesToSnippet` in [configuration](#-configure). Highlight is applied on snippeted fields.
529
529
530
530
Snippeting is called `cropping` in Meilisearch, [more about it here](https://docs.meilisearch.com/reference/features/search_parameters.html#attributes-to-retrieve). It is possible to change the size of the snippeting by adding its character size in the attributesToSnippet parameter. <br>
0 commit comments