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

package/schemas/components/menu.json

@@ -1,63 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/menu.json",
-  "title": "Menu",
-  "description": "Menus help users take actions, choose from a list of options, configure settings, and more. They can be placed in a transient container, like a popover or tray.",
-  "meta": {
-    "category": "actions",
-    "documentationUrl": "https://spectrum.adobe.com/page/menu/"
-  },
-  "type": "object",
-  "properties": {
-    "container": {
-      "type": "string",
-      "enum": ["popover", "tray"]
-    },
-    "label": {
-      "type": "string"
-    },
-    "icon": {
-      "$ref": "https://opensource.adobe.com/spectrum-design-data/schemas/types/workflow-icon.json",
-      "description": "Icon must be present if the label is not defined."
-    },
-    "description": {
-      "type": "string"
-    },
-    "value": {
-      "type": "string"
-    },
-    "size": {
-      "type": "string",
-      "enum": ["s", "m", "l", "xl"],
-      "default": "m"
-    },
-    "selectionMode": {
-      "type": "string",
-      "enum": ["single", "multiple", "no selection"]
-    },
-    "selectionStyle": {
-      "type": "string",
-      "enum": ["checkbox", "switch"]
-    },
-    "sectionHeader": {
-      "type": "string"
-    },
-    "isCollapsible": {
-      "type": "boolean",
-      "default": false
-    },
-    "isUnavailable": {
-      "type": "boolean",
-      "default": false
-    },
-    "isDisabled": {
-      "type": "boolean",
-      "default": false
-    },
-    "state": {
-      "type": "string",
-      "enum": ["default", "hover", "down", "keyboard focus"],
-      "default": "default"
-    }
-  }
-}

package/schemas/components/meter.json

@@ -1,44 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/meter.json",
-  "title": "Meter",
-  "description": "Meters are visual representations of a quantity or an achievement. Their progress is determined by user actions, rather than system actions.",
-  "meta": {
-    "category": "status",
-    "documentationUrl": "https://spectrum.adobe.com/page/meter/"
-  },
-  "type": "object",
-  "properties": {
-    "variant": {
-      "type": "string",
-      "enum": ["informative", "positive", "notice", "negative"],
-      "default": "informative"
-    },
-    "label": {
-      "type": "string"
-    },
-    "hideLabel": {
-      "type": "boolean",
-      "default": false
-    },
-    "valueLabel": {
-      "type": "string"
-    },
-    "width": {
-      "type": "number"
-    },
-    "size": {
-      "type": "string",
-      "enum": ["s", "m", "l", "xl"],
-      "default": "m"
-    },
-    "value": {
-      "type": "number",
-      "minimum": 0,
-      "maximum": 1
-    },
-    "helpText": {
-      "type": "string"
-    }
-  }
-}

package/schemas/components/number-field.json

@@ -1,57 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/number-field.json",
-  "title": "Number field",
-  "description": "Number fields allow users to enter a numeric value, with optional increment and decrement buttons.",
-  "meta": {
-    "category": "inputs",
-    "documentationUrl": "https://spectrum.adobe.com/page/number-field/"
-  },
-  "type": "object",
-  "properties": {
-    "label": {
-      "type": "string"
-    },
-    "size": {
-      "type": "string",
-      "enum": ["s", "m", "l", "xl"],
-      "default": "m"
-    },
-    "labelPosition": {
-      "type": "string",
-      "default": "top",
-      "enum": ["top", "side"]
-    },
-    "hideLabel": {
-      "type": "boolean",
-      "default": false
-    },
-    "state": {
-      "type": "string",
-      "enum": ["default", "hover", "focus + hover", "focus + not hover"],
-      "default": "default"
-    },
-    "isDisabled": {
-      "type": "boolean",
-      "default": false
-    },
-    "isError": {
-      "type": "boolean",
-      "default": false
-    },
-    "isRequired": {
-      "type": "boolean",
-      "default": false
-    },
-    "necessityIndicator": {
-      "type": "string",
-      "enum": ["text", "icon"],
-      "default": "icon"
-    },
-    "hideStepper": {
-      "type": "boolean",
-      "default": false,
-      "description": "If true, hides in-field increment and decrement buttons (stepper)."
-    }
-  }
-}

