@adobe/spectrum-component-api-schemas 2.0.0 → 4.0.0

package/schemas/components/drop-zone.json

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

@@ -14,7 +14,7 @@
     },
     "variant": {
       "type": "string",
-      "enum": ["neutral"],
+      "enum": ["neutral", "negative"],
       "default": "neutral"
     },
     "hideIcon": {
@@ -29,7 +29,8 @@
     },
     "isDisabled": {
       "type": "boolean",
-      "default": false
+      "default": false,
+      "description": "Help text cannot be both disabled and negative variant."
     }
   }
 }

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

@@ -17,9 +17,27 @@
         "positive",
         "notice",
         "negative",
-        "neutral"
+        "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/menu.json

@@ -11,8 +11,7 @@
   "properties": {
     "container": {
       "type": "string",
-      "enum": ["popover", "tray"],
-      "default": null
+      "enum": ["popover", "tray"]
     },
     "label": {
       "type": "string"
@@ -34,8 +33,7 @@
     },
     "selectionMode": {
       "type": "string",
-      "enum": ["single", "multiple"],
-      "default": null
+      "enum": ["single", "multiple", "no selection"]
     },
     "selectionStyle": {
       "type": "string",

package/schemas/components/meter.json

@@ -17,6 +17,10 @@
     "label": {
       "type": "string"
     },
+    "hideLabel": {
+      "type": "boolean",
+      "default": false
+    },
     "valueLabel": {
       "type": "string"
     },

package/schemas/components/number-field.json

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

@@ -15,9 +15,9 @@
     "height": {
       "type": "number"
     },
-    "showTip": {
+    "hideTip": {
       "type": "boolean",
-      "default": true
+      "default": false
     },
     "placement": {
       "type": "string",

package/schemas/components/progress-bar.json

@@ -14,9 +14,23 @@
       "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."

package/schemas/components/radio-button.json

@@ -11,7 +11,12 @@
   "properties": {
     "state": {
       "type": "string",
-      "enum": ["default", "hover", "down", "keyboard focus"],
+      "enum": [
+        "default",
+        "hover",
+        "down",
+        "keyboard focus"
+      ],
       "default": "default"
     },
     "isSelected": {
@@ -23,8 +28,8 @@
       "default": false
     },
     "label": {
-      "type": "boolean",
-      "default": true
+      "type": "string",
+      "description": "The text displayed next to a radio button."
     }
   }
 }

package/schemas/components/radio-group.json

@@ -48,10 +48,6 @@
       "type": "boolean",
       "default": false
     },
-    "isReadOnly": {
-      "type": "boolean",
-      "default": false
-    },
     "errorMessage": {
       "type": "string"
     },

package/schemas/components/rating.json

@@ -11,9 +11,11 @@
   "properties": {
     "value": {
       "type": "number",
-      "enum": [0, 1, 2, 3, 4, 5],
+      "minimum": 0,
+      "maximum": 5,
       "default": 0,
-      "description": "From 0 to 5"
+      "multipleOf": 0.5,
+      "description": "From 0 to 5, can be a decimal to represent half stars"
     },
     "isEmphasized": {
       "type": "boolean",

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

@@ -31,7 +31,7 @@
       "type": "boolean",
       "default": false
     },
-    "isDetatched": {
+    "isDetached": {
       "type": "boolean",
       "default": false
     },

package/schemas/components/search-field.json

@@ -12,6 +12,14 @@
     "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."
+    },
     "value": {
       "type": "string"
     },

package/schemas/components/segmented-control.json

@@ -0,0 +1,89 @@
+{
+    "$schema": "https://opensource.adobe.com/spectrum-tokens/schemas/component.json",
+    "$id": "https://opensource.adobe.com/spectrum-tokens/schemas/components/segmented-control.json",
+    "title": "Segmented Control",
+    "description": "Segmented controls allow users to select one option from a set of mutually exclusive options.",
+    "meta": {
+        "category": "navigation",
+        "documentationUrl": "https://spectrum.adobe.com/page/segmented-control/"
+    },
+    "type": "object",
+    "properties": {
+        "orientation": {
+            "type": "string",
+            "enum": [
+                "horizontal",
+                "vertical"
+            ],
+            "default": "horizontal"
+        },
+        "isFluid": {
+            "type": "boolean",
+            "default": false,
+            "description": "If true, the control takes up the full width of its container. Only applicable to horizontal segmented controls."
+        },
+        "alignment": {
+            "type": "string",
+            "enum": [
+                "start",
+                "center"
+            ],
+            "default": "start"
+        },
+        "hideTracker": {
+            "type": "boolean",
+            "default": false,
+            "description": "If true, the tracker that indicates the selected item is hidden."
+        },
+        "selectedItem": {
+            "type": "string",
+            "description": "The identifier of the currently selected item."
+        },
+        "keyboardActivation": {
+            "type": "string",
+            "enum": [
+                "manual",
+                "automatic"
+            ],
+            "default": "manual"
+        },
+        "items": {
+            "type": "array",
+            "description": "An array of segmented control items.",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "label": {
+                        "type": "string",
+                        "description": "The text displayed for the segmented control item."
+                    },
+                    "isDisabled": {
+                        "type": "boolean",
+                        "default": false,
+                        "description": "Whether the segmented control item is disabled."
+                    },
+                    "state": {
+                        "type": "string",
+                        "enum": [
+                            "default",
+                            "hover",
+                            "keyboard focus"
+                        ],
+                        "default": "default",
+                        "description": "The interaction state of the segmented control item."
+                    },
+                    "contentVariant": {
+                        "type": "string",
+                        "enum": [
+                            "label-only",
+                            "icon-only",
+                            "icon-label"
+                        ],
+                        "default": "icon-label",
+                        "description": "Controls whether the segmented control item displays a label, an icon, or both."
+                    }
+                }
+            }
+        }
+    }
+}

package/schemas/components/select-box.json

@@ -15,7 +15,7 @@
     "orientation": {
       "type": "string",
       "enum": ["horizontal", "vertical"],
-      "default": "horizontal"
+      "default": "vertical"
     },
     "body": {
       "type": "string"
@@ -24,7 +24,7 @@
       "type": "boolean",
       "default": false
     },
-    "showIllustration": {
+    "hideIllustration": {
       "type": "boolean",
       "default": false
     },
@@ -32,10 +32,19 @@
       "type": "boolean",
       "default": false
     },
+    "isDisabled": {
+      "type": "boolean",
+      "default": false
+    },
     "state": {
       "type": "string",
       "enum": ["default", "down", "hover", "keyboard focus"],
       "default": "default"
+    },
+    "multiple": {
+      "type": "boolean",
+      "default": false,
+      "description": "Set to true to allow multiple selections."
     }
   }
 }

