@raycast/api 1.43.2 → 1.44.0

package/api.d.ts

@@ -732,7 +732,7 @@ export declare namespace Clipboard {
      * };
      * ```
      */
-    export function copy(content: string | Content): Promise<void>;
+    export function copy(content: string | number | Content): Promise<void>;
     /**
      * Clears the current clipboard contents.
      *
@@ -763,7 +763,7 @@ export declare namespace Clipboard {
      * };
      * ```
      */
-    export function paste(content: string | Content): Promise<void>;
+    export function paste(content: string | number | Content): Promise<void>;
     /**
      * Reads the clipboard as plain text.
      *
@@ -804,19 +804,26 @@ export declare namespace Clipboard {
     } | {
         /**
          * The file representation of the content.
-         *
-         * @remarks
-         * At the moment only file paths represented as a string are supported.
          */
         file: PathLike;
+    } | {
+        /**
+         * The HTML representation of the content.
+         */
+        html: string;
+        /**
+         * The alternative text representation of the content.
+         */
+        text?: string;
     };
 }
 
 /**
  * Closes the main Raycast window.
  *
- * @param options - Can be used to clear the root search. Defaults to not clearing the root search after
- * the window was closed.
+ * @param options - A parameter object with the properties:
+ * `clearRootSearch`: clears the text in the root search bar and scrolls to the top; default is `false`
+ * `popToRootType`: defines the pop to root behavior ({@link PopToRootType}); the default is to to respect the user's "Pop to Root Search" preference in Raycast
  * @returns A Promise that resolves when the main window is closed.
  *
  * @example
@@ -832,6 +839,7 @@ export declare namespace Clipboard {
  */
 export declare function closeMainWindow(options?: {
     clearRootSearch?: boolean;
+    popToRootType?: PopToRootType;
 }): Promise<void>;
 
 /**
@@ -1313,9 +1321,9 @@ export declare interface CopyToClipboardActionProps extends Action.CopyToClipboa
  */
 declare interface CopyToClipboardProps {
     /**
-     * The contents that will be written to the clipboard as string.
+     * The contents that will be copied to the clipboard.
      */
-    content: string | number;
+    content: string | number | Clipboard.Content;
     /**
      * An optional title for the action.
      * @defaultValue `"Copy to Clipboard"`
@@ -1336,7 +1344,7 @@ declare interface CopyToClipboardProps {
      * @remarks
      * This is handy when you want to act on the copied content, e.g. up-rank recently copied content.
      */
-    onCopy?: (content: string | number) => void;
+    onCopy?: (content: string | number | Clipboard.Content) => void;
 }
 
 /**
@@ -1878,14 +1886,14 @@ declare interface DropdownMembers_2 {
 /**
  * See {@link Form.Dropdown.Props}
  */
