@adobe/design-data-spec 0.3.0 → 0.5.0

package/components/checkbox.json

@@ -0,0 +1,303 @@
+{
+  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/v0/component.schema.json",
+  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/v0/components/checkbox.json",
+  "specVersion": "1.0.0-draft",
+  "name": "checkbox",
+  "displayName": "Checkbox",
+  "description": "Checkboxes allow users to select multiple items from a list of individual items, or to mark one individual item as selected.",
+  "meta": {
+    "category": "inputs",
+    "documentationUrl": "https://spectrum.adobe.com/page/checkbox/"
+  },
+  "options": {
+    "label": {
+      "type": "string",
+      "description": "When the label is not defined, the checkbox appears as a standalone checkbox."
+    },
+    "isSelected": {
+      "type": "boolean",
+      "default": false
+    },
+    "isIndeterminate": {
+      "type": "boolean",
+      "default": false,
+      "description": "When a checkbox is indeterminate, it overrides the selection state."
+    },
+    "size": {
+      "type": "string",
+      "enum": ["s", "m", "l", "xl"],
+      "default": "m"
+    },
+    "isEmphasized": {
+      "type": "boolean",
+      "default": false
+    },
+    "isDisabled": {
+      "type": "boolean",
+      "default": false
+    },
+    "isError": {
+      "type": "boolean",
+      "default": false
+    }
+  },
+  "states": [
+    {
+      "name": "hover",
+      "trigger": "interaction"
+    },
+    {
+      "name": "down",
+      "trigger": "interaction"
+    },
+    {
+      "name": "keyboard-focus",
+      "trigger": "interaction"
+    }
+  ],
+  "lifecycle": {
+    "introduced": "1.0.0-draft"
+  },
+  "tokenBindings": [
+    {
+      "token": "checkbox-control-size-small",
+      "context": "S2 Control (size)"
+    },
+    {
+      "token": "checkbox-control-size-medium",
+      "context": "S2 Control (size)"
+    },
+    {
+      "token": "checkbox-control-size-large",
+      "context": "S2 Control (size)"
+    },
+    {
+      "token": "checkbox-control-size-extra-large",
+      "context": "S2 Control (size)"
+    },
+    {
+      "token": "checkbox-top-to-control-small",
+      "context": "S2 Spacing (top edge to control)"
+    },
+    {
+      "token": "checkbox-top-to-control-medium",
+      "context": "S2 Spacing (top edge to control)"
+    },
+    {
+      "token": "checkbox-top-to-control-large",
+      "context": "S2 Spacing (top edge to control)"
+    },
+    {
+      "token": "checkbox-top-to-control-extra-large",
+      "context": "S2 Spacing (top edge to control)"
+    },
+    {
+      "token": "neutral-background-color-selected-default",
+      "context": "S2 Control (selected, non emphasized)"
+    },
+    {
+      "token": "neutral-background-color-selected-hover",
+      "context": "S2 Control (selected, non emphasized)"
+    },
+    {
+      "token": "neutral-background-color-selected-key-focus",
+      "context": "S2 Control (selected, non emphasized)"
+    },
+    {
+      "token": "component-height-75",
+      "context": "Minimum height"
+    },
+    {
+      "token": "component-height-100",
+      "context": "Minimum height"
+    },
+    {
+      "token": "component-height-200",
+      "context": "Minimum height"
+    },
+    {
+      "token": "component-height-300",
+      "context": "Minimum height"
+    },
+    {
+      "token": "component-size-difference-down",
+      "context": "Component size (down)"
+    },
+    {
+      "token": "component-size-width-ratio-down",
+      "context": "Component size (down)"
+    },
+    {
+      "token": "component-size-minimum-perspective-down",
+      "context": "Component size (down)"
+    },
+    {
+      "token": "border-width-200",
+      "context": "Control (border)"
+    },
+    {
+      "token": "corner-radius-small-size-small",
+      "context": "Control (rounding)"
+    },
+    {
+      "token": "corner-radius-small-size-medium",
+      "context": "Control (rounding)"
+    },
+    {
+      "token": "corner-radius-small-size-large",
+      "context": "Control (rounding)"
+    },
+    {
+      "token": "corner-radius-small-size-extra-large",
+      "context": "Control (rounding)"
+    },
+    {
+      "token": "text-to-control-75",
+      "context": "Spacing (control to label)"
+    },
+    {
+      "token": "text-to-control-100",
+      "context": "Spacing (control to label)"
+    },
+    {
+      "token": "text-to-control-200",
+      "context": "Spacing (control to label)"
+    },
+    {
+      "token": "text-to-control-300",
+      "context": "Spacing (control to label)"
+    },
+    {
+      "token": "component-top-to-text-75",
+      "context": "Spacing (top/bottom edge to label)"
+    },
+    {
+      "token": "component-top-to-text-100",
+      "context": "Spacing (top/bottom edge to label)"
+    },
+    {
+      "token": "component-top-to-text-200",
+      "context": "Spacing (top/bottom edge to label)"
+    },
+    {
+      "token": "component-top-to-text-300",
+      "context": "Spacing (top/bottom edge to label)"
+    },
+    {
+      "token": "component-bottom-to-text-75",
+      "context": "Spacing (top/bottom edge to label)"
+    },
+    {
+      "token": "component-bottom-to-text-100",
+      "context": "Spacing (top/bottom edge to label)"
+    },
+    {
+      "token": "component-bottom-to-text-200",
+      "context": "Spacing (top/bottom edge to label)"
+    },
+    {
+      "token": "component-bottom-to-text-300",
+      "context": "Spacing (top/bottom edge to label)"
+    },
+    {
+      "token": "focus-indicator-thickness",
+      "context": "Focus ring"
+    },
+    {
+      "token": "focus-indicator-gap",
+      "context": "Focus ring"
+    },
+    {
+      "token": "spacing-300",
+      "context": "Checkbox group spacing (horizontal)"
+    },
+    {
+      "token": "neutral-content-color-default",
+      "context": "Label"
+    },
+    {
+      "token": "neutral-content-color-hover",
+      "context": "Label"
+    },
+    {
+      "token": "neutral-content-color-down",
+      "context": "Label"
+    },
+    {
+      "token": "neutral-content-color-key-focus",
+      "context": "Label"
+    },
+    {
+      "token": "gray-25",
+      "context": "Control"
+    },
+    {
+      "token": "accent-content-color-default",
+      "context": "Control (selected, emphasized)"
+    },
+    {
+      "token": "accent-content-color-hover",
+      "context": "Control (selected, emphasized)"
+    },
+    {
+      "token": "accent-content-color-down",
+      "context": "Control (selected, emphasized)"
+    },
+    {
+      "token": "accent-content-color-key-focus",
+      "context": "Control (selected, emphasized)"
+    },
+    {
+      "token": "disabled-content-color",
+      "context": "Label (disabled)"
+    },
+    {
+      "token": "focus-indicator-color",
+      "context": "Focus ring"
+    },
+    {
+      "token": "negative-color-900",
+      "context": "Checkbox colors"
+    },
+    {
+      "token": "negative-color-1000",
+      "context": "Checkbox colors"
+    },
+    {
+      "token": "default-font-family",
+      "context": "Label"
+    },
+    {
+      "token": "regular-font-weight",
+      "context": "Label"
+    },
+    {
+      "token": "default-font-style",
+      "context": "Label"
+    },
+    {
+      "token": "font-size-75",
+      "context": "Label"
+    },
+    {
+      "token": "font-size-100",
+      "context": "Label"
+    },
+    {
+      "token": "font-size-200",
+      "context": "Label"
+    },
+    {
+      "token": "font-size-300",
+      "context": "Label"
+    },
+    {
+      "token": "line-height-100",
+      "context": "Label"
+    },
+    {
+      "token": "cjk-line-height-100",
+      "context": "Label"
+    }
+  ]
+}

