Spectrum Components API

Schema version: 6.0.0

Alert banner

Alert banners show pressing and high-signal messages, such as system alerts. They're meant to be noticed and prompt users to take action.

PropertyValuesDefault valueRequired
text
text
-
variant
neutral / informative / negative / accent
neutral
action label
text
If undefined, this button does not appear.
-
is dismissible
yes / no
no
{
  "slug": "alert-banner",
  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/alert-banner.json",
  "title": "Alert banner",
  "description": "Alert banners show pressing and high-signal messages, such as system alerts. They're meant to be noticed and prompt users to take action.",
  "meta": {
    "category": "feedback",
    "documentationUrl": "https://spectrum.adobe.com/page/alert-banner/"
  },
  "type": "object",
  "properties": {
    "text": {
      "type": "string"
    },
    "variant": {
      "type": "string",
      "enum": [
        "neutral",
        "informative",
        "negative",
        "accent"
      ],
      "default": "neutral"
    },
    "actionLabel": {
      "type": "string",
      "description": "If undefined, this button does not appear."
    },
    "isDismissible": {
      "type": "boolean",
      "default": false
    }
  }
}
← Back to home