-declare interface DropdownProps extends FormItemProps_2<string> {
+declare interface DropdownProps extends FormItemProps_2<string>, SearchBarInterface {
     /**
      * Sections or items. If {@link Form.Dropdown.Item} elements are specified, a default section is automatically created.
      */
     children?: ReactNode;
 }
 
-declare interface DropdownProps_2 {
+declare interface DropdownProps_2 extends SearchBarInterface {
     /**
      * ID of the dropdown.
      */
@@ -2032,6 +2040,10 @@ export declare interface Environment {
      * The theme used by the Raycast application.
      */
     theme: "light" | "dark";
+    /**
+     * The text size used by the Raycast application.
+     */
+    textSize: "medium" | "large";
     /**
      * The type of launch for the command (user initiated or background).
      */
@@ -3762,6 +3774,23 @@ export declare function getApplications(path?: PathLike): Promise<Application[]>
  */
 export declare function getDefaultApplication(path: PathLike): Promise<Application>;
 
+/**
+ * Returns the frontmost application.
+ *
+ * @returns The frontmost {@link Application}. Throws an error if no application was found.
+ *
+ * @example
+ * ```typescript
+ * import { getFrontmostApplication } from "@raycast/api";
+ *
+ * export default async () => {
+ *   const frontmostApplication = await getFrontmostApplication();
+ *   console.log(`The frontmost application is: ${frontmostApplication.name}`);
+ * };
+ * ```
+ */
+export declare function getFrontmostApplication(): Promise<Application>;
+
 /**
  * @deprecated Use {@link LocalStorage.getItem} instead
  */
@@ -4138,7 +4167,7 @@ declare interface GridMembers {
     Dropdown: typeof Dropdown_2;
 }
 
-declare interface GridProps extends ActionsInterface, NavigationChildInterface {
+declare interface GridProps extends ActionsInterface, NavigationChildInterface, SearchBarInterface {
     /**
      * A reference to an {@link ActionPanel}. It will only be shown when there aren't any children.
      */
@@ -4198,19 +4227,6 @@ declare interface GridProps extends ActionsInterface, NavigationChildInterface {
      * @defaultValue `false` when `onSearchTextChange` is specified, `true` otherwise.
      */
     enableFiltering?: boolean;
-    /**
-     * Toggles Raycast filtering. When `true`, Raycast will use the query in the search bar to filter the
-     * items. When `false`, the extension needs to take care of the filtering.
-     *
-     * You can further define how native filtering orders grid sections by setting an object with a `keepSectionOrder` property:
-     * When `true`, ensures that Raycast filtering maintains the section order as defined in the extension.
-     * When `false`, filtering may change the section order depending on the ranking values of the items.
-     *
-     * @defaultValue `false` when `onSearchTextChange` is specified, `true` otherwise.
-     */
-    filtering?: boolean | {
-        keepSectionOrder: boolean;
-    };
     /**
      * Placeholder text that will be shown in the search bar.
      *
@@ -4221,19 +4237,6 @@ declare interface GridProps extends ActionsInterface, NavigationChildInterface {
      * Selects the item with the specified id.
      */
     selectedItemId?: string;
-    /**
-     * Defines whether the {@link Grid.Props.onSearchTextChange} will be triggered on every keyboard press or with a delay for throttling the events.
-     * Recommended to set to `true` when using custom filtering logic with asynchronous operations (e.g. network requests).
-     * @defaultValue `false`
-     */
-    throttle?: boolean;
-    /**
-     * Callback triggered when the search bar text changes.
-     *
-     * @remarks
-     * Specifying this implicitly toggles `filtering` to false. To enable native filtering when using `onSearchTextChange`, explicitly set `filtering` to true.
-     */
-    onSearchTextChange?: (text: string) => void;
 }
 
 /**
@@ -5567,7 +5570,7 @@ declare interface ListMembers {
 export declare interface ListProps extends List.Props {
 }
 
-declare interface ListProps_2 extends ActionsInterface, NavigationChildInterface {
+declare interface ListProps_2 extends ActionsInterface, NavigationChildInterface, SearchBarInterface {
     /**
      * A reference to an {@link ActionPanel}. It will only be shown when there aren't any children.
      */
@@ -5602,19 +5605,6 @@ declare interface ListProps_2 extends ActionsInterface, NavigationChildInterface
      * @defaultValue `false` when `onSearchTextChange` is specified, `true` otherwise.
      */
     enableFiltering?: boolean;
-    /**
-     * Toggles Raycast filtering. When `true`, Raycast will use the query in the search bar to filter the
-     * items. When `false`, the extension needs to take care of the filtering.
-     *
-     * You can further define how native filtering orders list sections by setting an object with a `keepSectionOrder` property:
-     * When `true`, ensures that Raycast filtering maintains the section order as defined in the extension.
-     * When `false`, filtering may change the section order depending on the ranking values of list items.
-     *
-     * @defaultValue `false` when `onSearchTextChange` is specified, `true` otherwise.
-     */
-    filtering?: boolean | {
-        keepSectionOrder: boolean;
-    };
     /**
      * Placeholder text that will be shown in the search bar.
      *
@@ -5625,19 +5615,6 @@ declare interface ListProps_2 extends ActionsInterface, NavigationChildInterface
      * Selects the item with the specified id.
      */
     selectedItemId?: string;
-    /**
-     * Defines whether the {@link List.Props.onSearchTextChange} will be triggered on every keyboard press or with a delay for throttling the events.
-     * Recommended to set to `true` when using custom filtering logic with asynchronous operations (e.g. network requests).
-     * @defaultValue `false`
-     */
-    throttle?: boolean;
-    /**
-     * Callback triggered when the search bar text changes.
-     *
-     * @remarks
-     * Specifying this implicitly toggles `filtering` to false. To enable native filtering when using `onSearchTextChange`, explicitly set `filtering` to `true`.
-     */
-    onSearchTextChange?: (text: string) => void;
     /**
      * Whether the List should have an area on the right side of the items to show additional details about the selected item.
      *
@@ -6039,10 +6016,10 @@ export declare namespace OAuth {
              */
             providerName: string;
             /**
-             * An icon referenced from the assets folder, displayed in the OAuth overlay.
+             * An icon displayed in the OAuth overlay.
              * Make sure to provide at least a size of 64x64 pixels.
              */
-            providerIcon: string;
+            providerIcon?: Image.ImageLike;
             /**
              * An optional ID for associating the client with a provider.
              * Only set this if you use multiple different clients in your extension.
@@ -6074,7 +6051,7 @@ export declare namespace OAuth {
     export class PKCEClient {
         redirectMethod: RedirectMethod;
         providerName: string;
-        providerIcon: string;
+        providerIcon?: Image.ImageLike;
         providerId?: string;
         description?: string;
         private resolvesOnRedirect?;
@@ -6541,12 +6518,12 @@ export declare interface PasteActionProps extends Action.Paste.Props {
  */
 declare interface PasteProps {
     /**
-     * The contents that will be written to the clipboard as string.
+     * The contents that will be pasted to the frontmost application.
      */
-    content: string | number;
+    content: string | number | Clipboard.Content;
     /**
      * An optional title for the action.
-     * @defaultValue `"Paste in Active app"`
+     * @defaultValue `"Paste in Active App"`
      */
     title?: string;
     /**
@@ -6564,7 +6541,7 @@ declare interface PasteProps {
      * @remarks
      * This is handy when you want to act on the pasted content, e.g. up-rank recently pasted content.
      */
-    onPaste?: (content: string | number) => void;
+    onPaste?: (content: string | number | Clipboard.Content) => void;
 }
 
 /**
@@ -6599,6 +6576,24 @@ export declare function popToRoot(options?: {
     clearSearchBar?: boolean;
 }): Promise<void>;
 
+/**
+ * Defines the pop to root behavior when the main window is closed.
+ */
+export declare enum PopToRootType {
+    /**
+     * Respects the user's "Pop to Root Search" preference in Raycast
+     */
+    Default = "default",
+    /**
+     * Immediately pops back to root
+     */
+    Immediate = "immediate",
+    /**
+     * Prevents Raycast from popping back to root
+     */
+    Suspended = "suspended"
+}
+
 /**
  * @deprecated Use {@link getPreferenceValues} instead.
  */
@@ -6768,6 +6763,44 @@ export declare const removeLocalStorageItem: typeof LocalStorage.removeItem;
  */
 export declare const render: any;
 
+/**
+ * Views that support a search bar.
+ */
+declare interface SearchBarInterface {
+    /**
+     * Toggles Raycast filtering. When `true`, Raycast will use the query in the search bar to filter the
+     * items. When `false`, the extension needs to take care of the filtering.
+     *
+     * You can further define how native filtering orders sections by setting an object with a `keepSectionOrder` property:
+     * When `true`, ensures that Raycast filtering maintains the section order as defined in the extension.
+     * When `false`, filtering may change the section order depending on the ranking values of items.
+     *
+     * @defaultValue `false` when `onSearchTextChange` is specified, `true` otherwise.
+     */
+    filtering?: boolean | {
+        keepSectionOrder: boolean;
+    };
+    /**
+     * Indicates whether a loading indicator should be shown or hidden next to the search bar
+     *
+     * @defaultValue `false`
+     */
+    isLoading?: boolean;
+    /**
+     * Defines whether the `onSearchTextChange` handler will be triggered on every keyboard press or with a delay for throttling the events.
+     * Recommended to set to `true` when using custom filtering logic with asynchronous operations (e.g. network requests).
+     * @defaultValue `false`
+     */
+    throttle?: boolean;
+    /**
+     * Callback triggered when the search bar text changes.
+     *
+     * @remarks
+     * Specifying this implicitly toggles `filtering` to false. To enable native filtering when using `onSearchTextChange`, explicitly set `filtering` to true.
+     */
+    onSearchTextChange?: (text: string) => void;
+}
+
 /**
  * See {@link ActionPanel.Section}
  */
@@ -7066,7 +7099,7 @@ declare type SubmenuChildren = ReactElement<SectionProps> | ReactElement<Section
 /**
  * See {@link ActionPanel.Submenu.Props}.
  */
-declare interface SubmenuProps {
+declare interface SubmenuProps extends SearchBarInterface {
     /**
      * ID of the submenu.
      * @deprecated - This is an internal prop which should not have been exposed. You can safely remove it.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@raycast/api",
-  "version": "1.43.2",
+  "version": "1.44.0",
   "description": "Build extensions for Raycast with React and Node.js.",
   "author": "Raycast Technologies Ltd.",
   "homepage": "https://developers.raycast.com",

package/types/index.d.ts

@@ -732,7 +732,7 @@ export declare namespace Clipboard {
      * };
      * ```
      */
-    export function copy(content: string | Content): Promise<void>;
+    export function copy(content: string | number | Content): Promise<void>;
     /**
      * Clears the current clipboard contents.
      *
@@ -763,7 +763,7 @@ export declare namespace Clipboard {
      * };
      * ```
      */
-    export function paste(content: string | Content): Promise<void>;
+    export function paste(content: string | number | Content): Promise<void>;
     /**
      * Reads the clipboard as plain text.
      *
@@ -804,19 +804,26 @@ export declare namespace Clipboard {
     } | {
         /**
          * The file representation of the content.
-         *
-         * @remarks
-         * At the moment only file paths represented as a string are supported.
          */
         file: PathLike;
+    } | {
+        /**
+         * The HTML representation of the content.
+         */
+        html: string;
+        /**
+         * The alternative text representation of the content.
+         */
+        text?: string;
     };
 }
 
 /**
  * Closes the main Raycast window.
  *
- * @param options - Can be used to clear the root search. Defaults to not clearing the root search after
- * the window was closed.
+ * @param options - A parameter object with the properties:
+ * `clearRootSearch`: clears the text in the root search bar and scrolls to the top; default is `false`
+ * `popToRootType`: defines the pop to root behavior ({@link PopToRootType}); the default is to to respect the user's "Pop to Root Search" preference in Raycast
  * @returns A Promise that resolves when the main window is closed.
  *
  * @example
@@ -832,6 +839,7 @@ export declare namespace Clipboard {
  */
 export declare function closeMainWindow(options?: {
     clearRootSearch?: boolean;
+    popToRootType?: PopToRootType;
 }): Promise<void>;
 
 /**
@@ -1313,9 +1321,9 @@ export declare interface CopyToClipboardActionProps extends Action.CopyToClipboa
  */
 declare interface CopyToClipboardProps {
     /**
-     * The contents that will be written to the clipboard as string.
+     * The contents that will be copied to the clipboard.
      */
-    content: string | number;
+    content: string | number | Clipboard.Content;
     /**
      * An optional title for the action.
      * @defaultValue `"Copy to Clipboard"`
@@ -1336,7 +1344,7 @@ declare interface CopyToClipboardProps {
      * @remarks
      * This is handy when you want to act on the copied content, e.g. up-rank recently copied content.
      */
-    onCopy?: (content: string | number) => void;
+    onCopy?: (content: string | number | Clipboard.Content) => void;
 }
 
 /**
@@ -1878,14 +1886,14 @@ declare interface DropdownMembers_2 {
 /**
  * See {@link Form.Dropdown.Props}
  */
-declare interface DropdownProps extends FormItemProps_2<string> {
+declare interface DropdownProps extends FormItemProps_2<string>, SearchBarInterface {
     /**
      * Sections or items. If {@link Form.Dropdown.Item} elements are specified, a default section is automatically created.
      */
     children?: ReactNode;
 }
 
-declare interface DropdownProps_2 {
+declare interface DropdownProps_2 extends SearchBarInterface {
     /**
      * ID of the dropdown.
      */
@@ -2032,6 +2040,10 @@ export declare interface Environment {
      * The theme used by the Raycast application.
      */
     theme: "light" | "dark";
+    /**
+     * The text size used by the Raycast application.
+     */
+    textSize: "medium" | "large";
     /**
      * The type of launch for the command (user initiated or background).
      */
@@ -3762,6 +3774,23 @@ export declare function getApplications(path?: PathLike): Promise<Application[]>
  */
 export declare function getDefaultApplication(path: PathLike): Promise<Application>;
 
+/**
+ * Returns the frontmost application.
+ *
+ * @returns The frontmost {@link Application}. Throws an error if no application was found.
+ *
+ * @example
+ * ```typescript
+ * import { getFrontmostApplication } from "@raycast/api";
+ *
+ * export default async () => {
+ *   const frontmostApplication = await getFrontmostApplication();
+ *   console.log(`The frontmost application is: ${frontmostApplication.name}`);
+ * };
+ * ```
+ */
+export declare function getFrontmostApplication(): Promise<Application>;
+
 /**
  * @deprecated Use {@link LocalStorage.getItem} instead
  */
@@ -4138,7 +4167,7 @@ declare interface GridMembers {
     Dropdown: typeof Dropdown_2;
 }
 
-declare interface GridProps extends ActionsInterface, NavigationChildInterface {
+declare interface GridProps extends ActionsInterface, NavigationChildInterface, SearchBarInterface {
     /**
      * A reference to an {@link ActionPanel}. It will only be shown when there aren't any children.
      */
@@ -4198,19 +4227,6 @@ declare interface GridProps extends ActionsInterface, NavigationChildInterface {
      * @defaultValue `false` when `onSearchTextChange` is specified, `true` otherwise.
      */
     enableFiltering?: boolean;
-    /**
-     * Toggles Raycast filtering. When `true`, Raycast will use the query in the search bar to filter the
-     * items. When `false`, the extension needs to take care of the filtering.
-     *
-     * You can further define how native filtering orders grid sections by setting an object with a `keepSectionOrder` property:
-     * When `true`, ensures that Raycast filtering maintains the section order as defined in the extension.
-     * When `false`, filtering may change the section order depending on the ranking values of the items.
-     *
-     * @defaultValue `false` when `onSearchTextChange` is specified, `true` otherwise.
-     */
-    filtering?: boolean | {
-        keepSectionOrder: boolean;
-    };
     /**
      * Placeholder text that will be shown in the search bar.
      *
@@ -4221,19 +4237,6 @@ declare interface GridProps extends ActionsInterface, NavigationChildInterface {
      * Selects the item with the specified id.
      */
     selectedItemId?: string;
-    /**
-     * Defines whether the {@link Grid.Props.onSearchTextChange} will be triggered on every keyboard press or with a delay for throttling the events.
-     * Recommended to set to `true` when using custom filtering logic with asynchronous operations (e.g. network requests).
-     * @defaultValue `false`
-     */
-    throttle?: boolean;
-    /**
-     * Callback triggered when the search bar text changes.
-     *
-     * @remarks
-     * Specifying this implicitly toggles `filtering` to false. To enable native filtering when using `onSearchTextChange`, explicitly set `filtering` to true.
-     */
-    onSearchTextChange?: (text: string) => void;
 }
 
 /**
@@ -5567,7 +5570,7 @@ declare interface ListMembers {
 export declare interface ListProps extends List.Props {
 }
 
-declare interface ListProps_2 extends ActionsInterface, NavigationChildInterface {
+declare interface ListProps_2 extends ActionsInterface, NavigationChildInterface, SearchBarInterface {
     /**
      * A reference to an {@link ActionPanel}. It will only be shown when there aren't any children.
      */
@@ -5602,19 +5605,6 @@ declare interface ListProps_2 extends ActionsInterface, NavigationChildInterface
      * @defaultValue `false` when `onSearchTextChange` is specified, `true` otherwise.
      */
     enableFiltering?: boolean;
-    /**
-     * Toggles Raycast filtering. When `true`, Raycast will use the query in the search bar to filter the
-     * items. When `false`, the extension needs to take care of the filtering.
-     *
-     * You can further define how native filtering orders list sections by setting an object with a `keepSectionOrder` property:
-     * When `true`, ensures that Raycast filtering maintains the section order as defined in the extension.
-     * When `false`, filtering may change the section order depending on the ranking values of list items.
-     *
-     * @defaultValue `false` when `onSearchTextChange` is specified, `true` otherwise.
-     */
-    filtering?: boolean | {
-        keepSectionOrder: boolean;
-    };
     /**
      * Placeholder text that will be shown in the search bar.
      *
@@ -5625,19 +5615,6 @@ declare interface ListProps_2 extends ActionsInterface, NavigationChildInterface
      * Selects the item with the specified id.
      */
     selectedItemId?: string;
-    /**
-     * Defines whether the {@link List.Props.onSearchTextChange} will be triggered on every keyboard press or with a delay for throttling the events.
-     * Recommended to set to `true` when using custom filtering logic with asynchronous operations (e.g. network requests).
-     * @defaultValue `false`
-     */
-    throttle?: boolean;
-    /**
-     * Callback triggered when the search bar text changes.
-     *
-     * @remarks
-     * Specifying this implicitly toggles `filtering` to false. To enable native filtering when using `onSearchTextChange`, explicitly set `filtering` to `true`.
-     */
-    onSearchTextChange?: (text: string) => void;
     /**
      * Whether the List should have an area on the right side of the items to show additional details about the selected item.
      *
@@ -6039,10 +6016,10 @@ export declare namespace OAuth {
              */
             providerName: string;
             /**
-             * An icon referenced from the assets folder, displayed in the OAuth overlay.
+             * An icon displayed in the OAuth overlay.
              * Make sure to provide at least a size of 64x64 pixels.
              */
-            providerIcon: string;
+            providerIcon?: Image.ImageLike;
             /**
              * An optional ID for associating the client with a provider.
              * Only set this if you use multiple different clients in your extension.
@@ -6074,7 +6051,7 @@ export declare namespace OAuth {
     export class PKCEClient {
         redirectMethod: RedirectMethod;
         providerName: string;
-        providerIcon: string;
+        providerIcon?: Image.ImageLike;
         providerId?: string;
         description?: string;
         private resolvesOnRedirect?;
@@ -6541,12 +6518,12 @@ export declare interface PasteActionProps extends Action.Paste.Props {
  */
 declare interface PasteProps {
     /**
-     * The contents that will be written to the clipboard as string.
+     * The contents that will be pasted to the frontmost application.
      */
-    content: string | number;
+    content: string | number | Clipboard.Content;
     /**
      * An optional title for the action.
-     * @defaultValue `"Paste in Active app"`
+     * @defaultValue `"Paste in Active App"`
      */
     title?: string;
     /**
@@ -6564,7 +6541,7 @@ declare interface PasteProps {
      * @remarks
      * This is handy when you want to act on the pasted content, e.g. up-rank recently pasted content.
      */
-    onPaste?: (content: string | number) => void;
+    onPaste?: (content: string | number | Clipboard.Content) => void;
 }
 
 /**
@@ -6599,6 +6576,24 @@ export declare function popToRoot(options?: {
     clearSearchBar?: boolean;
 }): Promise<void>;
 
+/**
+ * Defines the pop to root behavior when the main window is closed.
+ */
+export declare enum PopToRootType {
+    /**
+     * Respects the user's "Pop to Root Search" preference in Raycast
+     */
+    Default = "default",
+    /**
+     * Immediately pops back to root
+     */
+    Immediate = "immediate",
+    /**
+     * Prevents Raycast from popping back to root
+     */
+    Suspended = "suspended"
+}
+
 /**
  * @deprecated Use {@link getPreferenceValues} instead.
  */
@@ -6768,6 +6763,44 @@ export declare const removeLocalStorageItem: typeof LocalStorage.removeItem;
  */
 export declare const render: any;
 
+/**
+ * Views that support a search bar.
+ */
+declare interface SearchBarInterface {
+    /**
+     * Toggles Raycast filtering. When `true`, Raycast will use the query in the search bar to filter the
+     * items. When `false`, the extension needs to take care of the filtering.
+     *
+     * You can further define how native filtering orders sections by setting an object with a `keepSectionOrder` property:
+     * When `true`, ensures that Raycast filtering maintains the section order as defined in the extension.
+     * When `false`, filtering may change the section order depending on the ranking values of items.
+     *
+     * @defaultValue `false` when `onSearchTextChange` is specified, `true` otherwise.
+     */
+    filtering?: boolean | {
+        keepSectionOrder: boolean;
+    };
+    /**
+     * Indicates whether a loading indicator should be shown or hidden next to the search bar
+     *
+     * @defaultValue `false`
+     */
+    isLoading?: boolean;
+    /**
+     * Defines whether the `onSearchTextChange` handler will be triggered on every keyboard press or with a delay for throttling the events.
+     * Recommended to set to `true` when using custom filtering logic with asynchronous operations (e.g. network requests).
+     * @defaultValue `false`
+     */
+    throttle?: boolean;
+    /**
+     * Callback triggered when the search bar text changes.
+     *
+     * @remarks
+     * Specifying this implicitly toggles `filtering` to false. To enable native filtering when using `onSearchTextChange`, explicitly set `filtering` to true.
+     */
+    onSearchTextChange?: (text: string) => void;
+}
+
 /**
  * See {@link ActionPanel.Section}
  */
@@ -7066,7 +7099,7 @@ declare type SubmenuChildren = ReactElement<SectionProps> | ReactElement<Section
 /**
  * See {@link ActionPanel.Submenu.Props}.
  */
-declare interface SubmenuProps {
+declare interface SubmenuProps extends SearchBarInterface {
     /**
      * ID of the submenu.
      * @deprecated - This is an internal prop which should not have been exposed. You can safely remove it.