@docsearch/js 5.0.0-beta.1 → 5.0.0-beta.3

package/README.md

@@ -34,7 +34,7 @@ import '@docsearch/css';
 docsearch({
   container: '#docsearch',
   appId: 'YOUR_APP_ID',
-  indexName: 'YOUR_INDEX_NAME',
+  indices: ['YOUR_INDEX_NAME'],
   apiKey: 'YOUR_SEARCH_API_KEY',
 });
 ```
@@ -53,7 +53,7 @@ import '@docsearch/css';
 docsearch({
   container: '#docsearch',
   appId: 'YOUR_APP_ID',
-  indexName: 'YOUR_INDEX_NAME',
+  indices: ['YOUR_INDEX_NAME'],
   apiKey: 'YOUR_SEARCH_API_KEY',
 });
 ```
@@ -66,7 +66,7 @@ For a standalone keyword-only script, load the explicit UMD file:
   window.docsearch({
     container: '#docsearch',
     appId: 'YOUR_APP_ID',
-    indexName: 'YOUR_INDEX_NAME',
+    indices: ['YOUR_INDEX_NAME'],
     apiKey: 'YOUR_SEARCH_API_KEY',
   });
 </script>

package/dist/esm/docsearch.d.ts

@@ -1,6 +1,6 @@
-/*! @docsearch/js 5.0.0-beta.1 (UNRELEASED cc75f9a) | MIT License | © Algolia, Inc. and contributors | https://docsearch.algolia.com */
-import { DocSearchProps as DocSearchProps$1 } from "@docsearch/react";
+/*! @docsearch/js 5.0.0-beta.3 (UNRELEASED b044250) | MIT License | © Algolia, Inc. and contributors | https://docsearch.algolia.com */
 import { InitialAskAiMessage } from "@docsearch/core";
+import { DocSearchProps as DocSearchProps$1, HitComponentProps, ResultsFooterComponentProps } from "@docsearch/react";
 //#region ../../node_modules/.bun/preact@11.0.0-beta.0/node_modules/preact/src/index.d.ts
 import JSX = JSXInternal;
 //#endregion
@@ -19,18 +19,49 @@ interface DocSearchCallbacks {
   onClose?: () => void;
   interceptAskAiEvent?: (initialMessage: InitialAskAiMessage) => boolean | void;
 }
-type DocSearchProps$2<TProps> = DocSearchCallbacks & Omit<TProps, 'onSidepanelClose' | 'onSidepanelOpen'> & {
+type TemplateHelpers = {
+  html: typeof html;
+};
+type TemplateFnReturnType = JSX.Element | string | (() => JSX.Element) | null;
+type HitComponentFn = (props: HitComponentProps, helpers: TemplateHelpers) => TemplateFnReturnType;
+type ResultsFooterComponentFn = (props: ResultsFooterComponentProps, helpers: TemplateHelpers) => TemplateFnReturnType;
+type FooterActionFn = (props: never, helpers: TemplateHelpers) => TemplateFnReturnType;
+type DocSearchProps$2<TProps> = DocSearchCallbacks & Omit<TProps, 'onSidepanelClose' | 'onSidepanelOpen' | 'hitComponent' | 'resultsFooterComponent' | 'footerAction'> & {
   container: HTMLElement | string;
   environment?: typeof window;
+  /**
+   * Custom component to render an individual hit. Supports template patterns:
+   *
+   * - HTML strings with html helper: (props, { html }) => html`<div>...</div>`
+   * - JSX templates: (props) => <div>...</div>
+   * - Function-based templates: (props) => string | JSX.Element | Function.
+   */
+  hitComponent?: HitComponentFn;
+  /**
+   * Custom component rendered at the bottom of the results panel. Supports
+   * template patterns:
+   *
+   * - HTML strings with html helper: (props, { html }) => html`<div>...</div>`
+   * - JSX templates: (props) => <div>...</div>
+   * - Function-based templates: (props) => string | JSX.Element | Function.
+   */
+  resultsFooterComponent?: ResultsFooterComponentFn;
+  /**
+   * A custom action that can be rendered in the Modal's footer before the
+   * Algolia logo. The component will be rendered as a child of `<div
+   * className="DocSearch-Footer-Action" />`. Supports template patterns:
+   *
+   * - HTML strings with html helper: (props, { html }) => html`<div>...</div>`
+   * - JSX templates: (props) => <div>...</div>
+   * - Function-based templates: (props) => string | JSX.Element | Function.
+   */
+  footerAction?: FooterActionFn;
 };
 declare const html: (strings: TemplateStringsArray, ...values: unknown[]) => JSX.Element;
-type TemplateHelpers = Record<string, unknown> & {
-  html: typeof html;
-};
 //#endregion
 //#region src/docsearchComponent.d.ts
 type DocSearchProps = DocSearchProps$2<DocSearchProps$1>;
 declare const docsearch: (allProps: DocSearchProps) => DocSearchInstance;
 //#endregion
-export { type DocSearchCallbacks, type DocSearchInstance, type DocSearchProps, type TemplateHelpers, docsearch as default };
+export { type DocSearchCallbacks, type DocSearchInstance, type DocSearchProps, type FooterActionFn, type HitComponentFn, type ResultsFooterComponentFn, type TemplateHelpers, docsearch as default };
 //# sourceMappingURL=docsearch.d.ts.map