@raycast/api 1.27.1 → 1.28.0

package/types/api/components/actions/OpenAction.d.ts

@@ -0,0 +1,47 @@
+import { ReactElement } from "react";
+import { Application, Keyboard } from "../../app";
+import { Image } from "../../ui";
+/**
+ * See {@link Action.Open.Props}
+ */
+export interface OpenActionProps {
+    /**
+     * The file, folder or URL to open.
+     */
+    target: string;
+    /**
+     * The application name to use for opening the file.
+     *
+     * @remarks
+     * If no application is specified, the default application as determined by the system is used to open the
+     * specified file. Note that you can use the application name, app identifier, or absolute path to the app.
+     */
+    application?: Application | string;
+    /**
+     * The title for the action.
+     */
+    title: string;
+    /**
+     * The icon displayed for the action.
+     * @defaultValue {@link Icon.Finder}
+     */
+    icon?: Image.ImageLike;
+    /**
+     * The keyboard shortcut for the action.
+     */
+    shortcut?: Keyboard.Shortcut;
+    /**
+     * Callback when the file or folder was opened.
+     *
+     * @remarks
+     * This is handy when you want to act on an opened file or folder, e.g. store a history of opened items.
+     */
+    onOpen?: (target: string) => void;
+}
+/**
+ * See {@link Action.Open}
+ */
+export declare function OpenAction(props: OpenActionProps): ReactElement<OpenActionProps>;
+export declare namespace OpenAction {
+    var displayName: string;
+}

package/types/api/components/actions/OpenInBrowserAction.d.ts

@@ -0,0 +1,42 @@
+import { ReactElement } from "react";
+import { Keyboard } from "../../app";
+import { Image } from "../../ui";
+/**
+ * See {@link Action.OpenInBrowser.Props}
+ */
+export interface OpenInBrowserActionProps {
+    /**
+     * The URL to open.
+     */
+    url: string;
+    /**
+     * An optional title for the action.
+     */
+    title?: string;
+    /**
+     * The icon displayed for the action.
+     * @defaultValue {@link Icon.Globe}
+     */
+    icon?: Image.ImageLike;
+    /**
+     * The optional keyboard shortcut for the menu item
+     */
+    shortcut?: Keyboard.Shortcut;
+    /**
+     * Callback when the URL was opened in the browser.
+     *
+     * @remarks
+     * This is handy when you want to act on the opened link, e.g. store a history of visited links.
+     */
+    onOpen?: (url: string) => void;
+}
+/**
+ * See {@link Action.OpenInBrowser}
+ */
+export declare function OpenInBrowserAction(props: OpenInBrowserActionProps): ReactElement<OpenInBrowserActionProps>;
+export declare namespace OpenInBrowserAction {
+    var displayName: string;
+}
+export declare namespace OpenInBrowserAction {
+    type Props = OpenInBrowserActionProps;
+}

package/types/api/components/actions/OpenWithAction.d.ts

@@ -0,0 +1,40 @@
+import { ReactElement } from "react";
+import { Keyboard } from "../../app";
+import { Image } from "../../ui";
+/**
+ * See {@link Action.OpenWith.Props}
+ */
+export interface OpenWithActionProps {
+    /**
+     * The path to open.
+     */
+    path: string;
+    /**
+     * The title for the action.
+     * @defaultValue Open With
+     */
+    title?: string;
+    /**
+     * The icon displayed for the action.
+     * @defaultValue {@link Icon.Upload}
+     */
+    icon?: Image.ImageLike;
+    /**
+     * The keyboard shortcut for the action.
+     */
+    shortcut?: Keyboard.Shortcut;
+    /**
+     * Callback when the file or folder was opened.
+     *
+     * @remarks
+     * This is handy when you want to act on an opened file or folder, e.g. store a history of opened items.
+     */
+    onOpen?: (path: string) => void;
+}
+/**
+ * See {@link Action.OpenWith}
+ */
+export declare function OpenWithAction(props: OpenWithActionProps): ReactElement<OpenWithActionProps>;
+export declare namespace OpenWithAction {
+    var displayName: string;
+}

package/types/api/components/actions/PasteAction.d.ts

