From 066539c2c91c3559dcf3a738c8c998693a02465c Mon Sep 17 00:00:00 2001 From: Shane Afsar Date: Thu, 25 May 2023 16:16:04 -0400 Subject: [PATCH] docs(api): add maxResultsPerGroup (#1897) --- packages/website/docs/api.mdx | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/packages/website/docs/api.mdx b/packages/website/docs/api.mdx index 866b7459..92769c57 100644 --- a/packages/website/docs/api.mdx +++ b/packages/website/docs/api.mdx @@ -319,6 +319,34 @@ docsearch({ +## `maxResultsPerGroup` + +> `type: number` | **optional** + +The maximum number of results to display per search group. Default is 5. + +[You can find a working example without JSX in this sandbox](https://codesandbox.io/s/docsearch-v3-maxresultspergroup-without-jsx-ct9m22?file=/src/index.js) + + + + +```js +docsearch({ + // ... + maxResultsPerGroup: 7, +}); +``` + + + + + [1]: https://www.algolia.com/doc/ui-libraries/autocomplete/introduction/what-is-autocomplete/ [2]: https://github.com/algolia/docsearch/ [3]: https://github.com/algolia/docsearch/tree/master