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

package/schemas/components/date-picker.json

@@ -1,157 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/date-picker.json",
-  "title": "Date picker",
-  "description": "A date picker lets users enter a single date or a date range. It includes a calendar popover and a field.",
-  "meta": {
-    "category": "inputs",
-    "documentationUrl": "https://spectrum.adobe.com/page/date-picker/"
-  },
-  "type": "object",
-  "properties": {
-    "variant": {
-      "type": "string",
-      "enum": ["single", "double", "triple"],
-      "default": "single",
-      "description": "Controls the number of months displayed in the calendar popover."
-    },
-    "selectedDate": {
-      "type": "string",
-      "description": "The currently selected date. Used when selectionMode is single."
-    },
-    "selectedRange": {
-      "type": "object",
-      "description": "The currently selected date range, used when selectionMode is range.",
-      "properties": {
-        "start": {
-          "type": "string",
-          "description": "Range start date."
-        },
-        "end": {
-          "type": "string",
-          "description": "Range end date."
-        }
-      }
-    },
-    "dateField": {
-      "type": "object",
-      "description": "Configuration for the date input field.",
-      "properties": {
-        "label": {
-          "type": "string",
-          "description": "Optional text label displayed with the date field."
-        },
-        "labelPosition": {
-          "type": "string",
-          "enum": ["top", "side"],
-          "default": "top"
-        },
-        "hideLabel": {
-          "type": "boolean",
-          "default": false
-        },
-        "isDisabled": {
-          "type": "boolean",
-          "default": false
-        },
-        "isReadOnly": {
-          "type": "boolean",
-          "default": false
-        },
-        "isRequired": {
-          "type": "boolean",
-          "default": false
-        },
-        "isError": {
-          "type": "boolean",
-          "default": false,
-          "description": "If there is an error, this property overrides show valid icon."
-        },
-        "state": {
-          "type": "string",
-          "enum": [
-            "default",
-            "hover",
-            "hover (in-field button)",
-            "focus + hover",
-            "focus + open",
-            "focus + not hover",
-            "keyboard focus"
-          ],
-          "default": "default"
-        }
-      }
-    },
-    "calendarPopover": {
-      "type": "object",
-      "description": "Configuration for the calendar popover.",
-      "properties": {
-        "isDisabled": {
-          "type": "boolean",
-          "default": false
-        },
-        "minValue": {
-          "type": "string",
-          "description": "The minimum allowed date that a user may select."
-        },
-        "maxValue": {
-          "type": "string",
-          "description": "The maximum allowed date that a user may select (ISO format string)."
-        },
-        "currentMonth": {
-          "type": "number",
-          "minimum": 1,
-          "maximum": 12,
-          "description": "The month currently displayed in the calendar (1 = January, 12 = December)."
-        },
-        "currentYear": {
-          "type": "number",
-          "description": "The year currently displayed in the calendar (Gregorian year number)."
-        },
-        "selectionMode": {
-          "type": "string",
-          "enum": ["single", "range"],
-          "default": "single",
-          "description": "Controls whether the calendar allows selecting a single date or a date range."
-        },
-        "showTimeZone": {
-          "type": "boolean",
-          "default": false,
-          "description": "Whether to show a time zone indicator in the popover."
-        },
-        "isError": {
-          "type": "boolean",
-          "default": false,
-          "description": "If the calendar popover is in an error state."
-        },
-        "timeFields": {
-          "type": "object",
-          "description": "Optional start and end time fields displayed within the calendar popover.",
-          "properties": {
-            "showStartTime": {
-              "type": "boolean",
-              "default": false,
-              "description": "If true, displays a start time field."
-            },
-            "showEndTime": {
-              "type": "boolean",
-              "default": false,
-              "description": "If true, displays an end time field."
-            },
-            "granularity": {
-              "type": "string",
-              "enum": ["hour", "minute", "second"],
-              "default": "minute",
-              "description": "The level of time granularity for the time fields."
-            },
-            "is24Hour": {
-              "type": "boolean",
-              "default": false,
-              "description": "If true, displays time in 24-hour format instead of AM/PM."
-            }
-          }
-        }
-      }
-    }
-  }
-}

package/schemas/components/detail.json

