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

package/schemas/components/table.json

@@ -1,118 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/table.json",
-  "title": "Table",
-  "description": "Tables display information in rows and columns, allowing users to compare and scan structured data.",
-  "meta": {
-    "category": "data visualization",
-    "documentationUrl": "https://spectrum.adobe.com/page/table/"
-  },
-  "type": "object",
-  "properties": {
-    "size": {
-      "type": "string",
-      "enum": ["s", "m", "l"],
-      "default": "m",
-      "description": "Controls the density of table rows."
-    },
-    "hideHeader": {
-      "type": "boolean",
-      "default": false,
-      "description": "If true, the table header is hidden."
-    },
-    "header": {
-      "type": "object",
-      "description": "Configuration for the table header row.",
-      "properties": {
-        "alignment": {
-          "type": "string",
-          "enum": ["left", "right"],
-          "default": "left",
-          "description": "Alignment of the table header text."
-        },
-        "state": {
-          "type": "string",
-          "enum": ["default", "hover", "down", "keyboard focus"],
-          "default": "default",
-          "description": "Interaction state of the header row."
-        }
-      }
-    },
-    "density": {
-      "type": "string",
-      "enum": ["compact", "regular", "spacious"],
-      "default": "regular"
-    },
-    "isQuiet": {
-      "type": "boolean",
-      "default": false,
-      "description": "If true, the table uses a quiet visual style."
-    },
-    "isSortable": {
-      "type": "boolean",
-      "default": false,
-      "description": "If true, table columns can be sorted."
-    },
-    "columns": {
-      "type": "array",
-      "description": "An array of column definitions for the table.",
-      "items": {
-        "type": "object",
-        "properties": {
-          "key": {
-            "type": "string",
-            "description": "Unique identifier for the column."
-          },
-          "label": {
-            "type": "string",
-            "description": "The header text displayed for the column."
-          },
-          "type": {
-            "type": "string",
-            "enum": [
-              "text",
-              "number",
-              "avatar",
-              "date",
-              "sparkline",
-              "select",
-              "layout"
-            ],
-            "default": "text",
-            "description": "Defines the data type for the column."
-          },
-          "resizing": {
-            "type": "string",
-            "enum": ["fluid", "fixed"],
-            "default": "fluid",
-            "description": "Defines whether the column width is fluid or fixed."
-          },
-          "summary placement": {
-            "type": "string",
-            "enum": ["top", "bottom"],
-            "default": "bottom",
-            "description": "Placement of the summary row for this column, if applicable."
-          },
-          "summary text": {
-            "type": "string",
-            "description": "Text to display in the summary row for this column, if applicable."
-          },
-          "isSortable": {
-            "type": "boolean",
-            "default": false,
-            "description": "Whether this column is sortable."
-          }
-        },
-        "required": ["key", "label", "type"]
-      }
-    },
-    "rows": {
-      "type": "array",
-      "description": "An array of row data for the table.",
-      "items": {
-        "type": "object",
-        "description": "Each object represents a single row, keyed by column IDs."
-      }
-    }
-  }
-}

package/schemas/components/tabs.json

@@ -1,75 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/tabs.json",
-  "title": "Tabs",
-  "description": "Tabs organize content into multiple sections and allow users to navigate between them. The content under the set of tabs should be related and form a coherent unit.",
-  "meta": {
-    "category": "navigation",
-    "documentationUrl": "https://spectrum.adobe.com/page/tabs/"
-  },
-  "type": "object",
-  "properties": {
-    "orientation": {
-      "type": "string",
-      "enum": ["horizontal", "vertical"],
-      "default": "horizontal"
-    },
-    "items": {
-      "type": "array",
-      "description": "An array of tab items.",
-      "items": {
-        "type": "object",
-        "properties": {
-          "label": {
-            "type": "string",
-            "description": "The text displayed for the tab item."
-          },
-          "isDisabled": {
-            "type": "boolean",
-            "default": false,
-            "description": "Whether the tab is disabled."
-          },
-          "state": {
-            "type": "string",
-            "enum": ["default", "hover", "keyboard focus"],
-            "default": "default",
-            "description": "The interaction state of the tab item."
-          },
-          "contentVariant": {
-            "type": "string",
-            "enum": ["label-only", "icon-only", "icon-label"],
-            "default": "icon-label",
-            "description": "Controls whether the tab displays a label, an icon, or both."
-          },
-          "density": {
-            "type": "string",
-            "enum": ["compact", "regular"],
-            "default": "regular"
-          },
-          "isFluid": {
-            "type": "boolean",
-            "default": false,
-            "description": "This overrides density and is only applicable to horizontal tabs."
-          },
-          "isEmphasized": {
-            "type": "boolean",
-            "default": false
-          },
-          "alignment": {
-            "type": "string",
-            "enum": ["start", "center"],
-            "default": "start"
-          },
-          "selectedItem": {
-            "description": "(list of available items)"
-          },
-          "keyboardActivation": {
-            "type": "string",
-            "enum": ["manual", "automatic"],
-            "default": "manual"
-          }
-        }
-      }
-    }
-  }
-}