package/schemas/components/opacity-checkerboard.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/opacity-checkerboard.json",
-  "title": "Opacity Checkerboard",
-  "description": "Opacity checkerboards provide a visual pattern background used in color swatches and UI elements to indicate transparency or when no color is selected.",
-  "meta": {
-    "category": "status",
-    "documentationUrl": "https://spectrum.adobe.com/page/opacity-checkerboard/"
-  },
-  "type": "object",
-  "properties": {
-    "verticalSize": {
-      "type": "number",
-      "enum": [16, 32, 64, 128, 256]
-    },
-    "horizontalSize": {
-      "type": "number",
-      "enum": [24, 40]
-    }
-  }
-}

package/schemas/components/picker.json

@@ -1,81 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/picker.json",
-  "title": "Picker",
-  "description": "Pickers (sometimes known as \"dropdowns\" or \"selects\") allow users to choose from a list of options in a limited space. The list of options can change based on the context.",
-  "meta": {
-    "category": "inputs",
-    "documentationUrl": "https://spectrum.adobe.com/page/picker/"
-  },
-  "type": "object",
-  "properties": {
-    "label": {
-      "type": "string"
-    },
-    "labelPosition": {
-      "type": "string",
-      "default": "top",
-      "enum": ["top", "side"]
-    },
-    "placeholder": {
-      "type": "string"
-    },
-    "value": {
-      "type": "string"
-    },
-    "width": {
-      "type": "number",
-      "description": "Not applicable to quiet picker."
-    },
-    "size": {
-      "type": "string",
-      "enum": ["s", "m", "l", "xl"],
-      "default": "m"
-    },
-    "isQuiet": {
-      "type": "boolean",
-      "default": false
-    },
-    "necessityIndicator": {
-      "type": "string",
-      "enum": ["text", "icon"],
-      "default": "icon"
-    },
-    "isRequired": {
-      "type": "boolean",
-      "default": false
-    },
-    "menuContainer": {
-      "type": "string",
-      "enum": ["popover", "tray"],
-      "default": "popover"
-    },
-    "isDisabled": {
-      "type": "boolean",
-      "default": false
-    },
-    "isError": {
-      "type": "boolean",
-      "default": false
-    },
-    "description": {
-      "type": "string",
-      "default": null
-    },
-    "errorMessage": {
-      "type": "string",
-      "default": null
-    },
-    "state": {
-      "type": "string",
-      "enum": [
-        "default",
-        "hover",
-        "focus + hover",
-        "focus + not hover",
-        "keyboard focus"
-      ],
-      "default": "default"
-    }
-  }
-}

package/schemas/components/popover.json

@@ -1,65 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/popover.json",
-  "title": "Popover",
-  "description": "Popovers are containers used to display transient content such as menus, options, additional actions, and more. They visually stand out through stroke and drop shadow and float on top of the interface.",
-  "meta": {
-    "category": "containers",
-    "documentationUrl": "https://spectrum.adobe.com/page/popover/"
-  },
-  "type": "object",
-  "properties": {
-    "width": {
-      "type": "number"
-    },
-    "height": {
-      "type": "number"
-    },
-    "hideTip": {
-      "type": "boolean",
-      "default": false
-    },
-    "placement": {
-      "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": "top"
-    },
-    "offset": {
-      "type": "number",
-      "default": 8,
-      "description": "pixel measurement"
-    },
-    "crossOffset": {
-      "type": "number",
-      "default": 0
-    },
-    "containerPadding": {
-      "type": "number",
-      "default": 8,
-      "description": "pixel measurement"
-    }
-  }
-}

