Skip to main content AWT

Notification

A notification, shown inline or as a toast. Screen readers announce it. Color is never the only signal of its status.

Live example

These are real Notification blocks rendering on this page right now. Tab to them and try them in both color schemes.

Information: Scheduled maintenance Sunday 02:00 to 04:00 UTC.

Success: Changes saved Your changes are live.

Warning: Storage almost full 92 percent used.

Information: Scheduled maintenance Sunday 02:00 to 04:00 UTC.

Success: Changes saved Your changes are live.

Warning: Storage almost full 92 percent used.

Information: Toast title Auto-dismissing message.

Just now

Information: Persistent No dismiss control.

Dark mode you don’t have to build

Every block supports dark mode. Use the light/dark toggle in the header and the live example above switches with it.

Parameters

Everything the Notification block accepts. Setting is the label you see in the block’s settings panel. Parameter is what the same value is called in code. Accepts is what you can put in it.

Notification block parameters
SettingParameterTypeDefaultAcceptsWhat it does
Kindkindstring“info”info, success, warning, errorThe status this notification communicates. Screen readers hear it before the title, for example “Warning:”.
Typed on the blocktitlestring“Notification”Any textThe bold lead text.
Typed on the blocksubtitlestringemptyAny textThe detail after the title.
Typed on the blockcaptionstringemptyAny textSmall extra text, shown only in the toast variant.
Low contrastlowContrastbooleanfalsetrue or falseThe tinted style instead of the solid dark one.
Hide close buttonhideCloseButtonbooleanfalsetrue or falseRemoves the dismiss button.
Variantvariantstring“inline”inline, toastInline sits in the content flow; toast is styled for corner placement.

Accessibility parameters, on this and every AWT block

Every AWT block has an Accessibility panel in its settings. Each control in it becomes a real HTML attribute on the block’s outer element:

Accessibility parameters shared by every AWT block
SettingParameterWhat it does
Accessible name (aria-label)ariaLabelBecomes aria-label on the block’s outer element. Replaces the accessible name screen readers announce. Set it only when the visible label is not enough.
Described by (aria-describedby)ariaDescribedbyBecomes aria-describedby. Point it at the ID of another element on the page whose text adds a longer description.
Labelled by (aria-labelledby)ariaLabelledbyBecomes aria-labelledby. Point it at the ID of another element whose text should become this block’s accessible name.
RoleawtRoleBecomes the role attribute. Overrides the element’s ARIA role. The list offers only roles that suit the element.
Language (lang)awtLangBecomes the lang attribute. Set it when this block’s content is in a different language from the page, as a BCP-47 code like “fr”.