package/schemas/components/tag-field.json

@@ -1,42 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/tag-field.json",
-  "title": "Tag field",
-  "description": "A tag field is an input field that allows users to enter and manage tags.",
-  "meta": {
-    "category": "inputs",
-    "documentationUrl": "https://spectrum.adobe.com/page/tag-field/"
-  },
-  "type": "object",
-  "properties": {
-    "size": {
-      "type": "string",
-      "enum": ["s", "m", "l"],
-      "default": "m"
-    },
-    "state": {
-      "type": "string",
-      "enum": [
-        "default",
-        "hover",
-        "focus + hover",
-        "focus + not hover",
-        "keyboard focus"
-      ],
-      "default": "default"
-    },
-    "style": {
-      "type": "string",
-      "enum": ["keyword", "icon", "thumbnail", "avatar"],
-      "default": "keyword"
-    },
-    "isDisabled": {
-      "type": "boolean",
-      "default": false
-    },
-    "hideLabel": {
-      "type": "boolean",
-      "default": false
-    }
-  }
-}

package/schemas/components/tag-group.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/tag-group.json",
-  "title": "Tag group",
-  "description": "A tag group is a collection of tags that represent a set of related items.",
-  "meta": {
-    "category": "inputs",
-    "documentationUrl": "https://spectrum.adobe.com/page/tag-group/"
-  },
-  "type": "object",
-  "properties": {
-    "size": {
-      "type": "string",
-      "enum": ["s", "m", "l"],
-      "default": "m"
-    },
-    "labelPosition": {
-      "type": "string",
-      "enum": ["top", "side"],
-      "default": "top"
-    },
-    "hideLabel": {
-      "type": "boolean",
-      "default": false
-    },
-    "actionLabel": {
-      "type": "string",
-      "description": "If undefined, this button does not appear."
-    }
-  }
-}

package/schemas/components/tag.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/tag.json",
-  "title": "Tag",
-  "description": "Tags allow users to categorize content. They can represent keywords or people, and are grouped to describe an item or a search request.",
-  "meta": {
-    "category": "navigation",
-    "documentationUrl": "https://spectrum.adobe.com/page/tag/"
-  },
-  "type": "object",
-  "properties": {
-    "label": {
-      "type": "string"
-    },
-    "hasAvatar": {
-      "type": "boolean",
-      "default": false
-    },
-    "isRemovable": {
-      "type": "boolean",
-      "default": false
-    },
-    "isError": {
-      "type": "boolean",
-      "default": false
-    },
-    "isDisabled": {
-      "type": "boolean",
-      "default": false
-    },
-    "isReadOnly": {
-      "type": "boolean",
-      "default": false
-    },
-    "state": {
-      "type": "string",
-      "enum": ["default", "hover", "down", "keyboard focus"],
-      "default": "default"
-    }
-  }
-}

package/schemas/components/takeover-dialog.json

