@adobe/design-data-spec 0.3.0 → 0.5.0

package/components/combo-box.json

@@ -0,0 +1,480 @@
+{
+  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/v0/component.schema.json",
+  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/v0/components/combo-box.json",
+  "specVersion": "1.0.0-draft",
+  "name": "combo-box",
+  "displayName": "Combo box",
+  "description": "Combo boxes combine a text entry with a picker menu, allowing users to filter longer lists to only the selections matching a query.",
+  "meta": {
+    "category": "inputs",
+    "documentationUrl": "https://spectrum.adobe.com/page/combo-box/"
+  },
+  "options": {
+    "label": {
+      "type": "string"
+    },
+    "labelPosition": {
+      "type": "string",
+      "enum": ["top", "side", "in line"],
+      "default": "top"
+    },
+    "value": {
+      "type": "string"
+    },
+    "width": {
+      "type": "number"
+    },
+    "size": {
+      "type": "string",
+      "enum": ["s", "m", "l", "xl"],
+      "default": "m"
+    },
+    "isRequired": {
+      "type": "boolean",
+      "default": false
+    },
+    "necessityIndicator": {
+      "type": "string",
+      "enum": ["text", "icon"],
+      "default": "icon"
+    },
+    "hasAutocomplete": {
+      "type": "boolean",
+      "default": false
+    },
+    "menuTrigger": {
+      "type": "string",
+      "enum": ["input", "focus", "manual"],
+      "default": "input"
+    },
+    "isError": {
+      "type": "boolean",
+      "default": false
+    },
+    "isDisabled": {
+      "type": "boolean",
+      "default": false
+    },
+    "isReadOnly": {
+      "type": "boolean",
+      "default": false
+    },
+    "description": {
+      "type": "string"
+    },
+    "errorMessage": {
+      "type": "string"
+    }
+  },
+  "states": [
+    {
+      "name": "hover-(text-area)",
+      "trigger": "prop"
+    },
+    {
+      "name": "hover-(button-area)",
+      "trigger": "prop"
+    },
+    {
+      "name": "focus-+-hover",
+      "trigger": "prop"
+    },
+    {
+      "name": "focus-+-not-hover",
+      "trigger": "prop"
+    },
+    {
+      "name": "keyboard-focus",
+      "trigger": "interaction"
+    }
+  ],
+  "lifecycle": {
+    "introduced": "1.0.0-draft"
+  },
+  "tokenBindings": [
+    {
+      "token": "combo-box-visual-to-field-button-quiet",
+      "context": "S1 Spacing (alert icon/progress circle to field button)"
+    },
+    {
+      "token": "component-top-to-text-300",
+      "context": "S2 Leading icon (top/bottom edge to leading icon) position: inline"
+    },
+    {
+      "token": "component-top-to-workflow-icon-400",
+      "context": "S2 Leading icon (top/bottom edge to leading icon) position: inline"
+    },
+    {
+      "token": "component-padding-vertical-200",
+      "context": "S2 Spacing (top/bottom edge to text: inline)"
+    },
+    {
+      "token": "component-padding-vertical-300",
+      "context": "S2 Spacing (top/bottom edge to text: inline)"
+    },
+    {
+      "token": "component-top-to-text-50",
+      "context": "S2 Spacing (top/bottom edge to text: inline)"
+    },
+    {
+      "token": "component-top-to-text-100",
+      "context": "S2 Spacing (top/bottom edge to text: inline)"
+    },
+    {
+      "token": "field-default-width-small",
+      "context": "Width (default)"
+    },
+    {
+      "token": "field-default-width-medium",
+      "context": "Width (default)"
+    },
+    {
+      "token": "field-default-width-large",
+      "context": "Width (default)"
+    },
+    {
+      "token": "field-default-width-extra-large",
+      "context": "Width (default)"
+    },
+    {
+      "token": "combo-box-minimum-width-multiplier",
+      "context": "Width (minimum)"
+    },
+    {
+      "token": "component-height-75",
+      "context": "Height"
+    },
+    {
+      "token": "component-height-100",
+      "context": "Height"
+    },
+    {
+      "token": "component-height-200",
+      "context": "Height"
+    },
+    {
+      "token": "component-height-300",
+      "context": "Height"
+    },
+    {
+      "token": "corner-radius-medium-size-small",
+      "context": "Rounding"
+    },
+    {
+      "token": "corner-radius-medium-size-medium",
+      "context": "Rounding"
+    },
+    {
+      "token": "corner-radius-medium-size-large",
+      "context": "Rounding"
+    },
+    {
+      "token": "corner-radius-medium-size-extra-large",
+      "context": "Rounding"
+    },
+    {
+      "token": "component-edge-to-text-75",
+      "context": "Spacing (start/end edge to value)"
+    },
+    {
+      "token": "component-edge-to-text-100",
+      "context": "Spacing (start/end edge to value)"
+    },
+    {
+      "token": "component-edge-to-text-200",
+      "context": "Spacing (start/end edge to value)"
+    },
+    {
+      "token": "component-edge-to-text-300",
+      "context": "Spacing (start/end edge to value)"
+    },
+    {
+      "token": "workflow-icon-size-75",
+      "context": "Prefix min-width"
+    },
+    {
+      "token": "workflow-icon-size-100",
+      "context": "Prefix min-width"
+    },
+    {
+      "token": "workflow-icon-size-200",
+      "context": "Prefix min-width"
+    },
+    {
+      "token": "workflow-icon-size-300",
+      "context": "Prefix min-width"
+    },
+    {
+      "token": "text-to-visual-75",
+      "context": "Spacing (prefix to value/placeholder)"
+    },
+    {
+      "token": "text-to-visual-100",
+      "context": "Spacing (prefix to value/placeholder)"
+    },
+    {
+      "token": "text-to-visual-200",
+      "context": "Spacing (prefix to value/placeholder)"
+    },
+    {
+      "token": "text-to-visual-300",
+      "context": "Spacing (prefix to value/placeholder)"
+    },
+    {
+      "token": "border-width-200",
+      "context": "Border"
+    },
+    {
+      "token": "focus-indicator-thickness",
+      "context": "Focus indicator"
+    },
+    {
+      "token": "focus-indicator-gap",
+      "context": "Focus indicator"
+    },
+    {
+      "token": "combo-box-visual-to-field-button",
+      "context": "Spacing (alert icon/in-field progress circle to field button)"
+    },
+    {
+      "token": "component-top-to-workflow-icon-75",
+      "context": "Spacing (top/bottom edge to alert icon)"
+    },
+    {
+      "token": "component-top-to-workflow-icon-100",
+      "context": "Spacing (top/bottom edge to alert icon)"
+    },
+    {
+      "token": "component-top-to-workflow-icon-200",
+      "context": "Spacing (top/bottom edge to alert icon)"
+    },
+    {
+      "token": "component-top-to-workflow-icon-300",
+      "context": "Spacing (top/bottom edge to alert icon)"
+    },
+    {
+      "token": "field-edge-to-alert-icon-small",
+      "context": "Leading icon (leading icon to end edge)"
+    },
+    {
+      "token": "field-edge-to-alert-icon-medium",
+      "context": "Leading icon (leading icon to end edge)"
+    },
+    {
+      "token": "field-edge-to-alert-icon-large",
+      "context": "Leading icon (leading icon to end edge)"
+    },
+    {
+      "token": "field-edge-to-alert-icon-extra-large",
+      "context": "Leading icon (leading icon to end edge)"
+    },
+    {
+      "token": "field-label-to-component",
+      "context": "Spacing (field label to combo box)"
+    },
+    {
+      "token": "component-to-menu-small",
+      "context": "Spacing (component to menu)"
+    },
+    {
+      "token": "component-to-menu-medium",
+      "context": "Spacing (component to menu)"
+    },
+    {
+      "token": "component-to-menu-large",
+      "context": "Spacing (component to menu)"
+    },
+    {
+      "token": "component-to-menu-extra-large",
+      "context": "Spacing (component to menu)"
+    },
+    {
+      "token": "help-text-to-component",
+      "context": "Spacing (combo box to help text)"
+    },
+    {
+      "token": "in-field-progress-circle",
+      "context": "In-field progress circle"
+    },
+    {
+      "token": "field-top-to-progress-circle-small",
+      "context": "Spacing (top/bottom edge to in-field progress circle icon)"
+    },
+    {
+      "token": "field-top-to-progress-circle-medium",
+      "context": "Spacing (top/bottom edge to in-field progress circle icon)"
+    },
+    {
+      "token": "field-top-to-progress-circle-large",
+      "context": "Spacing (top/bottom edge to in-field progress circle icon)"
+    },
+    {
+      "token": "field-top-to-progress-circle-extra-large",
+      "context": "Spacing (top/bottom edge to in-field progress circle icon)"
+    },
+    {
+      "token": "gray-25",
+      "context": "Background and border"
+    },
+    {
+      "token": "gray-300",
+      "context": "Background and border"
+    },
+    {
+      "token": "gray-400",
+      "context": "Background and border"
+    },
+    {
+      "token": "gray-900",
+      "context": "Background and border"
+    },
+    {
+      "token": "gray-800",
+      "context": "Background and border"
+    },
+    {
+      "token": "neutral-subdued-content-color-default",
+      "context": "Background and border"
+    },
+    {
+      "token": "negative-border-color-default",
+      "context": "Border (error)"
+    },
+    {
+      "token": "negative-border-color-hover",
+      "context": "Border (error)"
+    },
+    {
+      "token": "negative-border-color-focus-hover",
+      "context": "Border (error)"
+    },
+    {
+      "token": "negative-border-color-focus",
+      "context": "Border (error)"
+    },
+    {
+      "token": "negative-border-color-key-focus",
+      "context": "Border (error)"
+    },
+    {
+      "token": "neutral-content-color-default",
+      "context": "Value"
+    },
+    {
+      "token": "neutral-content-color-hover",
+      "context": "Value"
+    },
+    {
+      "token": "neutral-content-color-focus-hover",
+      "context": "Value"
+    },
+    {
+      "token": "neutral-content-color-focus",
+      "context": "Value"
+    },
+    {
+      "token": "neutral-content-color-key-focus",
+      "context": "Value"
+    },
+    {
+      "token": "negative-visual-color",
+      "context": "Alert icon"
+    },
+    {
+      "token": "disabled-content-color",
+      "context": "Disabled"
+    },
+    {
+      "token": "disabled-border-color",
+      "context": "Disabled"
+    },
+    {
+      "token": "disabled-background-color",
+      "context": "Disabled"
+    },
+    {
+      "token": "focus-indicator-color",
+      "context": "Focus ring"
+    },
+    {
+      "token": "default-font-family",
+      "context": "Value"
+    },
+    {
+      "token": "regular-font-weight",
+      "context": "Value"
+    },
+    {
+      "token": "default-font-style",
+      "context": "Value"
+    },
+    {
+      "token": "component-s-regular",
+      "context": "Value"
+    },
+    {
+      "token": "component-m-regular",
+      "context": "Value"
+    },
+    {
+      "token": "component-l-regular",
+      "context": "Value"
+    },
+    {
+      "token": "component-xl-regular",
+      "context": "Value"
+    },
+    {
+      "token": "line-height-font-size-75",
+      "context": "Value"
+    },
+    {
+      "token": "line-height-font-size-100",
+      "context": "Value"
+    },
+    {
+      "token": "line-height-font-size-200",
+      "context": "Value"
+    },
+    {
+      "token": "line-height-font-size-300",
+      "context": "Value"
+    },
+    {
+      "token": "cjk-line-height-100",
+      "context": "Value"
+    },
+    {
+      "token": "medium-font-weight",
+      "context": "Prefix"
+    },
+    {
+      "token": "component-s-medium",
+      "context": "Prefix"
+    },
+    {
+      "token": "component-m-medium",
+      "context": "Prefix"
+    },
+    {
+      "token": "component-l-medium",
+      "context": "Prefix"
+    },
+    {
+      "token": "component-xl-medium",
+      "context": "Prefix"
+    },
+    {
+      "token": "field-label-top-to-asterisk-large",
+      "context": "Spacing (top/bottom edge to required)"
+    },
+    {
+      "token": "field-label-top-to-asterisk-extra-large",
+      "context": "Spacing (top/bottom edge to required)"
+    },
+    {
+      "token": "gray-600",
+      "context": "Label (populated true/false)"
+    }
+  ]
+}