@@ -1,26 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/detail.json",
-  "title": "Detail",
-  "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/detail/"
-  },
-  "type": "object",
-  "properties": {
-    "script": {
-      "$ref": "https://opensource.adobe.com/spectrum-design-data/schemas/types/typography-script.json"
-    },
-    "weight": {
-      "type": "string",
-      "enum": ["light", "default"],
-      "default": "default"
-    },
-    "size": {
-      "type": "string",
-      "enum": ["s", "m", "l", "xl"],
-      "default": "m"
-    }
-  }
-}

package/schemas/components/divider.json

@@ -1,23 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/divider.json",
-  "title": "Divider",
-  "description": "Dividers bring clarity to a layout by grouping and dividing content in close proximity. They can also be used to establish rhythm and hierarchy.",
-  "meta": {
-    "category": "containers",
-    "documentationUrl": "https://spectrum.adobe.com/page/divider/"
-  },
-  "type": "object",
-  "properties": {
-    "size": {
-      "type": "string",
-      "enum": ["s", "m", "l"],
-      "default": "s"
-    },
-    "orientation": {
-      "type": "string",
-      "enum": ["horizontal", "vertical"],
-      "default": "horizontal"
-    }
-  }
-}

package/schemas/components/drop-zone.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/drop-zone.json",
-  "title": "Drop zone",
-  "description": "A drop zone allows users to drag and drop files or other content into a designated area.",
-  "meta": {
-    "category": "inputs",
-    "documentationUrl": "https://spectrum.adobe.com/page/drop-zone/"
-  },
-  "type": "object",
-  "properties": {
-    "accept": {
-      "type": "array",
-      "items": {
-        "type": "string",
-        "description": "File types that are accepted by the drop zone."
-      }
-    },
-    "size": {
-      "type": "string",
-      "enum": ["s", "m", "l"],
-      "default": "m"
-    },
-    "actionLabel": {
-      "type": "string",
-      "description": "If undefined, this button does not appear."
-    },
-    "onDrop": {
-      "type": "string",
-      "description": "Callback function called when files are dropped onto the drop zone."
-    },
-    "onDragOver": {
-      "type": "string",
-      "description": "Callback function called when a file is dragged over the drop zone."
-    },
-    "onDragLeave": {
-      "type": "string",
-      "description": "Callback function called when a file is dragged out of the drop zone."
-    }
-  }
-}

package/schemas/components/field-label.json

@@ -1,39 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/field-label.json",
-  "title": "Field label",
-  "description": "Field labels give context to the information that a user needs to input. They're commonly used in forms.",
-  "meta": {
-    "category": "inputs",
-    "documentationUrl": "https://spectrum.adobe.com/page/field-label/"
-  },
-  "type": "object",
-  "properties": {
-    "label": {
-      "type": "string"
-    },
-    "labelPosition": {
-      "type": "string",
-      "enum": ["top", "side"],
-      "default": "top"
-    },
-    "size": {
-      "type": "string",
-      "enum": ["s", "m", "l", "xl"],
-      "default": "m"
-    },
-    "necessityIndicator": {
-      "type": "string",
-      "enum": ["text", "icon"],
-      "default": "icon"
-    },
-    "isRequired": {
-      "type": "boolean",
-      "default": false
-    },
-    "isDisabled": {
-      "type": "boolean",
-      "default": false
-    }
-  }
-}

package/schemas/components/heading.json

@@ -1,29 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/heading.json",
-  "title": "Heading",
-  "description": "Heading is a typography component used to create various levels of hierarchies between text.",
-  "meta": {
-    "category": "typography",
-    "documentationUrl": "https://spectrum.adobe.com/page/heading/"
-  },
-  "type": "object",
-  "properties": {
-    "script": {
-      "$ref": "https://opensource.adobe.com/spectrum-design-data/schemas/types/typography-script.json"
-    },
-    "classification": {
-      "$ref": "https://opensource.adobe.com/spectrum-design-data/schemas/types/typography-classification.json"
-    },
-    "weight": {
-      "type": "string",
-      "enum": ["light", "default", "heavy"],
-      "default": "default"
-    },
-    "size": {
-      "type": "string",
-      "enum": ["xs", "s", "m", "l", "xl", "xxl", "xxxl"],
-      "default": "m"
-    }
-  }
-}