@@ -1,54 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/takeover-dialog.json",
-  "title": "Takeover dialog",
-  "description": "Takeover dialogs are larger, flexible dialogs that contain other components to support complex workflows.",
-  "meta": {
-    "category": "feedback",
-    "documentationUrl": "https://spectrum.adobe.com/page/takeover-dialog/"
-  },
-  "type": "object",
-  "properties": {
-    "title": {
-      "type": "string"
-    },
-    "description": {
-      "type": "string"
-    },
-    "variant": {
-      "type": "string",
-      "enum": ["dialog", "full screen"],
-      "default": "dialog"
-    },
-    "primaryActionLabel": {
-      "type": "string"
-    },
-    "secondaryActionLabel": {
-      "type": "string",
-      "description": "If undefined, this button does not appear."
-    },
-    "cancelActionLabel": {
-      "type": "string",
-      "default": "cancel",
-      "description": "If undefined, this button does not appear."
-    },
-    "slots": {
-      "type": "array",
-      "description": "Areas where other components can be inserted (e.g. Side navigation, Steplist, Forms).",
-      "items": {
-        "type": "object",
-        "properties": {
-          "name": {
-            "type": "string",
-            "description": "Identifier for the slot (e.g. 'sidebar', 'content', 'footer')."
-          },
-          "component": {
-            "type": "string",
-            "description": "The type of component placed in this slot (e.g. side-navigation, steplist, form)."
-          }
-        },
-        "required": ["name", "component"]
-      }
-    }
-  }
-}

package/schemas/components/text-area.json

@@ -1,92 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/text-area.json",
-  "title": "Text area",
-  "description": "A text area lets a user input a longer amount of text than a standard text field. It can include all of the standard validation options supported by the text field component.",
-  "meta": {
-    "category": "inputs",
-    "documentationUrl": "https://spectrum.adobe.com/page/text-area/"
-  },
-  "type": "object",
-  "properties": {
-    "label": {
-      "type": "string"
-    },
-    "labelPosition": {
-      "type": "string",
-      "default": "top",
-      "enum": ["top", "side"]
-    },
-    "hideLabel": {
-      "type": "boolean",
-      "default": false
-    },
-    "value": {
-      "type": "string",
-      "description": "from minValue to maxValue"
-    },
-    "width": {
-      "type": "number"
-    },
-    "size": {
-      "type": "string",
-      "enum": ["s", "m", "l", "xl"],
-      "default": "m"
-    },
-    "necessityIndicator": {
-      "type": "string",
-      "enum": ["text", "icon"],
-      "default": "icon"
-    },
-    "isRequired": {
-      "type": "boolean",
-      "default": false
-    },
-    "hasCharacterCount": {
-      "type": "boolean",
-      "default": false
-    },
-    "showValidIcon": {
-      "type": "boolean",
-      "default": false
-    },
-    "isError": {
-      "type": "boolean",
-      "default": false
-    },
-    "isDisabled": {
-      "type": "boolean",
-      "default": false
-    },
-    "hideDragIcon": {
-      "type": "boolean",
-      "default": false
-    },
-    "height": {
-      "type": "number",
-      "description": "If undefined, height is dynamic and grows with input text."
-    },
-    "helpText": {
-      "type": "string"
-    },
-    "errorMessage": {
-      "type": "string"
-    },
-    "inputType": {
-      "type": "string",
-      "enum": ["text", "url", "phone", "email", "password"],
-      "default": "text"
-    },
-    "state": {
-      "type": "string",
-      "enum": [
-        "default",
-        "hover",
-        "focus + hover",
-        "focus + not hover",
-        "keyboard focus"
-      ],
-      "default": "default"
-    }
-  }
-}

package/schemas/components/text-field.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/text-field.json",
-  "title": "Text field",
-  "description": "Text fields allow users to input custom text entries with a keyboard. Various options can be shown with the field to communicate the input requirements.",
-  "meta": {
-    "category": "inputs",
-    "documentationUrl": "https://spectrum.adobe.com/page/text-field/"
-  },
-  "type": "object",
-  "properties": {
-    "label": {
-      "type": "string"
-    },
-    "labelPosition": {
-      "type": "string",
-      "default": "top",
-      "enum": ["top", "side"]
-    },
-    "hideLabel": {
-      "type": "boolean",
-      "default": false
-    },
-    "value": {
-      "type": "string",
-      "description": "from minValue to maxValue"
-    },
-    "width": {
-      "type": "number"
-    },
-    "size": {
-      "type": "string",
-      "enum": ["s", "m", "l", "xl"],
-      "default": "m"
-    },
-    "necessityIndicator": {
-      "type": "string",
-      "enum": ["text", "icon"],
-      "default": "icon"
-    },
-    "isRequired": {
-      "type": "boolean",
-      "default": false
-    },
-    "hasCharacterCount": {
-      "type": "boolean",
-      "default": false
-    },
-    "showValidIcon": {
-      "type": "boolean",
-      "default": false
-    },
-    "isError": {
-      "type": "boolean",
-      "default": false,
-      "description": "If there is an error, this property overrides show valid icon."
-    },
-    "isDisabled": {
-      "type": "boolean",
-      "default": false
-    },
-    "helpText": {
-      "type": "string"
-    },
-    "errorMessage": {
-      "type": "string"
-    },
-    "state": {
-      "type": "string",
-      "enum": [
-        "default",
-        "hover",
-        "focus + hover",
-        "focus + not hover",
-        "keyboard focus"
-      ],
-      "default": "default"
-    }
-  }
-}

