Skip to content

Commit 297d9a6

Browse files
committed
Add table of content for instant meilisearch customization
1 parent eb465f2 commit 297d9a6

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,13 @@ const searchClient = instantMeiliSearch(
7878

7979
InstantMeilisearch offers some options you can set to further fit your needs.
8080

81+
### Customization
82+
83+
- [`placeholderSearch`]((#placeholder-search)): Enable or disable placeholder search (default: `true`).
84+
- [`paginationTotalHits`](#pagination-total-hits): Maximum total number of hits to create a finite pagination (default: `200`).
85+
- [`primaryKey`](#primary-key): Specify the primary key of your documents (default `undefined`).
86+
- [`keepZeroFacets`](#keep-zero-facets): Show the facets value even when they have 0 matches (default `false`).
87+
8188
The options are added as the third parameter of the `instantMeilisearch` function
8289
```js
8390
import { instantMeiliSearch } from '@meilisearch/instant-meilisearch'
@@ -126,7 +133,7 @@ Specify the field in your documents containing the [unique identifier](https://d
126133
{ primaryKey : 'id' } // default: undefined
127134
```
128135

129-
### keepZeroFacets
136+
### Keep zero facets
130137

131138
`keepZeroFacets` set to `true` keeps the facets even when they have 0 matching documents (default `false`).
132139

0 commit comments

Comments
 (0)