Skip to content

Commit a4e4546

Browse files
Merge #702
702: Add table of content for instant meilisearch customization r=bidoubiwa a=bidoubiwa Co-authored-by: Charlotte Vermandel <[email protected]>
2 parents 3a88387 + a637dc4 commit a4e4546

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,15 @@ const searchClient = instantMeiliSearch(
7676

7777
## 💅 Customization
7878

79-
InstantMeilisearch offers some options you can set to further fit your needs.
79+
`instant-meilisearch` offers some options you can set to further fit your needs.
80+
81+
- [`placeholderSearch`](#placeholder-search): Enable or disable placeholder search (default: `true`).
82+
- [`paginationTotalHits`](#pagination-total-hits): Maximum total number of hits to create a finite pagination (default: `200`).
83+
- [`primaryKey`](#primary-key): Specify the primary key of your documents (default `undefined`).
84+
- [`keepZeroFacets`](#keep-zero-facets): Show the facets value even when they have 0 matches (default `false`).
85+
86+
The options are added as the third parameter of the `instantMeilisearch` function.
8087

81-
The options are added as the third parameter of the `instantMeilisearch` function
8288
```js
8389
import { instantMeiliSearch } from '@meilisearch/instant-meilisearch'
8490

@@ -126,7 +132,7 @@ Specify the field in your documents containing the [unique identifier](https://d
126132
{ primaryKey : 'id' } // default: undefined
127133
```
128134

129-
### keepZeroFacets
135+
### Keep zero facets
130136

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

0 commit comments

Comments
 (0)