@vicinae/api
    Preparing search index...

    Interface Options

    The options to create a Toast.

    import { showToast, Toast } from "@raycast/api";

    export default async () => {
      const options: Toast.Options = {
        style: Toast.Style.Success,
        title: "Finished cooking",
        message: "Delicious pasta for lunch",
        primaryAction: {
          title: 'Do something',
          onAction: () => {
            console.log("The toast action has been triggered")
          }
        }
      };
      await showToast(options);
    };
    interface Options {
        message?: string;
        primaryAction?: Toast.ActionOptions;
        secondaryAction?: Toast.ActionOptions;
        style?: Style;
        title: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    message? primaryAction? secondaryAction? style? title

    Properties

    message?: string

    An additional message for the Toast. Useful to show more information, e.g. an identifier of a newly created asset.

    primaryAction?: Toast.ActionOptions

    The primary Action the user can take when hovering on the Toast.

    secondaryAction?: Toast.ActionOptions

    The secondary Action the user can take when hovering on the Toast.

    style?: Style

    The style of a Toast.

    title: string

    The title of a Toast. Displayed on the top.

    Settings

    Member Visibility

    On This Page

    Properties