@adobe/spectrum-component-api-schemas 6.0.0 → 6.1.0

package/schemas/components/close-button.json

@@ -1,35 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/close-button.json",
-  "title": "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/"
-  },
-  "type": "object",
-  "properties": {
-    "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
-    },
-    "state": {
-      "type": "string",
-      "enum": ["default", "hover", "down", "keyboard focus"],
-      "default": "default"
-    }
-  }
-}

package/schemas/components/coach-indicator.json

@@ -1,34 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/coach-indicator.json",
-  "title": "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/"
-  },
-  "type": "object",
-  "properties": {
-    "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."
-    }
-  }
-}

package/schemas/components/coach-mark.json

@@ -1,51 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/coach-mark.json",
-  "title": "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/"
-  },
-  "type": "object",
-  "properties": {
-    "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)."
-        }
-      }
-    }
-  }
-}

package/schemas/components/code.json

@@ -1,21 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/code.json",
-  "title": "Code",
-  "description": "Detail is a typography component used for disclosing extra information or smaller items in hierarchical relationships of text.",
-  "meta": {
-    "category": "typography",
-    "documentationUrl": "https://spectrum.adobe.com/page/code/"
-  },
-  "type": "object",
-  "properties": {
-    "script": {
-      "$ref": "https://opensource.adobe.com/spectrum-design-data/schemas/types/typography-script.json"
-    },
-    "size": {
-      "type": "string",
-      "enum": ["xs", "s", "m", "l", "xl"],
-      "default": "m"
-    }
-  }
-}

package/schemas/components/color-area.json

@@ -1,64 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/color-area.json",
-  "title": "Color area",
-  "description": "A color area allows users to visually select two properties of a color simultaneously. It's commonly used together with a color slider or color wheel.",
-  "meta": {
-    "category": "inputs",
-    "documentationUrl": "https://spectrum.adobe.com/page/color-area/"
-  },
-  "type": "object",
-  "properties": {
-    "background": {
-      "type": "string",
-      "description": "This will vary depending on implementation."
-    },
-    "x-value": {
-      "type": "number",
-      "description": "Number (from x-minValue to x-maxValue)"
-    },
-    "x-minValue": {
-      "type": "number",
-      "default": 0
-    },
-    "x-maxValue": {
-      "type": "number",
-      "default": 100
-    },
-    "y-value": {
-      "type": "number",
-      "description": "Number (from y-minValue to y-maxValue)"
-    },
-    "y-minValue": {
-      "type": "number",
-      "default": 0
-    },
-    "y-maxValue": {
-      "type": "number",
-      "default": 100
-    },
-    "step": {
-      "type": "number",
-      "default": 1
-    },
-    "width": {
-      "type": "number",
-      "default": 192,
-      "description": "units: px"
-    },
-    "height": {
-      "type": "number",
-      "default": 192,
-      "description": "units: px"
-    },
-    "isDisabled": {
-      "type": "boolean",
-      "default": false
-    },
-    "state": {
-      "type": "string",
-      "enum": ["default", "hover", "down", "keyboard focus"],
-      "default": "default"
-    }
-  }
-}

package/schemas/components/color-handle.json

@@ -1,31 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/color-handle.json",
-  "title": "Color handle",
-  "description": "Color handles allow users to select and adjust colors in a color picker.",
-  "meta": {
-    "category": "inputs",
-    "documentationUrl": "https://spectrum.adobe.com/page/color-handle/"
-  },
-  "type": "object",
-  "properties": {
-    "channel": {
-      "type": "string",
-      "enum": [
-        "hue",
-        "saturation",
-        "lightness",
-        "red",
-        "green",
-        "blue",
-        "alpha"
-      ],
-      "default": "hue",
-      "description": "Which channel of the color this handle controls. Use 'alpha' for opacity."
-    },
-    "isDisabled": {
-      "type": "boolean",
-      "default": false
-    }
-  }
-}

package/schemas/components/color-loupe.json

