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

package/schemas/components/breadcrumbs.json

@@ -1,72 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-tokens/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-tokens/schemas/components/breadcrumbs.json",
-  "title": "Breadcrumbs",
-  "description": "Breadcrumbs show hierarchy and navigational context for a user’s location within an app.",
-  "meta": {
-    "category": "navigation",
-    "documentationUrl": "https://spectrum.adobe.com/page/breadcrumbs/"
-  },
-  "type": "object",
-  "properties": {
-    "state": {
-      "type": "string",
-      "enum": ["default", "hover", "down", "keyboard focus", "drag and drop"],
-      "default": "default"
-    },
-    "isMultiline": {
-      "type": "boolean",
-      "default": false,
-      "description": "If true, the breadcrumb items will wrap to multiple lines."
-    },
-    "size": {
-      "type": "string",
-      "enum": ["m", "l"],
-      "default": "m",
-      "description": "Controls the overall size of the breadcrumb component."
-    },
-    "items": {
-      "type": "array",
-      "description": "An array of breadcrumb items.",
-      "items": {
-        "type": "object",
-        "properties": {
-          "label": {
-            "type": "string",
-            "description": "The text displayed for the breadcrumb item."
-          },
-          "href": {
-            "type": "string",
-            "description": "Optional URL the breadcrumb item links to."
-          },
-          "isCurrent": {
-            "type": "boolean",
-            "description": "Indicates if the breadcrumb item represents the current page.",
-            "default": false
-          },
-          "isDisabled": {
-            "type": "boolean",
-            "default": false
-          }
-        },
-        "required": ["label"]
-      }
-    },
-    "separator": {
-      "type": "string",
-      "enum": ["chevron", "none"],
-      "default": "chevron",
-      "description": "The separator icon used between breadcrumb items."
-    },
-    "isTruncated": {
-      "type": "boolean",
-      "default": false,
-      "description": "If true, the breadcrumb item is truncated and displayed as icon only."
-    },
-    "sizeOverride": {
-      "type": "string",
-      "enum": ["s", "m", "l", "xl"],
-      "description": "Overrides the size of the breadcrumb items when isMultiline is true."
-    }
-  }
-}

package/schemas/components/button-group.json

@@ -1,33 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-tokens/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-tokens/schemas/components/button-group.json",
-  "title": "Button group",
-  "description": "A button group is a grouping of buttons whose actions are related to each other.",
-  "meta": {
-    "category": "actions",
-    "documentationUrl": "https://spectrum.adobe.com/page/button-group/"
-  },
-  "type": "object",
-  "properties": {
-    "orientation": {
-      "type": "string",
-      "default": "horizontal",
-      "enum": ["horizontal", "vertical"]
-    },
-    "size": {
-      "type": "string",
-      "pattern": "^(x?s|m|x{0,3}l)$",
-      "enum": ["s", "m", "l", "xl"],
-      "default": "m"
-    },
-    "overflowMode": {
-      "type": "string",
-      "enum": ["wrap", "collapse"],
-      "default": "wrap"
-    },
-    "isDisabled": {
-      "type": "boolean",
-      "default": false
-    }
-  }
-}

package/schemas/components/button.json

@@ -1,61 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-tokens/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-tokens/schemas/components/button.json",
-  "title": "Button",
-  "description": "Buttons allow users to perform an action or to navigate to another page. They have multiple styles for various needs, and are ideal for calling attention to where a user needs to do something in order to move forward in a flow.",
-  "meta": {
-    "category": "actions",
-    "documentationUrl": "https://spectrum.adobe.com/page/button/"
-  },
-  "type": "object",
-  "properties": {
-    "label": {
-      "type": "string"
-    },
-    "hideLabel": {
-      "type": "boolean",
-      "default": false
-    },
-    "icon": {
-      "$ref": "https://opensource.adobe.com/spectrum-tokens/schemas/types/workflow-icon.json",
-      "description": "Icon must be present if the label is not defined."
-    },
-    "variant": {
-      "type": "string",
-      "enum": ["accent", "negative", "primary", "secondary"],
-      "default": "accent"
-    },
-    "staticColor": {
-      "type": "string",
-      "enum": ["white", "black"],
-      "description": "Static color must not be set for the default version of this component."
-    },
-    "style": {
-      "type": "string",
-      "default": "fill",
-      "enum": ["fill", "outline"]
-    },
-    "size": {
-      "type": "string",
-      "enum": ["s", "m", "l", "xl"],
-      "default": "m"
-    },
-    "justified": {
-      "type": "boolean",
-      "default": false
-    },
-    "isPending": {
-      "type": "boolean",
-      "default": false
-    },
-    "isDisabled": {
-      "type": "boolean",
-      "default": false
-    },
-    "state": {
-      "type": "string",
-      "enum": ["default", "hover", "down", "keyboard focus"],
-      "default": "default"
-    }
-  }
-}

package/schemas/components/calendar.json

