@docsearch/sidepanel-js 4.4.0 → 4.5.0-beta.0

package/dist/esm/index.d.ts

@@ -1,3 +1,9 @@
+type InitialAskAiMessage = {
+    query: string;
+    messageId?: string;
+    suggestedQuestionId?: string;
+};
+
 interface SidepanelShortcuts {
     /**
      * Enable/disable the Ctrl/Cmd+I shortcut to toggle the DocSearch sidepanel.
@@ -290,11 +296,37 @@ type DocSearchSidepanelProps = {
     panel?: Omit<SidepanelProps$1, 'keyboardShortcuts'>;
 };
 
-type SidepanelProps = DocSearchSidepanelProps & {
+/**
+ * Instance returned by sidepanel() for programmatic control.
+ */
+interface SidepanelInstance {
+    /** Returns true once the component is mounted and ready. */
+    readonly isReady: boolean;
+    /** Returns true if the sidepanel is currently open. */
+    readonly isOpen: boolean;
+    /** Opens the sidepanel, optionally with an initial message. */
+    open(initialMessage?: InitialAskAiMessage): void;
+    /** Closes the sidepanel. */
+    close(): void;
+    /** Unmounts the Sidepanel component and cleans up. */
+    destroy(): void;
+}
+/**
+ * Lifecycle callbacks for the Sidepanel instance.
+ */
+interface SidepanelCallbacks {
+    /** Called once Sidepanel is mounted and ready for interaction. */
+    onReady?: () => void;
+    /** Called when the sidepanel opens. */
+    onOpen?: () => void;
+    /** Called when the sidepanel closes. */
+    onClose?: () => void;
+}
+type SidepanelProps = DocSearchSidepanelProps & SidepanelCallbacks & {
     container: HTMLElement | string;
     environment?: typeof window;
 };
-declare function sidepanel(props: SidepanelProps): () => void;
+declare function sidepanel(props: SidepanelProps): SidepanelInstance;
 
 export { sidepanel as default };
-export type { SidepanelProps };
+export type { SidepanelCallbacks, SidepanelInstance, SidepanelProps };