PXD

useMessage

Creates and dispatches toast/message notifications via custom events.

Exports

function useMessage(msg: MessageContent, options?: Options): void

function closeMessage(group?: string, id?: string | number): void
function clearMessage(group?: string): void

Types

type MessageContent = string | VNode

interface Options {
  id?: string | number
  type?: 'info' | 'success' | 'warning' | 'error' | 'loading'
  class?: ComponentClass
  group?: string
  action?: Action
  message?: string | VNode
  promise?: Promise<unknown>
  durations?: number
  closeable?: boolean
  error?: PromiseMessageHandler
  success?: PromiseMessageHandler
  finally?: PromiseMessageHandler
}

Params

NameTypeDescription
msgMessageContentThe message content
options.idstring | numberUnique identifier for the message
options.type'info' | 'success' | 'warning' | 'error' | 'loading'Message type
options.groupstringMessage group identifier
options.actionActionAction configuration for the message
options.messagestring | VNodeThe message content (alternative to msg)
options.promisePromise<unknown>Promise that triggers message lifecycle
options.durationsnumberDisplay duration in milliseconds
options.closeablebooleanWhether the message is closeable
options.errorPromiseMessageHandlerHandler for promise rejection
options.successPromiseMessageHandlerHandler for promise resolution
options.finallyPromiseMessageHandlerHandler for promise settlement

Source

Source