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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/CHANGELOG.md +230 -126
  2. package/package.json +1 -1
  3. package/schemas/components/accordion.json +4 -20
  4. package/schemas/components/alert-banner.json +1 -1
  5. package/schemas/components/avatar-group.json +18 -26
  6. package/schemas/components/breadcrumbs.json +7 -7
  7. package/schemas/components/calendar.json +109 -0
  8. package/schemas/components/cards.json +238 -0
  9. package/schemas/components/checkbox-group.json +1 -1
  10. package/schemas/components/coach-mark.json +51 -0
  11. package/schemas/components/color-handle.json +27 -27
  12. package/schemas/components/color-slider.json +10 -2
  13. package/schemas/components/illustrated-message.json +52 -0
  14. package/schemas/components/in-line-alert.json +3 -3
  15. package/schemas/components/list-view.json +106 -0
  16. package/schemas/components/number-field.json +53 -69
  17. package/schemas/components/picker.json +18 -8
  18. package/schemas/components/radio-button.json +1 -6
  19. package/schemas/components/segmented-control.json +62 -79
  20. package/schemas/components/side-navigation.json +61 -2
  21. package/schemas/components/slider.json +3 -14
  22. package/schemas/components/standard-dialog.json +53 -0
  23. package/schemas/components/standard-panel.json +49 -0
  24. package/schemas/components/{step-list.json → steplist.json} +3 -3
  25. package/schemas/components/swatch-group.json +4 -20
  26. package/schemas/components/swatch.json +4 -21
  27. package/schemas/components/table.json +144 -0
  28. package/schemas/components/tabs.json +6 -26
  29. package/schemas/components/tag-field.json +38 -47
  30. package/schemas/components/tag-group.json +27 -34
  31. package/schemas/components/takeover-dialog.json +60 -0
  32. package/schemas/components/text-field.json +3 -14