package/schemas/components/progress-bar.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/progress-bar.json",
-  "title": "Progress bar",
-  "description": "Progress bars show the progression of a system operation: downloading, uploading, processing, etc., in a visual way. They can represent either determinate or indeterminate progress.",
-  "meta": {
-    "category": "status",
-    "documentationUrl": "https://spectrum.adobe.com/page/progress-bar/"
-  },
-  "type": "object",
-  "properties": {
-    "variant": {
-      "type": "string",
-      "enum": ["default", "over background"],
-      "default": "default"
-    },
-    "staticColor": {
-      "type": "string",
-      "enum": ["white"],
-      "description": "Static color can only be white, otherwise it is default."
-    },
-    "label": {
-      "type": "string"
-    },
-    "labelPosition": {
-      "type": "string",
-      "enum": ["top", "side"],
-      "default": "top"
-    },
-    "hideLabel": {
-      "type": "boolean",
-      "default": false
-    },
-    "value": {
-      "type": "number",
-      "description": "Not applicable when indeterminate."
-    },
-    "minValue": {
-      "type": "number",
-      "default": 0,
-      "description": "Not applicable when indeterminate."
-    },
-    "maxValue": {
-      "type": "number",
-      "default": 1,
-      "description": "Not applicable when indeterminate."
-    },
-    "valueLabel": {
-      "type": "string"
-    },
-    "width": {
-      "type": "number"
-    },
-    "size": {
-      "type": "string",
-      "enum": ["s", "m", "l", "xl"],
-      "default": "m"
-    },
-    "isIndeterminate": {
-      "type": "boolean",
-      "default": false
-    }
-  }
-}

package/schemas/components/progress-circle.json

@@ -1,41 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/progress-circle.json",
-  "title": "Progress circle",
-  "description": "Progress circles show the progression of a system operation such as downloading, uploading, processing, etc. in a visual way. They can represent determinate or indeterminate progress.",
-  "meta": {
-    "category": "status",
-    "documentationUrl": "https://spectrum.adobe.com/page/progress-circle/"
-  },
-  "type": "object",
-  "properties": {
-    "variant": {
-      "type": "string",
-      "enum": ["default", "over background"],
-      "default": "default"
-    },
-    "value": {
-      "type": "number",
-      "description": "Not applicable when indeterminate."
-    },
-    "minValue": {
-      "type": "number",
-      "default": 0,
-      "description": "Not applicable when indeterminate."
-    },
-    "maxValue": {
-      "type": "number",
-      "default": 1,
-      "description": "Not applicable when indeterminate."
-    },
-    "size": {
-      "type": "string",
-      "enum": ["s", "m", "l"],
-      "default": "m"
-    },
-    "isIndeterminate": {
-      "type": "boolean",
-      "default": false
-    }
-  }
-}

package/schemas/components/radio-button.json

@@ -1,30 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/radio-button.json",
-  "title": "Radio button",
-  "description": "Radio buttons allow users to select a single option from a list of mutually exclusive options.",
-  "meta": {
-    "category": "inputs",
-    "documentationUrl": "https://spectrum.adobe.com/page/radio-button/"
-  },
-  "type": "object",
-  "properties": {
-    "state": {
-      "type": "string",
-      "enum": ["default", "hover", "down", "keyboard focus"],
-      "default": "default"
-    },
-    "isSelected": {
-      "type": "boolean",
-      "default": false
-    },
-    "isEmphasized": {
-      "type": "boolean",
-      "default": false
-    },
-    "label": {
-      "type": "string",
-      "description": "The text displayed next to a radio button."
-    }
-  }
-}

package/schemas/components/radio-group.json

@@ -1,58 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/radio-group.json",
-  "title": "Radio Group",
-  "description": "A radio group is a grouping of radio buttons that are related to each other.",
-  "meta": {
-    "category": "inputs",
-    "documentationUrl": "https://spectrum.adobe.com/page/radio-group/"
-  },
-  "type": "object",
-  "properties": {
-    "label": {
-      "type": "string"
-    },
-    "labelPosition": {
-      "type": "string",
-      "enum": ["top", "side"],
-      "default": "top"
-    },
-    "orientation": {
-      "type": "string",
-      "enum": ["horizontal", "vertical"],
-      "default": "vertical"
-    },
-    "size": {
-      "type": "string",
-      "enum": ["s", "m", "l", "xl"],
-      "default": "m"
-    },
-    "isEmphasized": {
-      "type": "boolean",
-      "default": false
-    },
-    "necessityIndicator": {
-      "type": "string",
-      "enum": ["text", "icon"],
-      "default": "icon"
-    },
-    "isRequired": {
-      "type": "boolean",
-      "default": false
-    },
-    "isError": {
-      "type": "boolean",
-      "default": false
-    },
-    "isDisabled": {
-      "type": "boolean",
-      "default": false
-    },
-    "errorMessage": {
-      "type": "string"
-    },
-    "description": {
-      "type": "string"
-    }
-  }
-}