package/schemas/components/slider.json

@@ -15,7 +15,10 @@
     "labelPosition": {
       "type": "string",
       "default": "top",
-      "enum": ["top", "side"]
+      "enum": [
+        "top",
+        "side"
+      ]
     },
     "value": {
       "type": "number",
@@ -29,6 +32,11 @@
       "type": "number",
       "default": 100
     },
+    "isRange": {
+      "type": "boolean",
+      "default": false,
+      "description": "If true, the slider will allow selection of a range of values by displaying two handles."
+    },
     "step": {
       "type": "number",
       "default": 1
@@ -39,7 +47,10 @@
     },
     "progressionScale": {
       "type": "string",
-      "enum": ["linear", "log"],
+      "enum": [
+        "linear",
+        "log"
+      ],
       "default": "linear"
     },
     "width": {
@@ -67,7 +78,12 @@
     },
     "state": {
       "type": "string",
-      "enum": ["default", "hover", "down", "keyboard focus"],
+      "enum": [
+        "default",
+        "hover",
+        "down",
+        "keyboard focus"
+      ],
       "default": "default"
     }
   }

package/schemas/components/status-light.json

@@ -32,7 +32,12 @@
         "turquoise",
         "cinnamon",
         "brown",
-        "silver"
+        "silver",
+        "gray",
+        "red",
+        "orange",
+        "green",
+        "cyan"
       ],
       "default": "informative"
     },
