@docsearch/react 4.0.0-beta.5 → 4.0.0-beta.7

package/dist/esm/index.d.ts

@@ -140,31 +140,101 @@ type DocSearchAskAi = {
     };
 };
 interface DocSearchProps {
+    /**
+     * Algolia application id used by the search client.
+     */
     appId: string;
+    /**
+     * Public api key with search permissions for the index.
+     */
     apiKey: string;
+    /**
+     * Name of the algolia index to query.
+     */
     indexName: string;
+    /**
+     * Configuration or assistant id to enable ask ai mode. Pass a string assistant id or a full config object.
+     */
     askAi?: DocSearchAskAi | string;
+    /**
+     * Theme overrides applied to the modal and related components.
+     */
     theme?: DocSearchTheme;
+    /**
+     * Placeholder text for the search input.
+     */
     placeholder?: string;
+    /**
+     * Additional algolia search parameters to merge into each query.
+     */
     searchParameters?: SearchParamsObject;
+    /**
+     * Maximum number of hits to display per source/group.
+     */
     maxResultsPerGroup?: number;
+    /**
+     * Hook to post-process hits before rendering.
+     */
     transformItems?: (items: DocSearchHit[]) => DocSearchHit[];
+    /**
+     * Custom component to render an individual hit.
+     */
     hitComponent?: (props: {
         hit: InternalDocSearchHit | StoredDocSearchHit;
         children: React.ReactNode;
     }) => JSX.Element;
+    /**
+     * Custom component rendered at the bottom of the results panel.
+     */
     resultsFooterComponent?: (props: {
         state: AutocompleteState<InternalDocSearchHit>;
     }) => JSX.Element | null;
+    /**
+     * Hook to wrap or modify the algolia search client.
+     */
     transformSearchClient?: (searchClient: DocSearchTransformClient) => DocSearchTransformClient;
+    /**
+     * Disable storage and usage of recent and favorite searches.
+     */
     disableUserPersonalization?: boolean;
+    /**
+     * Query string to prefill when opening the modal.
+     */
     initialQuery?: string;
+    /**
+     * Custom navigator for controlling link navigation.
+     */
     navigator?: AutocompleteOptions<InternalDocSearchHit>['navigator'];
+    /**
+     * Localized strings for the button and modal ui.
+     */
     translations?: DocSearchTranslations;
+    /**
+     * Builds a url to report missing results for a given query.
+     */
     getMissingResultsUrl?: ({ query }: {
         query: string;
     }) => string;
+    /**
+     * Insights client integration options to send analytics events.
+     */
     insights?: AutocompleteOptions<InternalDocSearchHit>['insights'];
+    /**
+     * The container element where the modal should be portaled to. Defaults to document.body.
+     */
+    portalContainer?: DocumentFragment | Element;
+    /**
+     * Limit of how many recent searches should be saved/displayed..
+     *
+     * @default 7
+     */
+    recentSearchesLimit?: number;
+    /**
+     * Limit of how many recent searches should be saved/displayed when there are favorited searches..
+     *
+     * @default 4
+     */
+    recentSearchesWithFavoritesLimit?: number;
 }
 declare function DocSearch({ ...props }: DocSearchProps): JSX.Element;
 
@@ -284,7 +354,7 @@ type DocSearchModalProps = DocSearchProps & {
     canHandleAskAi?: boolean;
     translations?: ModalTranslations;
 };
-declare function DocSearchModal({ appId, apiKey, indexName, placeholder, askAi, searchParameters, maxResultsPerGroup, theme, onClose, transformItems, hitComponent, resultsFooterComponent, navigator, initialScrollY, transformSearchClient, disableUserPersonalization, initialQuery: initialQueryFromProp, translations, getMissingResultsUrl, insights, onAskAiToggle, isAskAiActive, canHandleAskAi, }: DocSearchModalProps): JSX.Element;
+declare function DocSearchModal({ appId, apiKey, indexName, placeholder, askAi, searchParameters, maxResultsPerGroup, theme, onClose, transformItems, hitComponent, resultsFooterComponent, navigator, initialScrollY, transformSearchClient, disableUserPersonalization, initialQuery: initialQueryFromProp, translations, getMissingResultsUrl, insights, onAskAiToggle, isAskAiActive, canHandleAskAi, recentSearchesLimit, recentSearchesWithFavoritesLimit, }: DocSearchModalProps): JSX.Element;
 
 interface UseDocSearchKeyboardEventsProps {
     isOpen: boolean;
@@ -297,6 +367,7 @@ interface UseDocSearchKeyboardEventsProps {
 }
 declare function useDocSearchKeyboardEvents({ isOpen, onOpen, onClose, onInput, isAskAiActive, onAskAiToggle, searchButtonRef, }: UseDocSearchKeyboardEventsProps): void;
 
-declare const version = "4.0.0-beta.5";
+declare const version = "4.0.0-beta.7";
 
-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 };
+export { DocSearch, DocSearchButton, DocSearchModal, useDocSearchKeyboardEvents, version };
+export type { ButtonTranslations, DocSearchAskAi, DocSearchButtonProps, DocSearchHit, DocSearchModalProps, DocSearchProps, DocSearchState, DocSearchTheme, DocSearchTransformClient, DocSearchTranslations, InternalDocSearchHit, ModalTranslations, StoredAskAiMessage, StoredAskAiState, StoredDocSearchHit, UseDocSearchKeyboardEventsProps };