package/schemas/components/rating.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/rating.json",
-  "title": "Rating",
-  "description": "The rating component lets users apply a rating to an item or experience, such as an image, a forum post, an item for sale in a marketplace, and more.",
-  "meta": {
-    "category": "inputs",
-    "documentationUrl": "https://spectrum.adobe.com/page/rating/"
-  },
-  "type": "object",
-  "properties": {
-    "value": {
-      "type": "number",
-      "minimum": 0,
-      "maximum": 5,
-      "default": 0,
-      "multipleOf": 0.5,
-      "description": "From 0 to 5, can be a decimal to represent half stars"
-    },
-    "isEmphasized": {
-      "type": "boolean",
-      "default": false
-    },
-    "isDisabled": {
-      "type": "boolean",
-      "default": false
-    },
-    "state": {
-      "type": "string",
-      "enum": ["default", "hover", "down", "keyboard focus"],
-      "default": "default"
-    }
-  }
-}

package/schemas/components/scroll-zoom-bar.json

@@ -1,44 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/scroll-zoom-bar.json",
-  "title": "Scroll-zoom bar",
-  "description": "Primarily for usage in timelines, a scroll-zoom bar lets a user scroll or zoom with the same control.",
-  "meta": {
-    "category": "navigation",
-    "documentationUrl": "https://spectrum.adobe.com/page/scroll-zoom-bar/"
-  },
-  "type": "object",
-  "properties": {
-    "size": {
-      "type": "string",
-      "enum": ["s", "m", "l"],
-      "default": "m"
-    },
-    "orientation": {
-      "type": "string",
-      "enum": ["horizontal", "vertical"],
-      "default": "horizontal"
-    },
-    "hideTrack": {
-      "type": "boolean",
-      "default": false
-    },
-    "hideHandles": {
-      "type": "boolean",
-      "default": false
-    },
-    "scaleDown": {
-      "type": "boolean",
-      "default": false
-    },
-    "isDetached": {
-      "type": "boolean",
-      "default": false
-    },
-    "state": {
-      "type": "string",
-      "enum": ["default", "hover", "keyboard focus"],
-      "default": "default"
-    }
-  }
-}

package/schemas/components/search-field.json

@@ -1,58 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/search-field.json",
-  "title": "Search field",
-  "description": "A search field is used for searching and filtering items.",
-  "meta": {
-    "category": "inputs",
-    "documentationUrl": "https://spectrum.adobe.com/page/search-field/"
-  },
-  "type": "object",
-  "properties": {
-    "label": {
-      "type": "string"
-    },
-    "hideLabel": {
-      "type": "boolean",
-      "default": false
-    },
-    "icon": {
-      "$ref": "https://opensource.adobe.com/spectrum-design-data/schemas/types/workflow-icon.json",
-      "description": "Icon must be present if the label is not defined."
-    },
-    "value": {
-      "type": "string"
-    },
-    "width": {
-      "type": "number"
-    },
-    "size": {
-      "type": "string",
-      "enum": ["s", "m", "l", "xl"],
-      "default": "m",
-      "pattern": "^(x?s|m|x{0,3}l)$"
-    },
-    "helpText": {
-      "type": "string"
-    },
-    "placeholder": {
-      "type": "string"
-    },
-    "isDisabled": {
-      "type": "boolean",
-      "default": false
-    },
-    "state": {
-      "type": "string",
-      "enum": [
-        "default",
-        "down",
-        "hover",
-        "focus + hover",
-        "focus + not hover",
-        "keyboard focus"
-      ],
-      "default": "default"
-    }
-  }
-}