@@ -1,109 +0,0 @@
-{
-    "$schema": "https://opensource.adobe.com/spectrum-tokens/schemas/component.json",
-    "$id": "https://opensource.adobe.com/spectrum-tokens/schemas/components/calendar.json",
-    "title": "Calendar",
-    "description": "Calendars display days, weeks, and months, allowing users to select dates or ranges.",
-    "meta": {
-        "category": "inputs",
-        "documentationUrl": "https://spectrum.adobe.com/page/calendar/"
-    },
-    "type": "object",
-    "properties": {
-        "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."
-        },
-        "isDisabled": {
-            "type": "boolean",
-            "default": false
-        },
-        "isError": {
-            "type": "boolean",
-            "default": false
-        },
-        "minValue": {
-            "type": "string",
-            "description": "The minimum allowed date that a user may select (ISO format string)."
-        },
-        "maxValue": {
-            "type": "string",
-            "description": "The maximum allowed date that a user may select (ISO format string)."
-        },
-        "showTimeZone": {
-            "type": "boolean",
-            "default": false,
-            "description": "Whether to show a time zone indicator in the calendar."
-        },
-        "days": {
-            "type": "array",
-            "description": "An array of days displayed in the current calendar view.",
-            "items": {
-                "type": "object",
-                "properties": {
-                    "date": {
-                        "type": "string",
-                        "description": "The date represented by this day (ISO format string)."
-                    },
-                    "isDisabled": {
-                        "type": "boolean",
-                        "default": false,
-                        "description": "Whether this day is disabled."
-                    },
-                    "isSelected": {
-                        "type": "boolean",
-                        "default": false,
-                        "description": "Whether this day is currently selected."
-                    },
-                    "isRangeStart": {
-                        "type": "boolean",
-                        "default": false,
-                        "description": "Whether this day is the start of a selected range."
-                    },
-                    "isRangeEnd": {
-                        "type": "boolean",
-                        "default": false,
-                        "description": "Whether this day is the end of a selected range."
-                    },
-                    "isUnavailable": {
-                        "type": "boolean",
-                        "default": false,
-                        "description": "Whether this day is unavailable for selection. If true, the day appears with a strikethrough."
-                    },
-                    "isToday": {
-                        "type": "boolean",
-                        "default": false,
-                        "description": "Whether this day represents the current date."
-                    },
-                    "state": {
-                        "type": "string",
-                        "enum": [
-                            "default",
-                            "hover",
-                            "keyboard focus"
-                        ],
-                        "default": "default",
-                        "description": "The interaction state of the day cell."
-                    }
-                },
-                "required": [
-                    "date"
-                ]
-            }
-        }
-    }
-}

package/schemas/components/cards.json

@@ -1,238 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-tokens/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-tokens/schemas/components/cards.json",
-  "title": "Cards",
-  "description": "Cards group related content into distinct layouts depending on context.",
-  "meta": {
-    "category": "containers",
-    "documentationUrl": "https://spectrum.adobe.com/page/cards/"
-  },
-  "type": "object",
-  "definitions": {
-    "baseCard": {
-      "type": "object",
-      "properties": {
-        "size": {
-          "type": "string",
-          "enum": ["xs", "s", "m", "l", "xl"],
-          "default": "m",
-          "description": "Overall size of the card."
-        },
-        "state": {
-          "type": "string",
-          "enum": ["default", "hover", "pending"],
-          "default": "default",
-          "description": "Interaction state of the card."
-        },
-        "isSelected": {
-          "type": "boolean",
-          "default": false,
-          "description": "Whether the card is selected."
-        },
-        "isQuiet": {
-          "type": "boolean",
-          "default": false,
-          "description": "Applies a quiet visual style."
-        },
-        "isDisabled": {
-          "type": "boolean",
-          "default": false,
-          "description": "Whether the card is disabled."
-        },
-        "hideCheckbox": {
-          "type": "boolean",
-          "default": false,
-          "description": "If true, the selection checkbox is hidden."
-        },
-        "actionLabel": {
-          "type": "string",
-          "description": "Optional action button label."
-        },
-        "metadata": {
-          "type": "string",
-          "description": "Optional metadata shown below the card."
-        }
-      }
-    }
-  },
-  "properties": {
-    "variant": {
-      "type": "string",
-      "enum": [
-        "asset",
-        "collection",
-        "flex",
-        "gallery",
-        "horizontal",
-        "product"
-      ],
-      "default": "asset",
-      "description": "Determines which card layout variant is used."
-    }
-  },
-  "oneOf": [
-    {
-      "allOf": [
-        {
-          "$ref": "#/definitions/baseCard"
-        },
-        {
-          "properties": {
-            "variant": {
-              "const": "asset"
-            },
-            "title": {
-              "type": "string"
-            },
-            "description": {
-              "type": "string"
-            },
-            "image": {
-              "type": "string",
-              "description": "Preview image."
-            },
-            "previewVariant": {
-              "type": "string",
-              "enum": [
-                "full-bleed",
-                "half-horizontal",
-                "two-thirds-horizontal",
-                "half-vertical",
-                "two-thirds-vertical"
-              ],
-              "default": "full-bleed",
-              "description": "Layout style for the preview image."
-            }
-          },
-          "required": ["image"]
-        }
-      ]
-    },
-    {
-      "allOf": [
-        {
-          "$ref": "#/definitions/baseCard"
-        },
-        {
-          "properties": {
-            "variant": {
-              "const": "collection"
-            },
-            "title": {
-              "type": "string"
-            },
-            "description": {
-              "type": "string"
-            },
-            "collectionName": {
-              "type": "string"
-            },
-            "itemCount": {
-              "type": "number"
-            }
-          },
-          "required": ["collectionName"]
-        }
-      ]
-    },
-    {
-      "allOf": [
-        {
-          "$ref": "#/definitions/baseCard"
-        },
-        {
-          "properties": {
-            "variant": {
-              "const": "flex"
-            },
-            "title": {
-              "type": "string"
-            },
-            "description": {
-              "type": "string"
-            },
-            "content": {
-              "type": "string",
-              "description": "Flexible card content."
-            }
-          }
-        }
-      ]
-    },
-    {
-      "properties": {
-        "variant": {
-          "const": "gallery"
-        },
-        "images": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "description": "Image URLs for gallery display."
-        }
-      },
-      "required": ["images"],
-      "additionalProperties": false
-    },
-    {
-      "allOf": [
-        {
-          "$ref": "#/definitions/baseCard"
-        },
-        {
-          "properties": {
-            "variant": {
-              "const": "horizontal"
-            },
-            "title": {
-              "type": "string"
-            },
-            "description": {
-              "type": "string"
-            },
-            "thumbnail": {
-              "type": "string",
-              "description": "Thumbnail image on left or right."
-            },
-            "details": {
-              "type": "string",
-              "description": "Supporting text beside thumbnail."
-            }
-          }
-        }
-      ]
-    },
-    {
-      "allOf": [
-        {
-          "$ref": "#/definitions/baseCard"
-        },
-        {
-          "properties": {
-            "variant": {
-              "const": "product"
-            },
-            "title": {
-              "type": "string"
-            },
-            "description": {
-              "type": "string"
-            },
-            "productName": {
-              "type": "string"
-            },
-            "price": {
-              "type": "string"
-            },
-            "thumbnail": {
-              "type": "string",
-              "description": "Thumbnail for the product."
-            }
-          },
-          "required": ["productName", "price", "thumbnail"]
-        }
-      ]
-    }
-  ]
-}

