@raycast/api 1.38.1 → 1.38.2

package/api.d.ts

@@ -4851,10 +4851,25 @@ declare interface ItemProps_2 extends ActionsInterface {
 }
 
 declare interface ItemProps_3 {
+    /**
+     * The main title displayed for this item.
+     */
     title: string;
+    /**
+     * An optional icon for this item.
+     */
     icon?: Image.ImageLike;
+    /**
+     * A tooltip to display when the cursor hovers the item.
+     */
     tooltip?: string;
+    /**
+     * An action handler called when the user clicks the item.
+     */
     onAction?: () => void;
+    /**
+     * A shortcut used to invoke this item when its parent menu is open.
+     */
     shortcut?: Keyboard.Shortcut;
 }
 
@@ -5495,12 +5510,25 @@ declare interface MenuBarExtraMembers {
 
 declare interface MenuBarExtraProps {
     /**
+     * Indicates to Raycast that it should not unload the command, as it is still executing. If you set make use of `isLoading`, you need to make sure you set it to `false` at the end of the task you are executing (such as an API call), so Raycast can then unload the command.
      * @defaultValue `false`
      */
     isLoading?: boolean;
+    /**
+     * The string that is displayed in the menu bar.
+     */
     title?: string;
+    /**
+     * A tooltip to display when the cursor hovers the item in the menu bar.
+     */
     tooltip?: string;
+    /**
+     * The icon that is displayed in the menu bar.
+     */
     icon?: Image.ImageLike;
+    /**
+     * `MenuBarExtra.Item`s, `MenuBarExtra.Submenu`s, `MenuBarExtra.Separator` or a mix of either.
+     */
     children?: ReactNode;
 }
 
@@ -6710,11 +6738,17 @@ declare interface SubmenuProps {
 }
 
 declare interface SubmenuProps_2 {
-    title: string | {
-        value: string;
-        tooltip: string;
-    };
+    /**
+     * The main title displayed for this submenu.
+     */
+    title: string;
+    /**
+     * An optional icon for this submenu.
+     */
     icon?: Image.ImageLike;
+    /**
+     * `MenuBarExtra.Item`s, `MenuBarExtra.Submenu`s, `MenuBarExtra.Separator` or a mix of either.
+     */
     children?: ReactNode;
 }
 

package/package.json

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

package/types/index.d.ts

@@ -4851,10 +4851,25 @@ declare interface ItemProps_2 extends ActionsInterface {
 }
 
 declare interface ItemProps_3 {
+    /**
+     * The main title displayed for this item.
+     */
     title: string;
+    /**
+     * An optional icon for this item.
+     */
     icon?: Image.ImageLike;
+    /**
+     * A tooltip to display when the cursor hovers the item.
+     */
     tooltip?: string;
+    /**
+     * An action handler called when the user clicks the item.
+     */
     onAction?: () => void;
+    /**
+     * A shortcut used to invoke this item when its parent menu is open.
+     */
     shortcut?: Keyboard.Shortcut;
 }
 
@@ -5495,12 +5510,25 @@ declare interface MenuBarExtraMembers {
 
 declare interface MenuBarExtraProps {
     /**
+     * Indicates to Raycast that it should not unload the command, as it is still executing. If you set make use of `isLoading`, you need to make sure you set it to `false` at the end of the task you are executing (such as an API call), so Raycast can then unload the command.
      * @defaultValue `false`
      */
     isLoading?: boolean;
+    /**
+     * The string that is displayed in the menu bar.
+     */
     title?: string;
+    /**
+     * A tooltip to display when the cursor hovers the item in the menu bar.
+     */
     tooltip?: string;
+    /**
+     * The icon that is displayed in the menu bar.
+     */
     icon?: Image.ImageLike;
+    /**
+     * `MenuBarExtra.Item`s, `MenuBarExtra.Submenu`s, `MenuBarExtra.Separator` or a mix of either.
+     */
     children?: ReactNode;
 }
 
@@ -6710,11 +6738,17 @@ declare interface SubmenuProps {
 }
 
 declare interface SubmenuProps_2 {
-    title: string | {
-        value: string;
-        tooltip: string;
-    };
+    /**
+     * The main title displayed for this submenu.
+     */
+    title: string;
+    /**
+     * An optional icon for this submenu.
+     */
     icon?: Image.ImageLike;
+    /**
+     * `MenuBarExtra.Item`s, `MenuBarExtra.Submenu`s, `MenuBarExtra.Separator` or a mix of either.
+     */
     children?: ReactNode;
 }