package/schemas/components/help-text.json

@@ -1,36 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/help-text.json",
-  "title": "Help text",
-  "description": "Help text provides either an informative description or an error message that gives more context about what a user needs to input. It’s commonly used in forms.",
-  "meta": {
-    "category": "inputs",
-    "documentationUrl": "https://spectrum.adobe.com/page/help-text/"
-  },
-  "type": "object",
-  "properties": {
-    "text": {
-      "type": "string"
-    },
-    "variant": {
-      "type": "string",
-      "enum": ["neutral", "negative"],
-      "default": "neutral"
-    },
-    "hideIcon": {
-      "type": "boolean",
-      "default": false,
-      "description": "Only applicable if variant is negative."
-    },
-    "size": {
-      "type": "string",
-      "enum": ["s", "m", "l", "xl"],
-      "default": "m"
-    },
-    "isDisabled": {
-      "type": "boolean",
-      "default": false,
-      "description": "Help text cannot be both disabled and negative variant."
-    }
-  }
-}

package/schemas/components/illustrated-message.json

@@ -1,45 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/illustrated-message.json",
-  "title": "Illustrated message",
-  "description": "An illustrated message displays an illustration with a short title and description, often used for empty states or error states.",
-  "meta": {
-    "category": "feedback",
-    "documentationUrl": "https://spectrum.adobe.com/page/illustrated-message/"
-  },
-  "type": "object",
-  "properties": {
-    "illustration": {
-      "type": "string",
-      "description": "Optional illustration or icon displayed above the message."
-    },
-    "size": {
-      "type": "string",
-      "enum": ["s", "m", "l"],
-      "default": "m",
-      "description": "Size of the illustration."
-    },
-    "orientation": {
-      "type": "string",
-      "enum": ["vertical", "horizontal"],
-      "default": "vertical",
-      "description": "Orientation of the illustrated message."
-    },
-    "title": {
-      "type": "string",
-      "description": "Primary heading text of the message."
-    },
-    "description": {
-      "type": "string",
-      "description": "Secondary descriptive text providing context or instructions."
-    },
-    "primaryActionLabel": {
-      "type": "string",
-      "description": "Label for the primary action button. If undefined, no primary action is shown."
-    },
-    "secondaryActionLabel": {
-      "type": "string",
-      "description": "Label for the secondary action button. If undefined, no secondary action is shown."
-    }
-  }
-}

package/schemas/components/in-field-progress-button.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/in-field-progress-button.json",
-  "title": "In field progress button",
-  "description": "In field progress buttons provide interactive controls within form fields for actions like clearing, adding, or disclosing additional content.",
-  "meta": {
-    "category": "actions",
-    "documentationUrl": "https://spectrum.adobe.com/page/in-field-progress-button/"
-  },
-  "type": "object",
-  "properties": {
-    "size": {
-      "type": "string",
-      "enum": ["s", "m", "l", "xl"],
-      "default": "m"
-    },
-    "state": {
-      "type": "string",
-      "enum": ["default", "hover", "down", "keyboard focus"],
-      "default": "default"
-    },
-    "style": {
-      "type": "string",
-      "enum": ["disclosure", "clear", "dash", "add"]
-    },
-    "isQuiet": {
-      "type": "boolean",
-      "default": false
-    }
-  }
-}

package/schemas/components/in-field-progress-circle.json

@@ -1,22 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/in-field-progress-circle.json",
-  "title": "In field progress circle",
-  "description": "In field progress circles indicate progress for loading states within form fields and input areas.",
-  "meta": {
-    "category": "feedback",
-    "documentationUrl": "https://spectrum.adobe.com/page/in-field-progress-circle/"
-  },
-  "type": "object",
-  "properties": {
-    "size": {
-      "type": "string",
-      "enum": ["s", "m", "l", "xl"],
-      "default": "m"
-    },
-    "staticColor": {
-      "type": "string",
-      "enum": ["white", "black"]
-    }
-  }
-}

package/schemas/components/in-line-alert.json

