Mixins / foldkit-mixins-ui

ToastInput

interface · packages/mixins-ui/src/toast.ts:229

interface ToastInput {
  readonly type?: Type | undefined
  readonly title: string
  readonly description?: string | undefined
  readonly actions?: ReadonlyArray<Action> | undefined
  readonly cancel?: string | undefined
  readonly duration?: number | 'sticky' | undefined
}

What a toast says, for show and settle.

Members

ToastInput.type

property · packages/mixins-ui/src/toast.ts:231

readonly type?: Type | undefined

Default 'default'.

ToastInput.title

property · packages/mixins-ui/src/toast.ts:232

readonly title: string

ToastInput.description

property · packages/mixins-ui/src/toast.ts:233

readonly description?: string | undefined

ToastInput.actions

property · packages/mixins-ui/src/toast.ts:235

readonly actions?: ReadonlyArray<Action> | undefined

Buttons that answer it, each dismissing it and saying its value in Acted.

ToastInput.cancel

property · packages/mixins-ui/src/toast.ts:237

readonly cancel?: string | undefined

The words of a button that only dismisses it, after the actions.

ToastInput.duration

property · packages/mixins-ui/src/toast.ts:242

readonly duration?: number | 'sticky' | undefined

Milliseconds it shows for, or 'sticky' to wait for a dismissal. Default the stack's duration, and sticky for a loading toast.