Message
Imperative global message notifications with support for types, custom duration, and manual dismissal.
Basic usage
Four types
Example
Custom duration
Custom duration
Example
Manual close
Manual close
Example
Clear all
Clear all
Example
Grouped messages
Messages with the same group merge into a single one; repeated triggers increment the count (×n). Different groups are independent.
Grouped messages
Example
Updating messages
Tag a message with key, then update its content/type via message.update(key, options) and close it via message.destroy(key).
Updating messages
Example
API
Methods
| Method | Description |
|---|---|
message.info(content, duration?) / message.info(content, options?) | Info message, returns { close } |
message.success(content, duration?) / message.success(content, options?) | Success message, returns { close } |
message.warning(content, duration?) / message.warning(content, options?) | Warning message, returns { close } |
message.error(content, duration?) / message.error(content, options?) | Error message, returns { close } |
message.update(key, { content, type?, duration? }) | Update content/type of an existing message; creates a new one if the key does not exist |
message.destroy(key) | Close the message identified by key |
destroyAllMessage() | Clear all messages |
Attributes
| Attribute | Description | Type | Default |
|---|---|---|---|
count | Merge count (shows ×n after content when > 1) | string | 0 |
duration | Auto-close duration (ms), 0 to keep open | string | 3000 |
group | Group id: messages in the same group merge into one | — | — |
key | Unique id: used by message.update / message.destroy | — | — |
type | Message type: info/success/warning/error | string | info |
Events
| Event | Description |
|---|---|
oas-close | Emitted when the message closes (auto-close / close button / destroy), detail: { key? } |
options:{ duration?, group?, key?, onClose? }.groupmerges messages into one and increments the count;keyis used byupdate/destroy;onClosefires when the message closes.durationdefaults to3000ms; pass0to keep the message open.- When a message closes (auto-close / close button /
destroy),oas-closeis emitted withdetail: { key? }. - Stacked and centered at the top;
errorusesrole="alert", others userole="status".