@docsearch/react 4.0.0-beta.1 → 4.0.0-beta.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/esm/index.d.ts +7 -1
- package/dist/esm/index.js +1 -1
- package/dist/umd/index.js +2 -2
- package/dist/umd/index.js.map +1 -1
- package/package.json +2 -3
package/README.md
CHANGED
|
@@ -5,15 +5,15 @@ React package for [DocSearch](http://docsearch.algolia.com/), the best search ex
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
yarn add @docsearch/react@
|
|
8
|
+
yarn add @docsearch/react@beta
|
|
9
9
|
# or
|
|
10
|
-
npm install @docsearch/react@
|
|
10
|
+
npm install @docsearch/react@beta
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
If you don’t want to use a package manager, you can use a standalone endpoint:
|
|
14
14
|
|
|
15
15
|
```html
|
|
16
|
-
<script src="https://cdn.jsdelivr.net/npm/@docsearch/react@
|
|
16
|
+
<script src="https://cdn.jsdelivr.net/npm/@docsearch/react@beta"></script>
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
## Get started
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -132,6 +132,12 @@ type DocSearchAskAi = {
|
|
|
132
132
|
* The assistant ID to use for the ask AI feature.
|
|
133
133
|
*/
|
|
134
134
|
assistantId: string | null;
|
|
135
|
+
/**
|
|
136
|
+
* The search parameters to use for the ask AI feature.
|
|
137
|
+
*/
|
|
138
|
+
searchParameters?: {
|
|
139
|
+
facetFilters?: SearchParamsObject['facetFilters'];
|
|
140
|
+
};
|
|
135
141
|
};
|
|
136
142
|
interface DocSearchProps {
|
|
137
143
|
appId: string;
|
|
@@ -291,6 +297,6 @@ interface UseDocSearchKeyboardEventsProps {
|
|
|
291
297
|
}
|
|
292
298
|
declare function useDocSearchKeyboardEvents({ isOpen, onOpen, onClose, onInput, isAskAiActive, onAskAiToggle, searchButtonRef, }: UseDocSearchKeyboardEventsProps): void;
|
|
293
299
|
|
|
294
|
-
declare const version = "4.0.0-beta.
|
|
300
|
+
declare const version = "4.0.0-beta.3";
|
|
295
301
|
|
|
296
302
|
export { type ButtonTranslations, DocSearch, type DocSearchAskAi, DocSearchButton, type DocSearchButtonProps, type DocSearchHit, DocSearchModal, type DocSearchModalProps, type DocSearchProps, type DocSearchState, type DocSearchTheme, type DocSearchTransformClient, type DocSearchTranslations, type InternalDocSearchHit, type ModalTranslations, type StoredAskAiMessage, type StoredAskAiState, type StoredDocSearchHit, type UseDocSearchKeyboardEventsProps, useDocSearchKeyboardEvents, version };
|