package/components/close-button.json

@@ -0,0 +1,170 @@
+{
+  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/v0/component.schema.json",
+  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/v0/components/close-button.json",
+  "specVersion": "1.0.0-draft",
+  "name": "close-button",
+  "displayName": "Close button",
+  "description": "The close button is used inside of other components, like a toast or an action bar, for closing or dismissing its parent component.",
+  "meta": {
+    "category": "actions",
+    "documentationUrl": "https://spectrum.adobe.com/page/close-button/"
+  },
+  "options": {
+    "size": {
+      "type": "string",
+      "enum": ["s", "m", "l", "xl"],
+      "default": "m"
+    },
+    "iconSize": {
+      "type": "string"
+    },
+    "staticColor": {
+      "type": "string",
+      "enum": ["white", "black"],
+      "description": "Static color must not be set for the default version of this component."
+    },
+    "isDisabled": {
+      "type": "boolean",
+      "default": false
+    }
+  },
+  "states": [
+    {
+      "name": "hover",
+      "trigger": "interaction"
+    },
+    {
+      "name": "down",
+      "trigger": "interaction"
+    },
+    {
+      "name": "keyboard-focus",
+      "trigger": "interaction"
+    }
+  ],
+  "lifecycle": {
+    "introduced": "1.0.0-draft"
+  },
+  "tokenBindings": [
+    {
+      "token": "component-height-75",
+      "context": "Button size"
+    },
+    {
+      "token": "component-height-100",
+      "context": "Button size"
+    },
+    {
+      "token": "component-height-200",
+      "context": "Button size"
+    },
+    {
+      "token": "component-height-300",
+      "context": "Button size"
+    },
+    {
+      "token": "component-size-difference-down",
+      "context": "Button size (down)"
+    },
+    {
+      "token": "component-size-width-ratio-down",
+      "context": "Button size (down)"
+    },
+    {
+      "token": "component-size-minimum-perspective-down",
+      "context": "Button size (down)"
+    },
+    {
+      "token": "cross-icon-size-200",
+      "context": "Cross icon size"
+    },
+    {
+      "token": "cross-icon-size-300",
+      "context": "Cross icon size"
+    },
+    {
+      "token": "cross-icon-size-400",
+      "context": "Cross icon size"
+    },
+    {
+      "token": "cross-icon-size-500",
+      "context": "Cross icon size"
+    },
+    {
+      "token": "focus-indicator-thickness",
+      "context": "Focus ring "
+    },
+    {
+      "token": "focus-indicator-gap",
+      "context": "Focus ring "
+    },
+    {
+      "token": "neutral-content-color-default",
+      "context": "Cross icon"
+    },
+    {
+      "token": "neutral-content-color-hover",
+      "context": "Cross icon"
+    },
+    {
+      "token": "neutral-content-color-down",
+      "context": "Cross icon"
+    },
+    {
+      "token": "neutral-content-color-key-focus",
+      "context": "Cross icon"
+    },
+    {
+      "token": "disabled-content-color",
+      "context": "Cross icon"
+    },
+    {
+      "token": "focus-indicator-color",
+      "context": "Focus ring"
+    },
+    {
+      "token": "gray-100",
+      "context": "Background "
+    },
+    {
+      "token": "transparent-white-800",
+      "context": "Cross icon (static white)"
+    },
+    {
+      "token": "transparent-white-900",
+      "context": "Cross icon (static white)"
+    },
+    {
+      "token": "disabled-static-white-background-color",
+      "context": "Cross icon (static white)"
+    },
+    {
+      "token": "static-white-focus-indicator-color",
+      "context": "Focus ring (static white)"
+    },
+    {
+      "token": "transparent-white-100",
+      "context": "Background (static white)"
+    },
+    {
+      "token": "transparent-black-800",
+      "context": "Cross icon (static black) "
+    },
+    {
+      "token": "transparent-black-900",
+      "context": "Cross icon (static black) "
+    },
+    {
+      "token": "disabled-static-black-background-color",
+      "context": "Cross icon (static black) "
+    },
+    {
+      "token": "static-black-focus-indicator-color",
+      "context": "Focus ring (static black) "
+    },
+    {
+      "token": "transparent-black-100",
+      "context": "Background (static black)"
+    }
+  ]
+}

