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

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 (40) hide show
  1. package/CHANGELOG.md +187 -0
  2. package/package.json +1 -1
  3. package/schemas/components/accordion.json +90 -0
  4. package/schemas/components/avatar-group.json +30 -0
  5. package/schemas/components/breadcrumbs.json +54 -0
  6. package/schemas/components/button-group.json +5 -0
  7. package/schemas/components/checkbox-group.json +1 -5
  8. package/schemas/components/color-handle.json +31 -0
  9. package/schemas/components/color-slider.json +7 -1
  10. package/schemas/components/combo-box.json +1 -5
  11. package/schemas/components/contextual-help.json +5 -2
  12. package/schemas/components/date-picker.json +157 -0
  13. package/schemas/components/divider.json +1 -1
  14. package/schemas/components/drop-zone.json +41 -0
  15. package/schemas/components/help-text.json +3 -2
  16. package/schemas/components/in-line-alert.json +19 -1
  17. package/schemas/components/menu.json +2 -4
  18. package/schemas/components/meter.json +4 -0
  19. package/schemas/components/number-field.json +73 -0
  20. package/schemas/components/popover.json +2 -2
  21. package/schemas/components/progress-bar.json +14 -0
  22. package/schemas/components/radio-button.json +8 -3
  23. package/schemas/components/radio-group.json +0 -4
  24. package/schemas/components/rating.json +4 -2
  25. package/schemas/components/scroll-zoom-bar.json +1 -1
  26. package/schemas/components/search-field.json +8 -0
  27. package/schemas/components/segmented-control.json +89 -0
  28. package/schemas/components/select-box.json +11 -2
  29. package/schemas/components/slider.json +19 -3
  30. package/schemas/components/status-light.json +8 -6
  31. package/schemas/components/step-list.json +52 -0
  32. package/schemas/components/swatch-group.json +25 -3
  33. package/schemas/components/swatch.json +23 -5
  34. package/schemas/components/tabs.json +78 -37
  35. package/schemas/components/tag-field.json +51 -0
  36. package/schemas/components/tag-group.json +38 -0
  37. package/schemas/components/text-area.json +4 -0
  38. package/schemas/components/text-field.json +19 -4
  39. package/schemas/components/tooltip.json +2 -2
  40. package/schemas/components/tree-view.json +1 -1
package/schemas/components/tabs.json CHANGED
@@ -11,44 +11,85 @@
11
11
  "properties": {
12
12
  "orientation": {
13
13
  "type": "string",
14
- "enum": ["horizontal", "vertical"],
15
- "default": "vertical"
14
+ "enum": [
15
+ "horizontal",
16
+ "vertical"
17
+ ],
18
+ "default": "horizontal"
16
19
  },
17
- "size": {
18
- "type": "string",
19
- "enum": ["s", "m", "l", "xl"],
20
- "default": "m"
21
- },
22
- "density": {
23
- "type": "string",
24
- "enum": ["compact", "regular"],
25
- "default": "regular"
26
- },
27
- "isFluid": {
28
- "type": "boolean",
29
- "default": false,
30
- "description": "This overrides density and is only applicable to horizontal tabs."
31
- },
32
- "isQuiet": {
33
- "type": "boolean",
34
- "default": false
35
- },
36
- "isEmphasized": {
37
- "type": "boolean",
38
- "default": false
39
- },
40
- "alignment": {
41
- "type": "string",
42
- "enum": ["start", "center"],
43
- "default": "start"
44
- },
45
- "selectedItem": {
46
- "description": "(list of available items)"
47
- },
48
- "keyboardActivation": {
49
- "type": "string",
50
- "enum": ["manual", "automatic"],
51
- "default": "manual"
20
+ "items": {
21
+ "type": "array",
22
+ "description": "An array of tab items.",
23
+ "items": {
24
+ "type": "object",
25
+ "properties": {
26
+ "label": {
27
+ "type": "string",
28
+ "description": "The text displayed for the tab item."
29
+ },
30
+ "isDisabled": {
31
+ "type": "boolean",
32
+ "default": false,
33
+ "description": "Whether the tab is disabled."
34
+ },
35
+ "state": {
36
+ "type": "string",
37
+ "enum": [
38
+ "default",
39
+ "hover",
40
+ "keyboard focus"
41
+ ],
42
+ "default": "default",
43
+ "description": "The interaction state of the tab item."
44
+ },
45
+ "contentVariant": {
46
+ "type": "string",
47
+ "enum": [
48
+ "label-only",
49
+ "icon-only",
50
+ "icon-label"
51
+ ],
52
+ "default": "icon-label",
53
+ "description": "Controls whether the tab displays a label, an icon, or both."
54
+ },
55
+ "density": {
56
+ "type": "string",
57
+ "enum": [
58
+ "compact",
59
+ "regular"
60
+ ],
61
+ "default": "regular"
62
+ },
63
+ "isFluid": {
64
+ "type": "boolean",
65
+ "default": false,
66
+ "description": "This overrides density and is only applicable to horizontal tabs."
67
+ },
68
+ "isEmphasized": {
69
+ "type": "boolean",
70
+ "default": false
71
+ },
72
+ "alignment": {
73
+ "type": "string",
74
+ "enum": [
75
+ "start",
76
+ "center"
77
+ ],
78
+ "default": "start"
79
+ },
80
+ "selectedItem": {
81
+ "description": "(list of available items)"
82
+ },
83
+ "keyboardActivation": {
84
+ "type": "string",
85
+ "enum": [
86
+ "manual",
87
+ "automatic"
88
+ ],
89
+ "default": "manual"
90
+ }
91
+ }
92
+ }
52
93
  }
53
94
  }
54
95
  }