package/schemas/components/checkbox-group.json

@@ -1,49 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-tokens/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-tokens/schemas/components/checkbox-group.json",
-  "title": "Checkbox group",
-  "description": "A checkbox group is a grouping of checkboxes that are related to each other.",
-  "meta": {
-    "category": "inputs",
-    "documentationUrl": "https://spectrum.adobe.com/page/checkbox-group/"
-  },
-  "type": "object",
-  "properties": {
-    "label": {
-      "type": "string"
-    },
-    "labelPosition": {
-      "type": "string",
-      "enum": ["top", "side"],
-      "default": "top"
-    },
-    "necessityIndicator": {
-      "type": "string",
-      "enum": ["text", "icon"],
-      "default": "icon"
-    },
-    "isRequired": {
-      "type": "boolean",
-      "default": false
-    },
-    "orientation": {
-      "type": "string",
-      "enum": ["horizontal", "vertical"],
-      "default": "vertical"
-    },
-    "isError": {
-      "type": "boolean",
-      "default": false
-    },
-    "isDisabled": {
-      "type": "boolean",
-      "default": false
-    },
-    "description": {
-      "type": "string"
-    },
-    "errorMessage": {
-      "type": "string"
-    }
-  }
-}

package/schemas/components/checkbox.json

@@ -1,49 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-tokens/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-tokens/schemas/components/checkbox.json",
-  "title": "Checkbox",
-  "description": "Checkboxes allow users to select multiple items from a list of individual items, or to mark one individual item as selected.",
-  "meta": {
-    "category": "inputs",
-    "documentationUrl": "https://spectrum.adobe.com/page/checkbox/"
-  },
-  "type": "object",
-  "properties": {
-    "label": {
-      "type": "string",
-      "description": "When the label is not defined, the checkbox appears as a standalone checkbox."
-    },
-    "isSelected": {
-      "type": "boolean",
-      "default": false
-    },
-    "isIndeterminate": {
-      "type": "boolean",
-      "default": false,
-      "description": "When a checkbox is indeterminate, it overrides the selection state."
-    },
-    "size": {
-      "type": "string",
-      "enum": ["s", "m", "l", "xl"],
-      "default": "m"
-    },
-    "isEmphasized": {
-      "type": "boolean",
-      "default": false
-    },
-    "isDisabled": {
-      "type": "boolean",
-      "default": false
-    },
-    "isError": {
-      "type": "boolean",
-      "default": false
-    },
-
-    "state": {
-      "type": "string",
-      "enum": ["default", "hover", "down", "keyboard focus"],
-      "default": "default"
-    }
-  }
-}

package/schemas/components/close-button.json

@@ -1,35 +0,0 @@
-{
-  "$schema": "https://opensource.adobe.com/spectrum-tokens/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-tokens/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-tokens/schemas/component.json",
-  "$id": "https://opensource.adobe.com/spectrum-tokens/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."
-    }
-  }
-}