package/components/coach-indicator.json

@@ -0,0 +1,76 @@
+{
+  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/v0/component.schema.json",
+  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/v0/components/coach-indicator.json",
+  "specVersion": "1.0.0-draft",
+  "name": "coach-indicator",
+  "displayName": "Coach indicator",
+  "description": "Coach indicators help guide users through interfaces by highlighting important areas or features during onboarding and feature discovery.",
+  "meta": {
+    "category": "feedback",
+    "documentationUrl": "https://spectrum.adobe.com/page/coach-indicator/"
+  },
+  "options": {
+    "cornerRounding": {
+      "type": "string",
+      "enum": [
+        "none",
+        "corner-radius-75",
+        "corner-radius-100",
+        "corner-radius-200",
+        "corner-radius-300",
+        "corner-radius-400",
+        "corner-radius-500",
+        "corner-radius-600",
+        "corner-radius-700",
+        "corner-radius-800",
+        "full"
+      ]
+    },
+    "staticColor": {
+      "type": "string",
+      "enum": ["white"],
+      "description": "If not set to white, the coach indicator uses the default color."
+    }
+  },
+  "lifecycle": {
+    "introduced": "1.0.0-draft"
+  },
+  "tokenBindings": [
+    {
+      "token": "coach-indicator-collapsed-ring-thickness",
+      "context": "Ring"
+    },
+    {
+      "token": "coach-indicator-expanded-ring-thickness",
+      "context": "Ring"
+    },
+    {
+      "token": "coach-indicator-collapsed-gap",
+      "context": "Ring"
+    },
+    {
+      "token": "coach-indicator-expanded-gap",
+      "context": "Ring"
+    },
+    {
+      "token": "coach-indicator-collapsed-ring-rounding-increment",
+      "context": "Rounding"
+    },
+    {
+      "token": "coach-indicator-expanded-ring-rounding-increment",
+      "context": "Rounding"
+    },
+    {
+      "token": "coach-indicator-color",
+      "context": "Indicator (Default)"
+    },
+    {
+      "token": "coach-indicator-opacity",
+      "context": "Indicator (Default)"
+    },
+    {
+      "token": "white",
+      "context": "Indicator (Static white)"
+    }
+  ]
+}