package/schemas/components/thumbnail.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/thumbnail.json",
-  "title": "Thumbnail",
-  "description": "Thumbnails are small representations of images or content used for previews and navigation in galleries, lists, and media collections.",
-  "meta": {
-    "category": "navigation",
-    "documentationUrl": "https://spectrum.adobe.com/page/thumbnail/"
-  },
-  "type": "object",
-  "properties": {
-    "size": {
-      "type": "number",
-      "enum": [50, 75, 100, 200, 300, 400, 500, 600, 700, 800, 900, 1000]
-    },
-    "state": {
-      "type": "string",
-      "enum": ["default", "disabled"],
-      "default": "default"
-    }
-  }
-}

package/schemas/components/toast.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/toast.json",
-  "title": "Toast",
-  "description": "Toasts display brief, temporary notifications. They're meant to be noticed without disrupting a user's experience or requiring an action to be taken.",
-  "meta": {
-    "category": "feedback",
-    "documentationUrl": "https://spectrum.adobe.com/page/toast/"
-  },
-  "type": "object",
-  "properties": {
-    "text": {
-      "type": "string"
-    },
-    "variant": {
-      "type": "string",
-      "enum": ["neutral", "informative", "positive", "negative"],
-      "default": "neutral"
-    },
-    "actionLabel": {
-      "type": "string",
-      "description": "If undefined, this button does not appear."
-    },
-    "isAutoDismissible": {
-      "type": "boolean",
-      "default": false
-    }
-  }
-}

package/schemas/components/tooltip.json

@@ -1,50 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/tooltip.json",
-  "title": "Tooltip",
-  "description": "Tooltips show contextual help or information about specific components when a user hovers or focuses on them.",
-  "meta": {
-    "category": "feedback",
-    "documentationUrl": "https://spectrum.adobe.com/page/tooltip/"
-  },
-  "type": "object",
-  "properties": {
-    "label": {
-      "type": "string"
-    },
-    "variant": {
-      "type": "string",
-      "enum": ["neutral", "informative", "negative"],
-      "default": "neutral"
-    },
-    "hasIcon": {
-      "type": "boolean",
-      "description": "If the neutral variant, there is never an icon.",
-      "default": false
-    },
-    "maxWidth": {
-      "type": "number",
-      "default": 160,
-      "description": "units: pixels"
-    },
-    "placement": {
-      "type": "string",
-      "enum": ["top", "bottom", "left", "right"],
-      "default": "top"
-    },
-    "shouldFlip": {
-      "type": "boolean",
-      "default": false
-    },
-    "offset": {
-      "type": "number",
-      "default": 4,
-      "description": "units: pixels"
-    },
-    "containerPadding": {
-      "type": "number",
-      "default": 8,
-      "description": "units: pixels"
-    }
-  }
-}

package/schemas/components/tray.json

@@ -1,17 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/tray.json",
-  "title": "Tray",
-  "description": "Trays are containers that display transient content such as menus, options, additional actions, and more. They only exist on mobile experiences and are used for exposing types of content that may be too overwhelming for popovers.",
-  "meta": {
-    "category": "containers",
-    "documentationUrl": "https://spectrum.adobe.com/page/tray/"
-  },
-  "type": "object",
-  "properties": {
-    "height": {
-      "type": "string",
-      "default": "auto"
-    }
-  }
-}