@docsearch/react 4.4.0 → 4.5.0-beta.0

package/dist/esm/Sidepanel.d.ts

@@ -1,4 +1,5 @@
-import { SidepanelShortcuts, InitialAskAiMessage, DocSearchTheme } from '@docsearch/core';
+import { SidepanelShortcuts, InitialAskAiMessage, DocSearchCallbacks, DocSearchTheme, DocSearchRef } from '@docsearch/core';
+export { DocSearchCallbacks, DocSearchRef } from '@docsearch/core';
 import React, { JSX } from 'react';
 
 type AskAiSearchParameters = {
@@ -122,6 +123,19 @@ type HeaderTranslations = Partial<{
     viewConversationHistoryText: string;
 }>;
 
+/**
+ * Imperative handle exposed by the Sidepanel component for programmatic control.
+ */
+interface SidepanelRef {
+    /** Opens the sidepanel. */
+    open: () => void;
+    /** Closes the sidepanel. */
+    close: () => void;
+    /** Returns true once the component is mounted and ready. */
+    readonly isReady: boolean;
+    /** Returns true if the sidepanel is currently open. */
+    readonly isOpen: boolean;
+}
 type SidepanelTranslations = Partial<{
     /**
      * Translation texts for the Sidepanel header.
@@ -200,14 +214,14 @@ type SidepanelProps = {
      * @default `{ 'Ctrl/Cmd+I': true }`
      */
     keyboardShortcuts?: SidepanelShortcuts;
+    useStagingEnv?: boolean;
 };
-type Props$1 = Omit<DocSearchSidepanelProps, 'button' | 'panel'> & SidepanelProps & {
+declare const Sidepanel: React.ForwardRefExoticComponent<Omit<DocSearchSidepanelProps, "button" | "panel"> & SidepanelProps & {
     isOpen?: boolean;
     onOpen: () => void;
     onClose: () => void;
     initialMessage?: InitialAskAiMessage;
-};
-declare const Sidepanel: ({ isOpen, onOpen, onClose, assistantId, apiKey, appId, indexName, variant, searchParameters, pushSelector, width, expandedWidth, suggestedQuestions: suggestedQuestionsEnabled, translations, keyboardShortcuts, side, initialMessage, }: Props$1) => JSX.Element;
+} & React.RefAttributes<SidepanelRef>>;
 
 type SidepanelButtonTranslations = Partial<{
     /**
@@ -248,7 +262,7 @@ type SidepanelButtonProps = {
 type Props = React.ComponentProps<'button'> & SidepanelButtonProps;
 declare const SidepanelButton: ({ variant, keyboardShortcuts, translations, ...props }: Props) => JSX.Element;
 
-type DocSearchSidepanelProps = {
+type DocSearchSidepanelProps = DocSearchCallbacks & {
     /**
      * The assistant ID to use for the ask AI feature.
      */
@@ -290,7 +304,48 @@ type DocSearchSidepanelProps = {
      */
     panel?: Omit<SidepanelProps, 'keyboardShortcuts'>;
 };
-declare function DocSearchSidepanel({ keyboardShortcuts, theme, ...props }: DocSearchSidepanelProps): JSX.Element;
+declare const DocSearchSidepanel: React.ForwardRefExoticComponent<DocSearchCallbacks & {
+    /**
+     * The assistant ID to use for the ask AI feature.
+     */
+    assistantId: string;
+    /**
+     * Public api key with search permissions for the index.
+     */
+    apiKey: string;
+    /**
+     * Algolia application id used by the search client.
+     */
+    appId: string;
+    /**
+     * The index name to use for the ask AI feature. Your assistant will search this index for relevant documents.
+     */
+    indexName: string;
+    /**
+     * The search parameters to use for the ask AI feature.
+     */
+    searchParameters?: AskAiSearchParameters;
+    /**
+     * Configuration for keyboard shortcuts. Allows enabling/disabling specific shortcuts.
+     *
+     * @default `{ 'Ctrl/Cmd+I': true }`
+     */
+    keyboardShortcuts?: SidepanelShortcuts;
+    /**
+     * Theme overrides applied to the Sidepanel button and panel.
+     *
+     * @default 'light'
+     */
+    theme?: DocSearchTheme;
+    /**
+     * Props specific to the Sidepanel button.
+     */
+    button?: Omit<SidepanelButtonProps, "keyboardShortcuts">;
+    /**
+     * Props specific to the Sidepanel panel.
+     */
+    panel?: Omit<SidepanelProps, "keyboardShortcuts">;
+} & React.RefAttributes<DocSearchRef>>;
 
 export { DocSearchSidepanel, Sidepanel, SidepanelButton };
-export type { ButtonVariant, DocSearchSidepanelProps, SidepanelButtonProps, SidepanelButtonTranslations, SidepanelProps, SidepanelTranslations };
+export type { ButtonVariant, DocSearchSidepanelProps, SidepanelButtonProps, SidepanelButtonTranslations, SidepanelProps, SidepanelRef, SidepanelTranslations };