package/schemas/components/tag-field.json ADDED
@@ -0,0 +1,51 @@
1
+ {
2
+ "$schema": "https://opensource.adobe.com/spectrum-tokens/schemas/component.json",
3
+ "$id": "https://opensource.adobe.com/spectrum-tokens/schemas/components/tag-field.json",
4
+ "title": "Tag field",
5
+ "description": "A tag field is an input field that allows users to enter and manage tags.",
6
+ "meta": {
7
+ "category": "inputs",
8
+ "documentationUrl": "https://spectrum.adobe.com/page/tag-field/"
9
+ },
10
+ "type": "object",
11
+ "properties": {
12
+ "size": {
13
+ "type": "string",
14
+ "enum": [
15
+ "s",
16
+ "m",
17
+ "l"
18
+ ],
19
+ "default": "m"
20
+ },
21
+ "state": {
22
+ "type": "string",
23
+ "enum": [
24
+ "default",
25
+ "hover",
26
+ "focus + hover",
27
+ "focus + not hover",
28
+ "keyboard focus"
29
+ ],
30
+ "default": "default"
31
+ },
32
+ "style": {
33
+ "type": "string",
34
+ "enum": [
35
+ "keyword",
36
+ "icon",
37
+ "thumbnail",
38
+ "avatar"
39
+ ],
40
+ "default": "keyword"
41
+ },
42
+ "isDisabled": {
43
+ "type": "boolean",
44
+ "default": false
45
+ },
46
+ "hideLabel": {
47
+ "type": "boolean",
48
+ "default": false
49
+ }
50
+ }
51
+ }
package/schemas/components/tag-group.json ADDED
@@ -0,0 +1,38 @@
1
+ {
2
+ "$schema": "https://opensource.adobe.com/spectrum-tokens/schemas/component.json",
3
+ "$id": "https://opensource.adobe.com/spectrum-tokens/schemas/components/tag-group.json",
4
+ "title": "Tag group",
5
+ "description": "A tag group is a collection of tags that represent a set of related items.",
6
+ "meta": {
7
+ "category": "inputs",
8
+ "documentationUrl": "https://spectrum.adobe.com/page/tag-group/"
9
+ },
10
+ "type": "object",
11
+ "properties": {
12
+ "size": {
13
+ "type": "string",
14
+ "enum": [
15
+ "s",
16
+ "m",
17
+ "l"
18
+ ],
19
+ "default": "m"
20
+ },
21
+ "labelPosition": {
22
+ "type": "string",
23
+ "enum": [
24
+ "top",
25
+ "side"
26
+ ],
27
+ "default": "top"
28
+ },
29
+ "hideLabel": {
30
+ "type": "boolean",
31
+ "default": false
32
+ },
33
+ "actionLabel": {
34
+ "type": "string",
35
+ "description": "If undefined, this button does not appear."
36
+ }
37
+ }
38
+ }
package/schemas/components/text-area.json CHANGED
@@ -17,6 +17,10 @@
17
17
  "default": "top",
18
18
  "enum": ["top", "side"]
19
19
  },
20
+ "hideLabel": {
21
+ "type": "boolean",
22
+ "default": false
23
+ },
20
24
  "value": {
21
25
  "type": "string",
22
26
  "description": "from minValue to maxValue"
package/schemas/components/text-field.json CHANGED
@@ -15,7 +15,14 @@
15
15
  "labelPosition": {
16
16
  "type": "string",
17
17
  "default": "top",
18
- "enum": ["top", "side"]
18
+ "enum": [
19
+ "top",
20
+ "side"
21
+ ]
22
+ },
23
+ "hideLabel": {
24
+ "type": "boolean",
25
+ "default": false
19
26
  },
20
27
  "value": {
21
28
  "type": "string",
@@ -26,12 +33,20 @@
26
33
  },
27
34
  "size": {
28
35
  "type": "string",
29
- "enum": ["s", "m", "l", "xl"],
36
+ "enum": [
37
+ "s",
38
+ "m",
39
+ "l",
40
+ "xl"
41
+ ],
30
42
  "default": "m"
31
43
  },
32
44
  "necessityIndicator": {
33
45
  "type": "string",
34
- "enum": ["text", "icon"],
46
+ "enum": [
47
+ "text",
48
+ "icon"
49
+ ],
35
50
  "default": "icon"
36
51
  },
37
52
  "isRequired": {
@@ -49,7 +64,7 @@
49
64
  "isError": {
50
65
  "type": "boolean",
51
66
  "default": false,
52
- "description": "If there’s an error, this property overrides show valid icon."
67
+ "description": "If there is an error, this property overrides show valid icon."
53
68
  },
54
69
  "isDisabled": {
55
70
  "type": "boolean",
package/schemas/components/tooltip.json CHANGED
@@ -14,12 +14,12 @@
14
14
  },
15
15
  "variant": {
16
16
  "type": "string",
17
- "enum": ["neutral", "informative", "positive", "negative"],
17
+ "enum": ["neutral", "informative", "negative"],
18
18
  "default": "neutral"
19
19
  },
20
20
  "hasIcon": {
21
21
  "type": "boolean",
22
- "description": "If the neutral variant, there’s never an icon.",
22
+ "description": "If the neutral variant, there is never an icon.",
23
23
  "default": false
24
24
  },
25
25
  "maxWidth": {
package/schemas/components/tree-view.json CHANGED
@@ -18,7 +18,7 @@
18
18
  "type": "boolean",
19
19
  "default": false
20
20
  },
21
- "emphasized": {
21
+ "isEmphasized": {
22
22
  "type": "boolean",
23
23
  "default": false
24
24
  },