@@ -40,10 +45,7 @@
       "type": "string",
       "enum": ["s", "m", "l", "xl"],
       "default": "m"
-    },
-    "isDisabled": {
-      "type": "boolean",
-      "default": false
     }
-  }
+  },
+  "required": ["label"]
 }

package/schemas/components/step-list.json

@@ -0,0 +1,52 @@
+{
+  "$schema": "https://opensource.adobe.com/spectrum-tokens/schemas/component.json",
+  "$id": "https://opensource.adobe.com/spectrum-tokens/schemas/components/step-list.json",
+  "title": "Step list",
+  "description": "Step lists display progress through a sequence of steps, with each step marked as completed, current, or incomplete.",
+  "meta": {
+    "category": "navigation",
+    "documentationUrl": "https://spectrum.adobe.com/page/step-list/"
+  },
+  "type": "object",
+  "properties": {
+    "orientation": {
+      "type": "string",
+      "enum": ["horizontal", "vertical"],
+      "default": "horizontal"
+    },
+    "items": {
+      "type": "array",
+      "description": "An array of step items in the step list.",
+      "items": {
+        "type": "object",
+        "properties": {
+          "label": {
+            "type": "string",
+            "description": "The text displayed for the step item."
+          },
+          "isDisabled": {
+            "type": "boolean",
+            "default": false,
+            "description": "Whether the step item is disabled."
+          },
+          "stepState": {
+            "type": "string",
+            "enum": [
+              "completed default",
+              "completed hover",
+              "current default",
+              "incomplete default"
+            ],
+            "default": "current default",
+            "description": "The current state of the step item."
+          }
+        },
+        "required": ["label", "stepState"]
+      }
+    },
+    "currentStep": {
+      "type": "string",
+      "description": "The identifier or label of the currently active step."
+    }
+  }
+}

package/schemas/components/swatch-group.json

@@ -11,12 +11,21 @@
   "properties": {
     "size": {
       "type": "string",
-      "enum": ["xs", "s", "m", "l"],
+      "enum": [
+        "xs",
+        "s",
+        "m",
+        "l"
+      ],
       "default": "m"
     },
     "density": {
       "type": "string",
-      "enum": ["compact", "regular", "spacious"],
+      "enum": [
+        "compact",
+        "regular",
+        "spacious"
+      ],
       "default": "regular"
     },
     "enableSelection": {
@@ -26,13 +35,26 @@
     "selectionMode": {
       "type": "string",
       "description": "Only applicable if selection is enabled.",
-      "enum": ["single", "multiple"],
+      "enum": [
+        "single",
+        "multiple"
+      ],
       "default": "single"
     },
     "allowsEmptySelection": {
       "type": "boolean",
       "default": false,
       "description": "Only applicable if selection is enabled."
+    },
+    "cornerRadius": {
+      "type": "string",
+      "enum": [
+        "none",
+        "full",
+        "partial"
+      ],
+      "default": "none",
+      "description": "Determines the corner radius of each swatch in the group. Partial refers to corner-radius-75."
     }
   }
 }

package/schemas/components/swatch.json

@@ -15,18 +15,31 @@
     },
     "size": {
       "type": "string",
-      "enum": ["xs", "s", "m", "l"],
+      "enum": [
+        "xs",
+        "s",
+        "m",
+        "l"
+      ],
       "default": "m"
     },
     "shape": {
       "type": "string",
-      "enum": ["square", "rectangle"],
+      "enum": [
+        "square",
+        "rectangle"
+      ],
       "default": "square"
     },
     "cornerRounding": {
       "type": "string",
-      "enum": ["default", "full"],
-      "default": "default"
+      "enum": [
+        "none",
+        "partial",
+        "full"
+      ],
+      "default": "none",
+      "description": "Determines the corner radius of the swatch. Partial refers to corner-radius-75."
     },
     "isSelected": {
       "type": "boolean",
@@ -38,7 +51,12 @@
     },
     "state": {
       "type": "string",
-      "enum": ["default", "hover", "down", "keyboard focus"],
+      "enum": [
+        "default",
+        "hover",
+        "down",
+        "keyboard focus"
+      ],
       "default": "default"
     }
   }