Spectrum Components API

Schema version: 6.0.0

Standard dialog

Standard dialogs display important information that users need to acknowledge. They appear over the interface and block further interactions until an action is selected.

PropertyValuesDefault valueRequired
title
text
-
description
text
-
hide image
yes / no
Optional image to display in dialog.
no
size
s / m / l
m
hide close button
yes / no
no
footer content
text
Optional footer content to display in the dialog footer like a checkbox.
-
primary action label
text
-
secondary action label
text
If undefined, this button does not appear.
-
cancel action label
text
If undefined, this button does not appear.
-
{
  "slug": "standard-dialog",
  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/standard-dialog.json",
  "title": "Standard dialog",
  "description": "Standard dialogs display important information that users need to acknowledge. They appear over the interface and block further interactions until an action is selected.",
  "meta": {
    "category": "feedback",
    "documentationUrl": "https://spectrum.adobe.com/page/standard-dialog/"
  },
  "type": "object",
  "properties": {
    "title": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "hideImage": {
      "type": "boolean",
      "default": false,
      "description": "Optional image to display in dialog."
    },
    "size": {
      "type": "string",
      "enum": [
        "s",
        "m",
        "l"
      ],
      "default": "m"
    },
    "hideCloseButton": {
      "type": "boolean",
      "default": false
    },
    "footerContent": {
      "type": "string",
      "description": "Optional footer content to display in the dialog footer like a checkbox."
    },
    "primaryActionLabel": {
      "type": "string"
    },
    "secondaryActionLabel": {
      "type": "string",
      "description": "If undefined, this button does not appear."
    },
    "cancelActionLabel": {
      "type": "string",
      "default": "cancel",
      "description": "If undefined, this button does not appear."
    }
  }
}
← Back to home