POLAR reference
    Preparing search index...

    Function useToastStore

    Plugin store for showing messages to the user.

    • Returns a store, creates it if necessary.

      Parameters

      • Optionalpinia: Pinia | null

        Pinia instance to retrieve the store

      • Optionalhot: StoreGeneric

        dev only hot module replacement

      Returns PiniaStore<useToastStore>

    Index

    Properties

    _instance addToast removeToast

    Properties

    _instance

    _instance: Pinia
    addToast: (toast: Toast, options?: ToastOptions) => void

    Shows a toast.

    If no timeout is given, the toast disappears after five seconds. Error toasts have no timeout by default. To disable the timeout, pass null explicitly.

    removeToast: (toast: Toast) => boolean

    Removes a toast.

    The exact object reference to the toast object passed to addToast is needed. A deep equal object will not work.

    If the toast was already removed, this method does nothing. If the toast has a connected timeout, it is canceled.

    Type Declaration

      • (toast: Toast): boolean

      • Parameters

        Returns boolean

        true if the toast could be found and removed, false otherwise

    Settings

    Member Visibility

    On This Page

    Properties