Skip to content

An open source design system that's fully customizable and agent ready

TypeScript

docs(banner): backfill two missing dense best-practice bullets (#5142)

Joey7e0512d456d8
diff --git a/packages/core/src/Banner/Banner.doc.mjs b/packages/core/src/Banner/Banner.doc.mjs
index 3ae109892c..cc707820c7 100644
--- a/packages/core/src/Banner/Banner.doc.mjs
+++ b/packages/core/src/Banner/Banner.doc.mjs
@@ -221,6 +221,8 @@ export const docsDense = {
{guidance: true, description: 'Keep titles short: "Payment failed" not "There was a problem processing your payment."'},
{guidance: false, description: 'Use for auto-dismissing messages; use Toast instead.'},
{guidance: false, description: 'Stack multiple banners of the same status; combine into one.'},
+ {guidance: true, description: 'Error/warning render role="alert", info/success role="status"; mount an alert banner on an event, not first paint, so assistive tech announces it.'},
+ {guidance: false, description: 'Rely on status color or icon alone; state the status in the title text, since the icon is decorative to a screen reader.'},
],
anatomy: [
{name: 'Icon', required: true, description: 'Set automatically from status.'},