package/components/contextual-help.json

@@ -0,0 +1,162 @@
+{
+  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/v0/component.schema.json",
+  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/v0/components/contextual-help.json",
+  "specVersion": "1.0.0-draft",
+  "name": "contextual-help",
+  "displayName": "Contextual help",
+  "description": "Contextual help shows a user extra information about the state of either an adjacent component or an entire view. It explains a high-level topic about an experience and can point users to more information elsewhere.",
+  "meta": {
+    "category": "feedback",
+    "documentationUrl": "https://spectrum.adobe.com/page/contextual-help/"
+  },
+  "options": {
+    "icon": {
+      "type": "string",
+      "enum": ["info", "help"],
+      "default": "info"
+    },
+    "popoverPlacement": {
+      "type": "string",
+      "enum": [
+        "top",
+        "top left",
+        "top right",
+        "top start",
+        "top end",
+        "bottom",
+        "bottom left",
+        "bottom right",
+        "bottom start",
+        "bottom end",
+        "left",
+        "left top",
+        "left bottom",
+        "start",
+        "start top",
+        "start bottom",
+        "right",
+        "right top",
+        "right bottom",
+        "end",
+        "end top",
+        "end bottom"
+      ],
+      "default": "bottom start"
+    },
+    "popoverOffset": {
+      "type": "number",
+      "default": 8
+    },
+    "href": {
+      "type": "string",
+      "description": "Optional URL within contextual help content like a 'Learn more' link."
+    },
+    "popoverCrossOffset": {
+      "type": "number",
+      "default": 0
+    },
+    "containerPadding": {
+      "type": "number",
+      "default": 8
+    }
+  },
+  "states": [
+    {
+      "name": "down",
+      "trigger": "interaction"
+    },
+    {
+      "name": "open",
+      "trigger": "prop"
+    },
+    {
+      "name": "keyboard-focus",
+      "trigger": "interaction"
+    }
+  ],
+  "lifecycle": {
+    "introduced": "1.0.0-draft"
+  },
+  "tokenBindings": [
+    {
+      "token": "xs-s",
+      "context": "Components"
+    },
+    {
+      "token": "s-m",
+      "context": "Components"
+    },
+    {
+      "token": "contextual-help-minimum-width",
+      "context": "Minimum width"
+    },
+    {
+      "token": "corner-radius-large-default",
+      "context": "Rounding"
+    },
+    {
+      "token": "spacing-400",
+      "context": "Spacing (top/bottom/start/end edge to text)"
+    },
+    {
+      "token": "spacing-100",
+      "context": "Spacing (header to body, body to link)"
+    },
+    {
+      "token": "spacing-200",
+      "context": "Spacing (header to body, body to link)"
+    },
+    {
+      "token": "spacing-300",
+      "context": "Spacing (header to body, body to link)"
+    },
+    {
+      "token": "contextual-help-title-size",
+      "context": "Title"
+    },
+    {
+      "token": "title-sans-serif-font-family",
+      "context": "Title"
+    },
+    {
+      "token": "title-sans-serif-font-weight",
+      "context": "Title"
+    },
+    {
+      "token": "title-sans-serif-font-style",
+      "context": "Title"
+    },
+    {
+      "token": "title-line-height",
+      "context": "Title"
+    },
+    {
+      "token": "contextual-help-body-size",
+      "context": "Body"
+    },
+    {
+      "token": "body-sans-serif-font-family",
+      "context": "Body"
+    },
+    {
+      "token": "body-sans-serif-font-weight",
+      "context": "Body"
+    },
+    {
+      "token": "body-sans-serif-font-style",
+      "context": "Body"
+    },
+    {
+      "token": "line-height-200",
+      "context": "Body"
+    },
+    {
+      "token": "title-color",
+      "context": "Color"
+    },
+    {
+      "token": "body-color",
+      "context": "Color"
+    }
+  ]
+}