package/schemas/components/list-view.json ADDED
@@ -0,0 +1,106 @@
1
+ {
2
+ "$schema": "https://opensource.adobe.com/spectrum-tokens/schemas/component.json",
3
+ "$id": "https://opensource.adobe.com/spectrum-tokens/schemas/components/list-view.json",
4
+ "title": "List view",
5
+ "description": "List views display rows of data or options that users can browse, select, and interact with.",
6
+ "meta": {
7
+ "category": "navigation",
8
+ "documentationUrl": "https://spectrum.adobe.com/page/list-view/"
9
+ },
10
+ "type": "object",
11
+ "properties": {
12
+ "selectionMode": {
13
+ "type": "string",
14
+ "enum": [
15
+ "none",
16
+ "single",
17
+ "multiple"
18
+ ],
19
+ "default": "single",
20
+ "description": "Defines how many items can be selected at once."
21
+ },
22
+ "isQuiet": {
23
+ "type": "boolean",
24
+ "default": false,
25
+ "description": "If true, the list view uses a quiet visual style."
26
+ },
27
+ "items": {
28
+ "type": "array",
29
+ "description": "An array of list view items.",
30
+ "items": {
31
+ "type": "object",
32
+ "properties": {
33
+ "label": {
34
+ "type": "string",
35
+ "description": "Primary text displayed for the item."
36
+ },
37
+ "description": {
38
+ "type": "string",
39
+ "description": "Secondary text displayed under the label (optional)."
40
+ },
41
+ "hideCheckbox": {
42
+ "type": "boolean",
43
+ "default": false,
44
+ "description": "If true, the checkbox is hidden."
45
+ },
46
+ "hideDragHandle": {
47
+ "type": "boolean",
48
+ "default": false,
49
+ "description": "If true, the drag handle is hidden."
50
+ },
51
+ "hideNavigationIndicator": {
52
+ "type": "boolean",
53
+ "default": false,
54
+ "description": "If true, the navigation indicator is hidden."
55
+ },
56
+ "isDisabled": {
57
+ "type": "boolean",
58
+ "default": false,
59
+ "description": "If true, the item is disabled."
60
+ },
61
+ "isSelected": {
62
+ "type": "boolean",
63
+ "default": false,
64
+ "description": "If true, the item is selected."
65
+ },
66
+ "overflowMode": {
67
+ "type": "string",
68
+ "enum": [
69
+ "wrap",
70
+ "truncate"
71
+ ],
72
+ "default": "truncate",
73
+ "description": "Defines how text should behave when it overflows the available space."
74
+ },
75
+ "itemRounding": {
76
+ "type": "string",
77
+ "enum": [
78
+ "none",
79
+ "top",
80
+ "bottom"
81
+ ],
82
+ "default": "none",
83
+ "description": "Defines the border radius of the list view item."
84
+ },
85
+ "isEmphasized": {
86
+ "type": "boolean",
87
+ "default": false
88
+ },
89
+ "state": {
90
+ "type": "string",
91
+ "enum": [
92
+ "default",
93
+ "hover",
94
+ "dragged"
95
+ ],
96
+ "default": "default",
97
+ "description": "The interaction state of the list view item."
98
+ }
99
+ },
100
+ "required": [
101
+ "label"
102
+ ]
103
+ }
104
+ }
105
+ }
106
+ }
package/schemas/components/number-field.json CHANGED
@@ -1,73 +1,57 @@
1
1
  {
2
- "$schema": "https://opensource.adobe.com/spectrum-tokens/schemas/component.json",
3
- "$id": "https://opensource.adobe.com/spectrum-tokens/schemas/components/number-field.json",
4
- "title": "Number field",
5
- "description": "Number fields allow users to enter a numeric value, with optional increment and decrement buttons.",
6
- "meta": {
7
- "category": "inputs",
8
- "documentationUrl": "https://spectrum.adobe.com/page/number-field/"
2
+ "$schema": "https://opensource.adobe.com/spectrum-tokens/schemas/component.json",
3
+ "$id": "https://opensource.adobe.com/spectrum-tokens/schemas/components/number-field.json",
4
+ "title": "Number field",
5
+ "description": "Number fields allow users to enter a numeric value, with optional increment and decrement buttons.",
6
+ "meta": {
7
+ "category": "inputs",
8
+ "documentationUrl": "https://spectrum.adobe.com/page/number-field/"
9
+ },
10
+ "type": "object",
11
+ "properties": {
12
+ "label": {
13
+ "type": "string"
9
14
  },
10
- "type": "object",
11
- "properties": {
12
- "label": {
13
- "type": "string"
14
- },
15
- "size": {
16
- "type": "string",
17
- "enum": [
18
- "s",
19
- "m",
20
- "l",
21
- "xl"
22
- ],
23
- "default": "m"
24
- },
25
- "labelPosition": {
26
- "type": "string",
27
- "default": "top",
28
- "enum": [
29
- "top",
30
- "side"
31
- ]
32
- },
33
- "hideLabel": {
34
- "type": "boolean",
35
- "default": false
36
- },
37
- "state": {
38
- "type": "string",
39
- "enum": [
40
- "default",
41
- "hover",
42
- "focus + hover",
43
- "focus + not hover"
44
- ],
45
- "default": "default"
46
- },
47
- "isDisabled": {
48
- "type": "boolean",
49
- "default": false
50
- },
51
- "isError": {
52
- "type": "boolean",
53
- "default": false
54
- },
55
- "isRequired": {
56
- "type": "boolean",
57
- "default": false
58
- },
59
- "necessityIndicator": {
60
- "type": "string",
61
- "enum": [
62
- "text",
63
- "icon"
64
- ],
65
- "default": "icon"
66
- },
67
- "hideStepper": {
68
- "type": "boolean",
69
- "default": false,
70
- "description": "If true, hides in-field increment and decrement buttons (stepper)."
71
- }
15
+ "size": {
16
+ "type": "string",
17
+ "enum": ["s", "m", "l", "xl"],
18
+ "default": "m"
19
+ },
20
+ "labelPosition": {
21
+ "type": "string",
22
+ "default": "top",
23
+ "enum": ["top", "side"]
24
+ },
25
+ "hideLabel": {
26
+ "type": "boolean",
27
+ "default": false
28
+ },
29
+ "state": {
30
+ "type": "string",
31
+ "enum": ["default", "hover", "focus + hover", "focus + not hover"],
32
+ "default": "default"
33
+ },
34
+ "isDisabled": {
35
+ "type": "boolean",
36
+ "default": false
37
+ },
38
+ "isError": {
39
+ "type": "boolean",
40
+ "default": false
41
+ },
42
+ "isRequired": {
43
+ "type": "boolean",
44
+ "default": false
45
+ },
46
+ "necessityIndicator": {
47
+ "type": "string",
48
+ "enum": ["text", "icon"],
49
+ "default": "icon"
50
+ },
51
+ "hideStepper": {
52
+ "type": "boolean",
53
+ "default": false,
54
+ "description": "If true, hides in-field increment and decrement buttons (stepper)."
72
55
  }
56
+ }
73
57
  }
package/schemas/components/picker.json CHANGED
@@ -15,7 +15,10 @@
15
15
  "labelPosition": {
16
16
  "type": "string",
17
17
  "default": "top",
18
- "enum": ["top", "side"]
18
+ "enum": [
19
+ "top",
20
+ "side"
21
+ ]
19
22
  },
20
23
  "placeholder": {
21
24
  "type": "string"
@@ -29,7 +32,12 @@
29
32
  },
30
33
  "size": {
31
34
  "type": "string",
32
- "enum": ["s", "m", "l", "xl"],
35
+ "enum": [
36
+ "s",
37
+ "m",
38
+ "l",
39
+ "xl"
40
+ ],
33
41
  "default": "m"
34
42
  },
35
43
  "isQuiet": {
@@ -38,7 +46,10 @@
38
46
  },
39
47
  "necessityIndicator": {
40
48
  "type": "string",
41
- "enum": ["text", "icon"],
49
+ "enum": [
50
+ "text",
51
+ "icon"
52
+ ],
42
53
  "default": "icon"
43
54
  },
44
55
  "isRequired": {
@@ -47,7 +58,10 @@
47
58
  },
48
59
  "menuContainer": {
49
60
  "type": "string",
50
- "enum": ["popover", "tray"],
61
+ "enum": [
62
+ "popover",
63
+ "tray"
64
+ ],
51
65
  "default": "popover"
52
66
  },
53
67
  "isDisabled": {
@@ -58,10 +72,6 @@
58
72
  "type": "boolean",
59
73
  "default": false
60
74
  },
61
- "isReadOnly": {
62
- "type": "boolean",
63
- "default": false
64
- },
65
75
  "description": {
66
76
  "type": "string",
67
77
  "default": null
package/schemas/components/radio-button.json CHANGED
@@ -11,12 +11,7 @@
11
11
  "properties": {
12
12
  "state": {
13
13
  "type": "string",
14
- "enum": [
15
- "default",
16
- "hover",
17
- "down",
18
- "keyboard focus"
19
- ],
14
+ "enum": ["default", "hover", "down", "keyboard focus"],
20
15
  "default": "default"
21
16
  },
22
17
  "isSelected": {
package/schemas/components/segmented-control.json CHANGED
@@ -1,89 +1,72 @@
1
1
  {
2
- "$schema": "https://opensource.adobe.com/spectrum-tokens/schemas/component.json",
3
- "$id": "https://opensource.adobe.com/spectrum-tokens/schemas/components/segmented-control.json",
4
- "title": "Segmented Control",
5
- "description": "Segmented controls allow users to select one option from a set of mutually exclusive options.",
6
- "meta": {
7
- "category": "navigation",
8
- "documentationUrl": "https://spectrum.adobe.com/page/segmented-control/"
2
+ "$schema": "https://opensource.adobe.com/spectrum-tokens/schemas/component.json",
3
+ "$id": "https://opensource.adobe.com/spectrum-tokens/schemas/components/segmented-control.json",
4
+ "title": "Segmented Control",
5
+ "description": "Segmented controls allow users to select one option from a set of mutually exclusive options.",
6
+ "meta": {
7
+ "category": "navigation",
8
+ "documentationUrl": "https://spectrum.adobe.com/page/segmented-control/"
9
+ },
10
+ "type": "object",
11
+ "properties": {
12
+ "orientation": {
13
+ "type": "string",
14
+ "enum": ["horizontal", "vertical"],
15
+ "default": "horizontal"
9
16
  },
10
- "type": "object",
11
- "properties": {
12
- "orientation": {
13
- "type": "string",
14
- "enum": [
15
- "horizontal",
16
- "vertical"
17
- ],
18
- "default": "horizontal"
19
- },
20
- "isFluid": {
21
- "type": "boolean",
22
- "default": false,
23
- "description": "If true, the control takes up the full width of its container. Only applicable to horizontal segmented controls."
24
- },
25
- "alignment": {
17
+ "isFluid": {
18
+ "type": "boolean",
19
+ "default": false,
20
+ "description": "If true, the control takes up the full width of its container. Only applicable to horizontal segmented controls."
21
+ },
22
+ "alignment": {
23
+ "type": "string",
24
+ "enum": ["start", "center"],
25
+ "default": "start"
26
+ },
27
+ "hideTracker": {
28
+ "type": "boolean",
29
+ "default": false,
30
+ "description": "If true, the tracker that indicates the selected item is hidden."
31
+ },
32
+ "selectedItem": {
33
+ "type": "string",
34
+ "description": "The identifier of the currently selected item."
35
+ },
36
+ "keyboardActivation": {
37
+ "type": "string",
38
+ "enum": ["manual", "automatic"],
39
+ "default": "manual"
40
+ },
41
+ "items": {
42
+ "type": "array",
43
+ "description": "An array of segmented control items.",
44
+ "items": {
45
+ "type": "object",
46
+ "properties": {
47
+ "label": {
26
48
  "type": "string",
27
- "enum": [
28
- "start",
29
- "center"
30
- ],
31
- "default": "start"
32
- },
33
- "hideTracker": {
49
+ "description": "The text displayed for the segmented control item."
50
+ },
51
+ "isDisabled": {
34
52
  "type": "boolean",
35
53
  "default": false,
36
- "description": "If true, the tracker that indicates the selected item is hidden."
37
- },
38
- "selectedItem": {
54
+ "description": "Whether the segmented control item is disabled."
55
+ },
56
+ "state": {
39
57
  "type": "string",
40
- "description": "The identifier of the currently selected item."
41
- },
42
- "keyboardActivation": {
58
+ "enum": ["default", "hover", "keyboard focus"],
59
+ "default": "default",
60
+ "description": "The interaction state of the segmented control item."
61
+ },
62
+ "contentVariant": {
43
63
  "type": "string",
44
- "enum": [
45
- "manual",
46
- "automatic"
47
- ],
48
- "default": "manual"
49
- },
50
- "items": {
51
- "type": "array",
52
- "description": "An array of segmented control items.",
53
- "items": {
54
- "type": "object",
55
- "properties": {
56
- "label": {
57
- "type": "string",
58
- "description": "The text displayed for the segmented control item."
59
- },
60
- "isDisabled": {
61
- "type": "boolean",
62
- "default": false,
63
- "description": "Whether the segmented control item is disabled."
64
- },
65
- "state": {
66
- "type": "string",
67
- "enum": [
68
- "default",
69
- "hover",
70
- "keyboard focus"
71
- ],
72
- "default": "default",
73
- "description": "The interaction state of the segmented control item."
74
- },
75
- "contentVariant": {
76
- "type": "string",
77
- "enum": [
78
- "label-only",
79
- "icon-only",
80
- "icon-label"
81
- ],
82
- "default": "icon-label",
83
- "description": "Controls whether the segmented control item displays a label, an icon, or both."
84
- }
85
- }
86
- }
64
+ "enum": ["label-only", "icon-only", "icon-label"],
65
+ "default": "icon-label",
66
+ "description": "Controls whether the segmented control item displays a label, an icon, or both."
67
+ }
87
68
  }
69
+ }
88
70
  }
71
+ }
89
72
  }
package/schemas/components/side-navigation.json CHANGED
@@ -11,8 +11,67 @@
11
11
  "properties": {
12
12
  "state": {
13
13
  "type": "string",
14
- "enum": ["default", "hover", "down", "keyboard focus"],
14
+ "enum": [
15
+ "default",
16
+ "hover",
17
+ "down",
18
+ "keyboard focus"
19
+ ],
15
20
  "default": "default"
21
+ },
22
+ "items": {
23
+ "type": "array",
24
+ "description": "The list of navigation items.",
25
+ "items": {
26
+ "type": "object",
27
+ "properties": {
28
+ "label": {
29
+ "type": "string",
30
+ "description": "Text label for the navigation item."
31
+ },
32
+ "state": {
33
+ "type": "string",
34
+ "enum": [
35
+ "default",
36
+ "hover",
37
+ "down",
38
+ "keyboard focus"
39
+ ],
40
+ "default": "default",
41
+ "description": "State of the navigation item."
42
+ },
43
+ "icon": {
44
+ "type": "string",
45
+ "description": "Optional icon token for the navigation item."
46
+ },
47
+ "isSelected": {
48
+ "type": "boolean",
49
+ "default": false,
50
+ "description": "Whether the item is currently selected."
51
+ },
52
+ "isDisabled": {
53
+ "type": "boolean",
54
+ "default": false,
55
+ "description": "Whether the item is disabled."
56
+ }
57
+ },
58
+ "required": [
59
+ "label"
60
+ ]
61
+ }
62
+ },
63
+ "selectionMode": {
64
+ "type": "string",
65
+ "enum": [
66
+ "none",
67
+ "single",
68
+ "multiple"
69
+ ],
70
+ "default": "single",
71
+ "description": "How selection is handled for items."
16
72
  }
17
- }
73
+ },
74
+ "required": [
75
+ "items"
76
+ ]
18
77
  }
package/schemas/components/slider.json CHANGED
@@ -15,10 +15,7 @@
15
15
  "labelPosition": {
16
16
  "type": "string",
17
17
  "default": "top",
18
- "enum": [
19
- "top",
20
- "side"
21
- ]
18
+ "enum": ["top", "side"]
22
19
  },
23
20
  "value": {
24
21
  "type": "number",
@@ -47,10 +44,7 @@
47
44
  },
48
45
  "progressionScale": {
49
46
  "type": "string",
50
- "enum": [
51
- "linear",
52
- "log"
53
- ],
47
+ "enum": ["linear", "log"],
54
48
  "default": "linear"
55
49
  },
56
50
  "width": {
@@ -78,12 +72,7 @@
78
72
  },
79
73
  "state": {
80
74
  "type": "string",
81
- "enum": [
82
- "default",
83
- "hover",
84
- "down",
85
- "keyboard focus"
86
- ],
75
+ "enum": ["default", "hover", "down", "keyboard focus"],
87
76
  "default": "default"
88
77
  }
89
78
  }
package/schemas/components/standard-dialog.json ADDED
@@ -0,0 +1,53 @@
1
+ {
2
+ "$schema": "https://opensource.adobe.com/spectrum-tokens/schemas/component.json",
3
+ "$id": "https://opensource.adobe.com/spectrum-tokens/schemas/components/standard-dialog.json",
4
+ "title": "Standard dialog",
5
+ "description": "Standard dialogs display important information that users need to acknowledge. They appear over the interface and block further interactions until an action is selected.",
6
+ "meta": {
7
+ "category": "feedback",
8
+ "documentationUrl": "https://spectrum.adobe.com/page/standard-dialog/"
9
+ },
10
+ "type": "object",
11
+ "properties": {
12
+ "title": {
13
+ "type": "string"
14
+ },
15
+ "description": {
16
+ "type": "string"
17
+ },
18
+ "hideImage": {
19
+ "type": "boolean",
20
+ "default": false,
21
+ "description": "Optional image to display in dialog."
22
+ },
23
+ "size": {
24
+ "type": "string",
25
+ "enum": [
26
+ "s",
27
+ "m",
28
+ "l"
29
+ ],
30
+ "default": "m"
31
+ },
32
+ "hideCloseButton": {
33
+ "type": "boolean",
34
+ "default": false
35
+ },
36
+ "footerContent": {
37
+ "type": "string",
38
+ "description": "Optional footer content to display in the dialog footer like a checkbox."
39
+ },
40
+ "primaryActionLabel": {
41
+ "type": "string"
42
+ },
43
+ "secondaryActionLabel": {
44
+ "type": "string",
45
+ "description": "If undefined, this button does not appear."
46
+ },
47
+ "cancelActionLabel": {
48
+ "type": "string",
49
+ "default": "cancel",
50
+ "description": "If undefined, this button does not appear."
51
+ }
52
+ }
53
+ }