@@ -0,0 +1,39 @@
+import { ReactElement } from "react";
+import { Keyboard } from "../../app";
+import { Image } from "../../ui";
+/**
+ * See {@link Action.Paste.Props}
+ */
+export interface PasteActionProps {
+    /**
+     * The contents that will be written to the clipboard as string.
+     */
+    content: string | number;
+    /**
+     * An optional title for the action.
+     */
+    title?: string;
+    /**
+     * The icon displayed for the action.
+     * @defaultValue {@link Icon.Clipboard}
+     */
+    icon?: Image.ImageLike;
+    /**
+     * The keyboard shortcut for the action.
+     */
+    shortcut?: Keyboard.Shortcut;
+    /**
+     * Callback when the content was pasted into the front-most application.
+     *
+     * @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;
+}
+/**
+ * See {@link Action.Paste.Props}
+ */
+export declare function PasteAction(props: PasteActionProps): ReactElement<PasteActionProps>;
+export declare namespace PasteAction {
+    var displayName: string;
+}

package/types/api/components/actions/PushAction.d.ts

@@ -0,0 +1,38 @@
+import { ReactNode, ReactElement } from "react";
+import { Keyboard } from "../../app";
+import { Image } from "../../ui";
+/**
+ * See {@link Action.Push.Props}
+ */
+export interface PushActionProps {
+    /**
+     * The title displayed for the item.
+     */
+    title: string;
+    /**
+     * The target view that will be pushed to the navigation stack.
+     */
+    target: ReactNode;
+    /**
+     * The icon displayed for the action.
+     */
+    icon?: Image.ImageLike;
+    /**
+     * The keyboard shortcut for the action.
+     */
+    shortcut?: Keyboard.Shortcut;
+    /**
+     * Callback when the target view was pushed.
+     *
+     * @remarks
+     * This is handy when you want to act on the pushed target view, e.g. uprank a selected list item.
+     */
+    onPush?: () => void;
+}
+/**
+ * See {@link Action.Push.Props}
+ */
+export declare function PushAction(props: PushActionProps): ReactElement<PushActionProps>;
+export declare namespace PushAction {
+    var displayName: string;
+}

package/types/api/components/actions/ShowInFinderAction.d.ts

@@ -0,0 +1,42 @@
+/// <reference types="node" />
+import { PathLike } from "fs";
+import { ReactElement } from "react";
+import { Image } from "../../ui";
+import { Keyboard } from "../../app";
+/**
+ * See {@link Action.ShowInFinder.Props}
+ */
+export interface ShowInFinderActionProps {
+    /**
+     * The path to open.
+     */
+    path: PathLike;
+    /**
+     * An optional title for the action.
+     * @defaultValue Show in Finder
+     */
+    title?: string;
+    /**
+     * A optional icon displayed for the item.
+     * @defaultValue {@link Icon.Finder}
+     */
+    icon?: Image.ImageLike;
+    /**
+     * The keyboard shortcut for the action.
+     */
+    shortcut?: Keyboard.Shortcut;
+    /**
+     * Callback when the file or folder was shown in the Finder.
+     *
+     * @remarks
+     * This is handy when you want to act on revealed files or folders, e.g. up-rank recently opened items.
+     */
+    onShow?: (path: PathLike) => void;
+}
+/**
+ * See {@link Action.ShowInFinder.Props}
+ */
+export declare function ShowInFinderAction(props: ShowInFinderActionProps): ReactElement<ShowInFinderActionProps>;
+export declare namespace ShowInFinderAction {
+    var displayName: string;
+}

package/types/api/components/actions/SubmitFormAction.d.ts

@@ -0,0 +1,34 @@
+import { ReactElement } from "react";
+import { Keyboard } from "../../app";
+import { Image } from "../../ui";
+import type { Form } from "../Form";
+/**
+ * See {@link Action.SubmitForm.Props}
+ */
+export interface SubmitFormActionProps<Values> {
+    /**
+     * The title displayed for the item.
+     */
+    title?: string;
+    /**
+     * The icon displayed for the action.
+     */
+    icon?: Image.ImageLike;
+    /**
+     * The keyboard shortcut for the action.
+     */
+    shortcut?: Keyboard.Shortcut;
+    /**
+     * Callback that is triggered when the submit was submitted.
+     * Use the handler to perform custom validation logic and call other Raycast API methods.
+     * The handler receives a the values object containing the user input.
+     */
+    onSubmit?: (input: Values) => void;
+}
+/**
+ * See {@link Action.SubmitForm.Props}
+ */
+export declare function SubmitFormAction<Values extends Form.Values = Form.Values>(props: SubmitFormActionProps<Values>): ReactElement<SubmitFormActionProps<Values>>;
+export declare namespace SubmitFormAction {
+    var displayName: string;
+}

package/types/api/components/actions/TrashAction.d.ts

@@ -0,0 +1,43 @@
+/// <reference types="node" />
+import { PathLike } from "fs";
+import { ReactElement } from "react";
+import { Image } from "../../ui";
+import { Keyboard } from "../../app";
+/**
+ * See {@link Action.Trash.Props}
+ */
+export interface TrashActionProps {
+    /**
+     * The item or items to move to the trash.
+     */
+    paths: PathLike | PathLike[];
+    /**
+     * An optional title for the action.
+     * @defaultValue Move to Trash
+     */
+    title?: string;
+    /**
+     * A optional icon displayed for the action.
+     * @defaultValue {@link Icon.Trash}
+     */
+    icon?: Image.ImageLike;
+    /**
+     * The optional keyboard shortcut for the action.
+     */
+    shortcut?: Keyboard.Shortcut;
+    /**
+     * Callback when all items were moved to the trash.
+     *
+     * @remarks
+     * This is handy when you want to act on a trashed item, e.g. update a list.
+     * The callback returns the same `paths` as passed originally.
+     */
+    onTrash?: (paths: PathLike | PathLike[]) => void;
+}
+/**
+ * See {@link Action.Trash}
+ */
+export declare function TrashAction(props: TrashActionProps): ReactElement<TrashActionProps>;
+export declare namespace TrashAction {
+    var displayName: string;
+}

package/types/api/components/actions/index.d.ts

@@ -0,0 +1 @@
+export * from "./Action";

package/types/api/components/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./ActionPanel";
+export * from "./Detail";
+export * from "./Form";
+export * from "./List";
+export * from "./actions";

package/types/api/components/propTypes.d.ts

@@ -0,0 +1 @@
+export {};

package/types/api/components/types.d.ts

@@ -0,0 +1,30 @@
+import { ReactNode } from "react";
+/**
+ * Views that can be embedded in a navigation stack, show a navigation title and support a loading bar.
+ * @category User Interface
+ */
+export interface NavigationChildInterface {
+    /**
+     *
+     * The main title for that view displayed in Raycast
+     *
+     * @defaultValue Command title
+     */
+    navigationTitle?: string;
+    /**
+     * Indicates whether a loading bar should be shown or hidden below the search bar
+     *
+     * @defaultValue false
+     */
+    isLoading?: boolean;
+}
+/**
+ * Components that support an Action Panel.
+ * @category User Interface
+ */
+export interface ActionsInterface {
+    /**
+     * A reference to an {@link ActionPanel}.
+     */
+    actions?: ReactNode;
+}