Notice
A message the page announces without focus moving: a status (polite) or an alert (assertive, focusable). The live region is the element itself.
Demo: Alert
The form has two errors.
Property editor
Change a value and apply it; the demo renders with the new values. A refused value is reported at its field and the demo keeps the starting value.
Properties
| Property | Type | Default | Allowed values | Description |
|---|---|---|---|---|
kind | string | status | status, alert | status: role=status with aria-live=polite; alert: role=alert, focusable. |
text | string | required | One or two sentences, in the page's language. | |
id | string | none | Optional, for a script or a link to focus it. |
Events
This component sends no events.
Keyboard
This component has no keyboard behaviour of its own.
Accessibility
- The text is announced when it appears or changes; nothing else moves.
- The bar at the start (accent for a status, danger for an alert) is a second cue beside the role, never the only one.
Rationale
What the UI kit's Speech announces without focus moving, on the web: a live region. The kind is the role and a modifier class, so the colour of the bar at the start cannot say something else than the role does. An alert gets tabindex="-1" so a form can move focus to its error summary.
References
- Accessibility/Speech.cs
- forms-pipeline.md section 7
Uses
This component uses no other component.
Used by
No usages recorded yet.
README
notice
A message the page announces without focus moving: a status (polite live region: a form's answer) or an alert
(assertive, focusable with tabindex="-1": an error summary). The kind is the role and a modifier class.
- Callers: a site's hooks (the catalogue page of
examples/site); the form's answer and error summary when the form component lands (docs/architecture/forms-pipeline.md, section 7).
Change log
- 2026-10-14:
component.json(the manifest: the props now live there) anddemo.php(the demos the inspector and the catalogue page show) added; see docs/architecture/inspector.md. - 2026-10-14: new.