package/components/coach-mark.json

@@ -0,0 +1,157 @@
+{
+  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/v0/component.schema.json",
+  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/v0/components/coach-mark.json",
+  "specVersion": "1.0.0-draft",
+  "name": "coach-mark",
+  "displayName": "Coach mark",
+  "description": "Coach marks provide contextual guidance to users by highlighting specific interface elements.",
+  "meta": {
+    "category": "feedback",
+    "documentationUrl": "https://spectrum.adobe.com/page/coach-mark/"
+  },
+  "options": {
+    "title": {
+      "type": "string"
+    },
+    "description": {
+      "type": "string"
+    },
+    "hideImage": {
+      "type": "boolean",
+      "default": false,
+      "description": "Optional image to display in dialog."
+    },
+    "actions": {
+      "type": "object",
+      "description": "Configuration for coach mark actions.",
+      "properties": {
+        "topActionLabel": {
+          "type": "string",
+          "description": "Optional action button displayed at the top, often for a menu."
+        },
+        "footerContent": {
+          "type": "string",
+          "description": "Optional footer content to display in the dialog footer like a checkbox."
+        },
+        "primaryActionLabel": {
+          "type": "string",
+          "description": "Label for the primary footer action."
+        },
+        "secondaryActionLabel": {
+          "type": "string",
+          "description": "Label for the secondary footer action (optional)."
+        },
+        "cancelActionLabel": {
+          "type": "string",
+          "default": "cancel",
+          "description": "Label for the cancel action (optional)."
+        }
+      }
+    }
+  },
+  "lifecycle": {
+    "introduced": "1.0.0-draft"
+  },
+  "tokenBindings": [
+    {
+      "token": "coach-mark-width",
+      "context": "Width"
+    },
+    {
+      "token": "coach-mark-minimum-width",
+      "context": "Width"
+    },
+    {
+      "token": "coach-mark-maximum-width",
+      "context": "Width"
+    },
+    {
+      "token": "coach-mark-edge-to-content",
+      "context": "Spacing (top/bottom/start/end edge to text)"
+    },
+    {
+      "token": "spacing-200",
+      "context": "Spacing (header to body, body to footer)"
+    },
+    {
+      "token": "spacing-300",
+      "context": "Spacing (header to body, body to footer)"
+    },
+    {
+      "token": "coach-mark-pagination-text-to-bottom-edge",
+      "context": "Spacing (pagination to bottom)"
+    },
+    {
+      "token": "coach-mark-media-minimum-height",
+      "context": "Media (16:9)"
+    },
+    {
+      "token": "coach-mark-media-height",
+      "context": "Media (4:3)"
+    },
+    {
+      "token": "spacing-100",
+      "context": "Spacing (action button to menu)"
+    },
+    {
+      "token": "title-sans-serif-font-family",
+      "context": "Title"
+    },
+    {
+      "token": "title-sans-serif-font-weight",
+      "context": "Title"
+    },
+    {
+      "token": "title-serif-font-style",
+      "context": "Title"
+    },
+    {
+      "token": "coach-mark-title-font-size",
+      "context": "Title"
+    },
+    {
+      "token": "title-line-height",
+      "context": "Title"
+    },
+    {
+      "token": "body-sans-serif-font-family",
+      "context": "Body"
+    },
+    {
+      "token": "body-sans-serif-font-weight",
+      "context": "Body"
+    },
+    {
+      "token": "body-serif-font-style",
+      "context": "Body"
+    },
+    {
+      "token": "coach-mark-body-font-size",
+      "context": "Body"
+    },
+    {
+      "token": "line-height-200",
+      "context": "Body"
+    },
+    {
+      "token": "medium-font-weight",
+      "context": "Pagination"
+    },
+    {
+      "token": "coach-mark-pagination-body-font-size",
+      "context": "Pagination"
+    },
+    {
+      "token": "heading-color",
+      "context": "Color"
+    },
+    {
+      "token": "body-color",
+      "context": "Color"
+    },
+    {
+      "token": "coach-mark-pagination-color",
+      "context": "Color"
+    }
+  ]
+}