@@ -1,21 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/color-loupe.json",
-  "title": "Color loupe",
-  "description": "A color loupe shows the output color that would otherwise be covered by a cursor, stylus, or finger during color selection.",
-  "meta": {
-    "category": "feedback",
-    "documentationUrl": "https://spectrum.adobe.com/page/color-loupe/"
-  },
-  "type": "object",
-  "properties": {
-    "value": {
-      "$ref": "https://opensource.adobe.com/spectrum-design-data/schemas/types/hex-color.json"
-    },
-    "state": {
-      "type": "string",
-      "enum": ["default"],
-      "default": "default"
-    }
-  }
-}

package/schemas/components/color-slider.json

@@ -1,66 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/color-slider.json",
-  "title": "Color slider",
-  "description": "A color slider lets users visually change an individual channel of a color.",
-  "meta": {
-    "category": "inputs",
-    "documentationUrl": "https://spectrum.adobe.com/page/color-slider/"
-  },
-  "type": "object",
-  "properties": {
-    "background": {
-      "type": "string",
-      "description": "This will vary depending on implementation."
-    },
-    "channel": {
-      "type": "string",
-      "enum": [
-        "hue",
-        "saturation",
-        "lightness",
-        "red",
-        "green",
-        "blue",
-        "alpha"
-      ],
-      "default": "hue",
-      "description": "Which channel of the color this slider controls. Use 'alpha' for opacity."
-    },
-    "value": {
-      "type": "number",
-      "description": "Number (from minValue to maxValue)."
-    },
-    "minValue": {
-      "type": "number",
-      "default": 0
-    },
-    "maxValue": {
-      "type": "number",
-      "default": 100
-    },
-    "step": {
-      "type": "number",
-      "default": 1
-    },
-    "orientation": {
-      "type": "string",
-      "enum": ["horizontal", "vertical"],
-      "default": "horizontal"
-    },
-    "length": {
-      "type": "number",
-      "default": 192,
-      "description": "units: px"
-    },
-    "isDisabled": {
-      "type": "boolean",
-      "default": false
-    },
-    "state": {
-      "type": "string",
-      "enum": ["default", "hover", "down", "keyboard focus"],
-      "default": "default"
-    }
-  }
-}

package/schemas/components/color-wheel.json

@@ -1,47 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/color-wheel.json",
-  "title": "Color wheel",
-  "description": "A color wheel lets users visually change an individual channel of a color on a circular track.",
-  "meta": {
-    "category": "inputs",
-    "documentationUrl": "https://spectrum.adobe.com/page/color-wheel/"
-  },
-  "type": "object",
-  "properties": {
-    "background": {
-      "type": "string",
-      "description": "This will vary depending on implementation."
-    },
-    "value": {
-      "type": "number",
-      "description": "Number (from minValue to maxValue)"
-    },
-    "minValue": {
-      "type": "number",
-      "default": 0
-    },
-    "maxValue": {
-      "type": "number",
-      "default": 360
-    },
-    "step": {
-      "type": "number",
-      "default": 1
-    },
-    "size": {
-      "type": "number",
-      "default": 192,
-      "description": "units: px"
-    },
-    "isDisabled": {
-      "type": "boolean",
-      "default": false
-    },
-    "state": {
-      "type": "string",
-      "enum": ["default", "hover", "down", "keyboard focus"],
-      "default": "default"
-    }
-  }
-}

package/schemas/components/combo-box.json

@@ -1,80 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/combo-box.json",
-  "title": "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/"
-  },
-  "type": "object",
-  "properties": {
-    "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"
-    },
-    "state": {
-      "type": "string",
-      "enum": [
-        "default",
-        "hover (text area)",
-        "hover (button area)",
-        "focus + hover",
-        "focus + not hover",
-        "keyboard focus"
-      ],
-      "default": "default"
-    }
-  }
-}

package/schemas/components/contextual-help.json

@@ -1,67 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/contextual-help.json",
-  "title": "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/"
-  },
-  "type": "object",
-  "properties": {
-    "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
-    },
-    "state": {
-      "type": "string",
-      "enum": ["default", "down", "open", "keyboard focus"],
-      "default": "default"
-    }
-  }
-}