@@ -1,43 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/in-line-alert.json",
-  "title": "In-line alert",
-  "description": "In-line alerts display a non-modal message associated with objects in a view. These are often used in form validation, providing a place to aggregate feedback related to multiple fields.",
-  "meta": {
-    "category": "feedback",
-    "documentationUrl": "https://spectrum.adobe.com/page/in-line-alert/"
-  },
-  "type": "object",
-  "properties": {
-    "variant": {
-      "type": "string",
-      "enum": [
-        "neutral",
-        "informative",
-        "positive",
-        "notice",
-        "negative",
-        "accent"
-      ],
-      "default": "neutral"
-    },
-    "style": {
-      "type": "string",
-      "enum": ["bold", "subtle", "outline"],
-      "default": "outline",
-      "description": "The visual style of the alert."
-    },
-    "href": {
-      "type": "string",
-      "description": "Optional URL within in-line alert content like a 'Learn more' link."
-    },
-    "heading": {
-      "type": "string",
-      "description": "Optional heading text displayed at the top of the alert."
-    },
-    "actionLabel": {
-      "type": "string",
-      "description": "If undefined, this button does not appear."
-    }
-  }
-}

package/schemas/components/link.json

@@ -1,32 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/link.json",
-  "title": "Link",
-  "description": "Links allow users to navigate to a different location. They can be presented inside a paragraph or as standalone text.",
-  "meta": {
-    "category": "actions",
-    "documentationUrl": "https://spectrum.adobe.com/page/link/"
-  },
-  "type": "object",
-  "properties": {
-    "variant": {
-      "type": "string",
-      "enum": ["primary", "secondary"],
-      "default": "primary"
-    },
-    "isQuiet": {
-      "type": "boolean",
-      "default": false
-    },
-    "staticColor": {
-      "type": "string",
-      "enum": ["white", "black"],
-      "description": "Static color must not be set for the default version of this component."
-    },
-    "state": {
-      "type": "string",
-      "enum": ["default", "hover", "down", "keyboard focus"],
-      "default": "default"
-    }
-  }
-}

package/schemas/components/list-view.json

@@ -1,89 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/list-view.json",
-  "title": "List view",
-  "description": "List views display rows of data or options that users can browse, select, and interact with.",
-  "meta": {
-    "category": "navigation",
-    "documentationUrl": "https://spectrum.adobe.com/page/list-view/"
-  },
-  "type": "object",
-  "properties": {
-    "selectionMode": {
-      "type": "string",
-      "enum": ["none", "single", "multiple"],
-      "default": "single",
-      "description": "Defines how many items can be selected at once."
-    },
-    "isQuiet": {
-      "type": "boolean",
-      "default": false,
-      "description": "If true, the list view uses a quiet visual style."
-    },
-    "items": {
-      "type": "array",
-      "description": "An array of list view items.",
-      "items": {
-        "type": "object",
-        "properties": {
-          "label": {
-            "type": "string",
-            "description": "Primary text displayed for the item."
-          },
-          "description": {
-            "type": "string",
-            "description": "Secondary text displayed under the label (optional)."
-          },
-          "hideCheckbox": {
-            "type": "boolean",
-            "default": false,
-            "description": "If true, the checkbox is hidden."
-          },
-          "hideDragHandle": {
-            "type": "boolean",
-            "default": false,
-            "description": "If true, the drag handle is hidden."
-          },
-          "hideNavigationIndicator": {
-            "type": "boolean",
-            "default": false,
-            "description": "If true, the navigation indicator is hidden."
-          },
-          "isDisabled": {
-            "type": "boolean",
-            "default": false,
-            "description": "If true, the item is disabled."
-          },
-          "isSelected": {
-            "type": "boolean",
-            "default": false,
-            "description": "If true, the item is selected."
-          },
-          "overflowMode": {
-            "type": "string",
-            "enum": ["wrap", "truncate"],
-            "default": "truncate",
-            "description": "Defines how text should behave when it overflows the available space."
-          },
-          "itemRounding": {
-            "type": "string",
-            "enum": ["none", "top", "bottom"],
-            "default": "none",
-            "description": "Defines the border radius of the list view item."
-          },
-          "isEmphasized": {
-            "type": "boolean",
-            "default": false
-          },
-          "state": {
-            "type": "string",
-            "enum": ["default", "hover", "dragged"],
-            "default": "default",
-            "description": "The interaction state of the list view item."
-          }
-        },
-        "required": ["label"]
-      }
-    }
-  }
-}