Documentation

Documentation / @zerotal/flow / index / FlashOptions

Interface: FlashOptions

Defined in: flow/src/Component.ts:179

Options accepted by this.flash(message, options) — the object form of the fluent builder, for when config is computed dynamically. type is an alias for level (Tailwind/Notyf parlance).

Properties

level?

optional level?: "error" | "success" | "warning" | "info"

Defined in: flow/src/Component.ts:180

type?

optional type?: "error" | "success" | "warning" | "info"

Defined in: flow/src/Component.ts:182

Alias for level.

title?

optional title?: string

Defined in: flow/src/Component.ts:183

position?

optional position?: FlashPosition

Defined in: flow/src/Component.ts:184

duration?

optional duration?: number

Defined in: flow/src/Component.ts:186

Auto-dismiss after N ms. 0 keeps the toast until dismissed.

dismissible?

optional dismissible?: boolean

Defined in: flow/src/Component.ts:187

icon?

optional icon?: string | false

Defined in: flow/src/Component.ts:189

Custom icon (emoji/text), or false to hide the status icon.

progressBar?

optional progressBar?: boolean

Defined in: flow/src/Component.ts:190

actions?

optional actions?: FlashAction[]

Defined in: flow/src/Component.ts:192

Action buttons that each invoke a @expose method on click.

onClose?

optional onClose?: FlashCallback

Defined in: flow/src/Component.ts:194

A @expose method invoked when the toast is dismissed.