@adobe/spectrum-component-api-schemas 5.0.1 → 6.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.
- package/CHANGELOG.md +161 -184
- package/package.json +4 -4
- package/schemas/component.json +5 -2
- package/schemas/components/accordion.json +2 -2
- package/schemas/components/action-bar.json +2 -2
- package/schemas/components/action-button.json +4 -4
- package/schemas/components/action-group.json +2 -2
- package/schemas/components/alert-banner.json +2 -2
- package/schemas/components/alert-dialog.json +2 -2
- package/schemas/components/avatar-group.json +2 -2
- package/schemas/components/avatar.json +2 -2
- package/schemas/components/badge.json +3 -3
- package/schemas/components/body.json +4 -4
- package/schemas/components/bottom-navigation-android.json +3 -3
- package/schemas/components/breadcrumbs.json +2 -2
- package/schemas/components/button-group.json +2 -2
- package/schemas/components/button.json +3 -3
- package/schemas/components/calendar.json +90 -99
- package/schemas/components/cards.json +2 -2
- package/schemas/components/checkbox-group.json +2 -2
- package/schemas/components/checkbox.json +2 -2
- package/schemas/components/close-button.json +2 -2
- package/schemas/components/coach-indicator.json +2 -2
- package/schemas/components/coach-mark.json +2 -2
- package/schemas/components/code.json +3 -3
- package/schemas/components/color-area.json +2 -2
- package/schemas/components/color-handle.json +2 -2
- package/schemas/components/color-loupe.json +3 -3
- package/schemas/components/color-slider.json +2 -2
- package/schemas/components/color-wheel.json +2 -2
- package/schemas/components/combo-box.json +2 -2
- package/schemas/components/contextual-help.json +2 -2
- package/schemas/components/date-picker.json +2 -2
- package/schemas/components/detail.json +3 -3
- package/schemas/components/divider.json +2 -2
- package/schemas/components/drop-zone.json +2 -2
- package/schemas/components/field-label.json +2 -2
- package/schemas/components/heading.json +4 -4
- package/schemas/components/help-text.json +2 -2
- package/schemas/components/illustrated-message.json +42 -49
- package/schemas/components/in-field-progress-button.json +2 -2
- package/schemas/components/in-field-progress-circle.json +2 -2
- package/schemas/components/in-line-alert.json +2 -2
- package/schemas/components/link.json +2 -2
- package/schemas/components/list-view.json +81 -98
- package/schemas/components/menu.json +3 -3
- package/schemas/components/meter.json +2 -2
- package/schemas/components/number-field.json +2 -2
- package/schemas/components/opacity-checkerboard.json +2 -2
- package/schemas/components/picker.json +6 -20
- package/schemas/components/popover.json +2 -2
- package/schemas/components/progress-bar.json +2 -2
- package/schemas/components/progress-circle.json +2 -2
- package/schemas/components/radio-button.json +2 -2
- package/schemas/components/radio-group.json +2 -2
- package/schemas/components/rating.json +2 -2
- package/schemas/components/scroll-zoom-bar.json +2 -2
- package/schemas/components/search-field.json +3 -3
- package/schemas/components/segmented-control.json +2 -2
- package/schemas/components/select-box.json +2 -2
- package/schemas/components/side-navigation.json +7 -25
- package/schemas/components/slider.json +2 -2
- package/schemas/components/standard-dialog.json +46 -50
- package/schemas/components/standard-panel.json +2 -2
- package/schemas/components/status-light.json +2 -2
- package/schemas/components/steplist.json +2 -2
- package/schemas/components/swatch-group.json +2 -2
- package/schemas/components/swatch.json +2 -2
- package/schemas/components/switch.json +2 -2
- package/schemas/components/tab-bar-ios.json +3 -3
- package/schemas/components/table.json +107 -133
- package/schemas/components/tabs.json +2 -2
- package/schemas/components/tag-field.json +2 -2
- package/schemas/components/tag-group.json +2 -2
- package/schemas/components/tag.json +2 -2
- package/schemas/components/takeover-dialog.json +47 -53
- package/schemas/components/text-area.json +2 -2
- package/schemas/components/text-field.json +2 -2
- package/schemas/components/thumbnail.json +2 -2
- package/schemas/components/toast.json +2 -2
- package/schemas/components/tooltip.json +2 -2
- package/schemas/components/tray.json +2 -2
- package/schemas/components/tree-view.json +2 -2
- package/schemas/types/hex-color.json +1 -1
- package/schemas/types/typography-classification.json +1 -1
- package/schemas/types/typography-script.json +1 -1
- package/schemas/types/workflow-icon.json +1 -1
- package/test/performance.test.js +3 -3
- package/test/snapshots/index.test.js.md +36 -34
package/CHANGELOG.md
CHANGED
|
@@ -1,10 +1,27 @@
|
|
|
1
1
|
# [**@adobe/spectrum-component-api-schemas**](https://github.com/adobe/spectrum-component-api-schemas)
|
|
2
2
|
|
|
3
|
+
## 6.0.0
|
|
4
|
+
|
|
5
|
+
### Major Changes
|
|
6
|
+
|
|
7
|
+
- [#632](https://github.com/adobe/spectrum-design-data/pull/632) [`fa28b11`](https://github.com/adobe/spectrum-design-data/commit/fa28b117c6b84776f4ebe9bb281c29e14e0d64b6) Thanks [@GarthDB](https://github.com/GarthDB)! - BREAKING CHANGE: Repository renamed from spectrum-tokens to
|
|
8
|
+
spectrum-design-data
|
|
9
|
+
|
|
10
|
+
**Breaking Changes:**
|
|
11
|
+
- JSON Schema `$id` URIs changed (spectrum-tokens → spectrum-design-data)
|
|
12
|
+
- External tools referencing schemas by `$id` must update references
|
|
13
|
+
|
|
14
|
+
**Changes:**
|
|
15
|
+
- Updated all GitHub repository and Pages URLs
|
|
16
|
+
- Updated schema base URIs to maintain consistency
|
|
17
|
+
|
|
18
|
+
**Note:** NPM package names unchanged. GitHub redirects are in place.
|
|
19
|
+
|
|
3
20
|
## 5.0.1
|
|
4
21
|
|
|
5
22
|
### Patch Changes
|
|
6
23
|
|
|
7
|
-
|
|
24
|
+
- [#621](https://github.com/adobe/spectrum-design-data/pull/621) [`ee2ceb5`](https://github.com/adobe/spectrum-design-data/commit/ee2ceb541dea5eb9b5267c861e44bfd804fd33a7) Thanks [@GarthDB](https://github.com/GarthDB)! - refactor(component-schemas): rename step-list to steplist
|
|
8
25
|
|
|
9
26
|
Renamed the `step-list` component schema to `steplist` for consistency with other single-word component names.
|
|
10
27
|
|
|
@@ -15,14 +32,12 @@
|
|
|
15
32
|
**New Branch:** `refactor/rename-step-list-to-steplist`
|
|
16
33
|
|
|
17
34
|
### 📦 Renamed Component
|
|
18
|
-
|
|
19
|
-
* `step-list` → `steplist` - Component schema renamed
|
|
35
|
+
- `step-list` → `steplist` - Component schema renamed
|
|
20
36
|
|
|
21
37
|
### Changes to steplist schema
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
* **documentationUrl**: Changed from `https://spectrum.adobe.com/page/step-list/` to `https://spectrum.adobe.com/page/steplist/`
|
|
38
|
+
- **$id**: Changed from `https://opensource.adobe.com/spectrum-design-data/schemas/components/step-list.json` to `https://opensource.adobe.com/spectrum-design-data/schemas/components/steplist.json`
|
|
39
|
+
- **title**: Changed from "Step list" to "Steplist"
|
|
40
|
+
- **documentationUrl**: Changed from `https://spectrum.adobe.com/page/step-list/` to `https://spectrum.adobe.com/page/steplist/`
|
|
26
41
|
|
|
27
42
|
All other properties remain unchanged. This is a non-breaking rename at the schema level, though consumers referencing the old filename will need to update their imports.
|
|
28
43
|
|
|
@@ -30,7 +45,7 @@
|
|
|
30
45
|
|
|
31
46
|
### Major Changes
|
|
32
47
|
|
|
33
|
-
|
|
48
|
+
- [#614](https://github.com/adobe/spectrum-design-data/pull/614) [`a772572`](https://github.com/adobe/spectrum-design-data/commit/a772572de88c54d279c20d7148f6ac91eb941d2a) Thanks [@AmunMRa](https://github.com/AmunMRa)! - # Component Schemas Changed (9 added, 0 deleted, 3 updated)
|
|
34
49
|
|
|
35
50
|
**Original Branch:** `main`
|
|
36
51
|
|
|
@@ -41,40 +56,36 @@
|
|
|
41
56
|
This PR introduces **2 breaking change(s)** to component schemas. Please review carefully and ensure proper versioning.
|
|
42
57
|
|
|
43
58
|
### 📦 Added Components (9)
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
* `takeover-dialog` - New component schema
|
|
59
|
+
- `calendar` - New component schema
|
|
60
|
+
- `cards` - New component schema
|
|
61
|
+
- `coach-mark` - New component schema
|
|
62
|
+
- `illustrated-message` - New component schema
|
|
63
|
+
- `list-view` - New component schema
|
|
64
|
+
- `standard-dialog` - New component schema
|
|
65
|
+
- `standard-panel` - New component schema
|
|
66
|
+
- `table` - New component schema
|
|
67
|
+
- `takeover-dialog` - New component schema
|
|
54
68
|
|
|
55
69
|
### 💥 Breaking Updates ⚠️ BREAKING
|
|
56
70
|
|
|
57
71
|
**picker**
|
|
58
|
-
|
|
59
|
-
* Removed: `isReadOnly` property
|
|
72
|
+
- Removed: `isReadOnly` property
|
|
60
73
|
|
|
61
74
|
**side-navigation**
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
* Added: `required` - \["items"]
|
|
75
|
+
- Added: `items` (array) - "The list of navigation items."
|
|
76
|
+
- Added: `selectionMode` (string, default: single) - "How selection is handled for items."
|
|
77
|
+
- Added: `required` - \["items"]
|
|
66
78
|
|
|
67
79
|
### 🔄 Non-Breaking Updates
|
|
68
80
|
|
|
69
81
|
**alert-banner**
|
|
70
|
-
|
|
71
|
-
* Added: `variant`
|
|
82
|
+
- Added: `variant`
|
|
72
83
|
|
|
73
84
|
## 4.0.0
|
|
74
85
|
|
|
75
86
|
### Major Changes
|
|
76
87
|
|
|
77
|
-
|
|
88
|
+
- [#613](https://github.com/adobe/spectrum-design-data/pull/613) [`433efdd`](https://github.com/adobe/spectrum-design-data/commit/433efdd18f9b0842ae55acac3cd0fbc1e5e5db58) Thanks [@AmunMRa](https://github.com/AmunMRa)! - feat(component-schemas): add 10 new components with breaking changes to existing schemas
|
|
78
89
|
|
|
79
90
|
## Component Schemas Changed (10 added, 0 deleted, 17 updated)
|
|
80
91
|
|
|
@@ -103,103 +114,86 @@
|
|
|
103
114
|
<details open><summary><strong>💥 Breaking Updates ⚠️ BREAKING</strong></summary>
|
|
104
115
|
|
|
105
116
|
**checkbox-group**
|
|
106
|
-
|
|
107
|
-
* Removed: `isReadOnly` property
|
|
117
|
+
- Removed: `isReadOnly` property
|
|
108
118
|
|
|
109
119
|
**combo-box**
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
* Removed: `isQuiet` property
|
|
120
|
+
- Added: `labelPosition`
|
|
121
|
+
- Removed: `isQuiet` property
|
|
113
122
|
|
|
114
123
|
**contextual-help**
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
* Updated: `popoverOffset` - default changed to "8"
|
|
124
|
+
- Added: `href` (string) - "Optional URL within contextual help content like a 'Learn more' link."
|
|
125
|
+
- Removed: `popoverOffset` property
|
|
126
|
+
- Updated: `popoverOffset` - default changed to "8"
|
|
119
127
|
|
|
120
128
|
**radio-button**
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
* Updated: `label`
|
|
129
|
+
- Added: `label` - "The text displayed next to a radio button."
|
|
130
|
+
- Removed: `label` property
|
|
131
|
+
- Updated: `label`
|
|
125
132
|
|
|
126
133
|
**radio-group**
|
|
127
|
-
|
|
128
|
-
* Removed: `isReadOnly` property
|
|
134
|
+
- Removed: `isReadOnly` property
|
|
129
135
|
|
|
130
136
|
**tabs**
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
* Updated: `orientation` - default changed to "horizontal"
|
|
137
|
+
- Added: `items` (array) - "An array of tab items."
|
|
138
|
+
- Removed: `size` property
|
|
139
|
+
- Removed: `density` property
|
|
140
|
+
- Removed: `isFluid` property
|
|
141
|
+
- Removed: `isQuiet` property
|
|
142
|
+
- Removed: `isEmphasized` property
|
|
143
|
+
- Removed: `alignment` property
|
|
144
|
+
- Removed: `selectedItem` property
|
|
145
|
+
- Removed: `keyboardActivation` property
|
|
146
|
+
- Updated: `orientation` - default changed to "horizontal"
|
|
142
147
|
|
|
143
148
|
**tree-view**
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
* Removed: `emphasized` property
|
|
149
|
+
- Added: `isEmphasized` (boolean)
|
|
150
|
+
- Removed: `emphasized` property
|
|
147
151
|
|
|
148
152
|
</details>
|
|
149
153
|
|
|
150
154
|
<details><summary><strong>🔄 Non-Breaking Updates</strong></summary>
|
|
151
155
|
|
|
152
156
|
**breadcrumbs**
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
* Added: `sizeOverride` (string) - "Overrides the size of the breadcrumb items when isMultiline is true."
|
|
157
|
+
- Added: `isMultiline` (boolean) - "If true, the breadcrumb items will wrap to multiple lines."
|
|
158
|
+
- Added: `size` (string, default: m) - "Controls the overall size of the breadcrumb component."
|
|
159
|
+
- Added: `items` (array) - "An array of breadcrumb items."
|
|
160
|
+
- Added: `separator` (string, default: chevron) - "The separator icon used between breadcrumb items."
|
|
161
|
+
- Added: `isTruncated` (boolean) - "If true, the breadcrumb item is truncated and displayed as icon only."
|
|
162
|
+
- Added: `sizeOverride` (string) - "Overrides the size of the breadcrumb items when isMultiline is true."
|
|
160
163
|
|
|
161
164
|
**menu**
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
* Updated: `selectionMode` - removed `default: null` and added `"no selection"` to enum
|
|
165
|
+
- Updated: `container` - removed `default: null`
|
|
166
|
+
- Updated: `selectionMode` - removed `default: null` and added `"no selection"` to enum
|
|
165
167
|
|
|
166
168
|
**button-group**
|
|
167
|
-
|
|
168
|
-
* Added: `overflowMode` (string, default: wrap)
|
|
169
|
+
- Added: `overflowMode` (string, default: wrap)
|
|
169
170
|
|
|
170
171
|
**color-slider**
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
* Updated: `value` - "Number (from minValue to maxValue)."
|
|
172
|
+
- Added: `channel` (string, default: hue) - "Which channel of the color this slider controls. Use 'alpha' for opacity."
|
|
173
|
+
- Updated: `value` - "Number (from minValue to maxValue)."
|
|
174
174
|
|
|
175
175
|
**divider**
|
|
176
|
-
|
|
177
|
-
* Updated: `size` - default changed to "s"
|
|
176
|
+
- Updated: `size` - default changed to "s"
|
|
178
177
|
|
|
179
178
|
**in-line-alert**
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
* Updated: `variant`
|
|
179
|
+
- Added: `style` (string, default: outline) - "The visual style of the alert."
|
|
180
|
+
- Added: `href` (string) - "Optional URL within in-line alert content like a 'Learn more' link."
|
|
181
|
+
- Added: `heading` (string) - "Optional heading text displayed at the top of the alert."
|
|
182
|
+
- Added: `actionLabel` (string) - "If undefined, this button does not appear."
|
|
183
|
+
- Updated: `variant`
|
|
186
184
|
|
|
187
185
|
**slider**
|
|
188
|
-
|
|
189
|
-
* Added: `isRange` (boolean) - "If true, the slider will allow selection of a range of values by displaying two handles."
|
|
186
|
+
- Added: `isRange` (boolean) - "If true, the slider will allow selection of a range of values by displaying two handles."
|
|
190
187
|
|
|
191
188
|
**swatch-group**
|
|
192
|
-
|
|
193
|
-
* Added: `cornerRadius` (string, default: none) - "Determines the corner radius of each swatch in the group. Partial refers to corner-radius-75."
|
|
189
|
+
- Added: `cornerRadius` (string, default: none) - "Determines the corner radius of each swatch in the group. Partial refers to corner-radius-75."
|
|
194
190
|
|
|
195
191
|
**swatch**
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
* Updated: `cornerRounding` - default changed to "none"
|
|
192
|
+
- Added: `cornerRounding` - "Determines the corner radius of the swatch. Partial refers to corner-radius-75."
|
|
193
|
+
- Updated: `cornerRounding` - default changed to "none"
|
|
199
194
|
|
|
200
195
|
**text-field**
|
|
201
|
-
|
|
202
|
-
* Updated: `isError` - "If there is an error, this property overrides show valid icon."
|
|
196
|
+
- Updated: `isError` - "If there is an error, this property overrides show valid icon."
|
|
203
197
|
|
|
204
198
|
</details>
|
|
205
199
|
|
|
@@ -207,7 +201,7 @@
|
|
|
207
201
|
|
|
208
202
|
### Major Changes
|
|
209
203
|
|
|
210
|
-
|
|
204
|
+
- [#610](https://github.com/adobe/spectrum-design-data/pull/610) [`13d9202`](https://github.com/adobe/spectrum-design-data/commit/13d920273c02c78d3748522de6a7c7ee39b39814) Thanks [@GarthDB](https://github.com/GarthDB)! - Component schema improvements for Batch 1 components
|
|
211
205
|
|
|
212
206
|
Quality control pass on the Design API table for v0, ensuring schema consistency and completeness across S2 components.
|
|
213
207
|
|
|
@@ -223,31 +217,26 @@
|
|
|
223
217
|
<details open><summary><strong>💥 Breaking Updates</strong></summary>
|
|
224
218
|
|
|
225
219
|
**popover**
|
|
226
|
-
|
|
227
|
-
* Added: `hideTip` (boolean, default: false) - replaces removed `showTip`
|
|
220
|
+
- Added: `hideTip` (boolean, default: false) - replaces removed `showTip`
|
|
228
221
|
|
|
229
222
|
**rating**
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
* Updated: `value.description` - "From 0 to 5, can be a decimal to represent half stars"
|
|
223
|
+
- Added: `value.minimum` (0), `value.maximum` (5), `value.multipleOf` (0.5)
|
|
224
|
+
- Updated: `value.description` - "From 0 to 5, can be a decimal to represent half stars"
|
|
233
225
|
|
|
234
226
|
**select-box**
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
* Updated: `orientation.default` changed to "vertical"
|
|
227
|
+
- Added: `hideIllustration` (boolean, default: false) - replaces removed `showIllustration`
|
|
228
|
+
- Added: `isDisabled` (boolean, default: false)
|
|
229
|
+
- Added: `multiple` (boolean, default: false) - "Set to true to allow multiple selections"
|
|
230
|
+
- Updated: `orientation.default` changed to "vertical"
|
|
240
231
|
|
|
241
232
|
**status-light**
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
* Removed: `isDisabled` property
|
|
233
|
+
- Added: Colors to `variant.enum`: "gray", "red", "orange", "green", "cyan"
|
|
234
|
+
- Added: `required` - \["label"] - label is now required
|
|
235
|
+
- Removed: `isDisabled` property
|
|
246
236
|
|
|
247
237
|
**tooltip**
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
* Updated: `hasIcon.description` - "If the neutral variant, there is never an icon"
|
|
238
|
+
- Removed: "positive" from `variant.enum`
|
|
239
|
+
- Updated: `hasIcon.description` - "If the neutral variant, there is never an icon"
|
|
251
240
|
|
|
252
241
|
</details>
|
|
253
242
|
|
|
@@ -256,32 +245,26 @@
|
|
|
256
245
|
<details><summary><strong>🔄 Compatible Changes</strong></summary>
|
|
257
246
|
|
|
258
247
|
**help-text**
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
* Added: `isDisabled.description` - "Help text cannot be both disabled and negative variant"
|
|
248
|
+
- Added: "negative" to `variant.enum`
|
|
249
|
+
- Added: `isDisabled.description` - "Help text cannot be both disabled and negative variant"
|
|
262
250
|
|
|
263
251
|
**meter**
|
|
264
|
-
|
|
265
|
-
* Added: `hideLabel` (boolean, default: false)
|
|
252
|
+
- Added: `hideLabel` (boolean, default: false)
|
|
266
253
|
|
|
267
254
|
**progress-bar**
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
* Added: `hideLabel` (boolean, default: false)
|
|
255
|
+
- Added: `staticColor` (string, enum: \["white"]) - "Static color can only be white, otherwise it is default"
|
|
256
|
+
- Added: `labelPosition` (string, enum: \["top", "side"], default: "top")
|
|
257
|
+
- Added: `hideLabel` (boolean, default: false)
|
|
272
258
|
|
|
273
259
|
**search-field**
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
* Added: `icon` ($ref: workflow-icon.json) - "Icon must be present if the label is not defined"
|
|
260
|
+
- Added: `hideLabel` (boolean, default: false)
|
|
261
|
+
- Added: `icon` ($ref: workflow-icon.json) - "Icon must be present if the label is not defined"
|
|
277
262
|
|
|
278
263
|
**text-area**
|
|
279
|
-
|
|
280
|
-
* Added: `hideLabel` (boolean, default: false)
|
|
264
|
+
- Added: `hideLabel` (boolean, default: false)
|
|
281
265
|
|
|
282
266
|
**text-field**
|
|
283
|
-
|
|
284
|
-
* Added: `hideLabel` (boolean, default: false)
|
|
267
|
+
- Added: `hideLabel` (boolean, default: false)
|
|
285
268
|
|
|
286
269
|
</details>
|
|
287
270
|
|
|
@@ -289,126 +272,120 @@
|
|
|
289
272
|
|
|
290
273
|
### Major Changes
|
|
291
274
|
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
275
|
+
- [#581](https://github.com/adobe/spectrum-design-data/pull/581) [`163fe7c`](https://github.com/adobe/spectrum-design-data/commit/163fe7c13bb00c639d202195a398126b6c25b58f) Thanks [@GarthDB](https://github.com/GarthDB)! - feat(component-schemas): add S2 Batch 2 components with breaking changes
|
|
276
|
+
- Add 6 new component schemas (coach-indicator, in-field-progress-button, etc.)
|
|
277
|
+
- Update avatar, badge, and checkbox components with breaking changes
|
|
278
|
+
- Expand size options and add new interaction states
|
|
279
|
+
- Major version bump required due to breaking schema changes
|
|
297
280
|
|
|
298
281
|
## 1.0.2
|
|
299
282
|
|
|
300
283
|
### Patch Changes
|
|
301
284
|
|
|
302
|
-
|
|
285
|
+
- [#545](https://github.com/adobe/spectrum-design-data/pull/545) [`ebc79f6`](https://github.com/adobe/spectrum-design-data/commit/ebc79f6f91bce28a64cddfc2cc5548ddcf30389d) Thanks [@GarthDB](https://github.com/GarthDB)! - Fixed a typo where meter had `valueLable` instead of `valueLabel`.
|
|
303
286
|
|
|
304
287
|
## 1.0.1
|
|
305
288
|
|
|
306
289
|
### Patch Changes
|
|
307
290
|
|
|
308
|
-
|
|
291
|
+
- [#523](https://github.com/adobe/spectrum-design-data/pull/523) [`9c5a2ac`](https://github.com/adobe/spectrum-design-data/commit/9c5a2ac5fccb29b6f106396b21d91aab949043d4) Thanks [@GarthDB](https://github.com/GarthDB)! - S2 components batch 1 (part 2)
|
|
309
292
|
|
|
310
293
|
## Changes
|
|
311
294
|
|
|
312
295
|
### Properties added
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
* `body`
|
|
296
|
+
- component: select-box
|
|
297
|
+
- `body`
|
|
316
298
|
|
|
317
299
|
### Properties updated
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
* removed: `"default": null`
|
|
300
|
+
- component: text-area
|
|
301
|
+
- `errorMessage`
|
|
302
|
+
- removed: `"default": null`
|
|
322
303
|
|
|
323
304
|
## 1.0.0
|
|
324
305
|
|
|
325
306
|
### Major Changes
|
|
326
307
|
|
|
327
|
-
|
|
308
|
+
- [#520](https://github.com/adobe/spectrum-design-data/pull/520) [`2964807`](https://github.com/adobe/spectrum-design-data/commit/2964807641908e40820bea0556b3b0542503223b) Thanks [@GarthDB](https://github.com/GarthDB) and [@AmunMRa](https://github.com/AmunMRa)! - S2 components batch 1
|
|
328
309
|
|
|
329
310
|
## Changes
|
|
330
311
|
|
|
331
312
|
### Properties Added
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
* `helpText`
|
|
313
|
+
- component: search-field
|
|
314
|
+
- `helpText`
|
|
315
|
+
- `placeholder`
|
|
316
|
+
- `state`:
|
|
317
|
+
- `down`
|
|
318
|
+
- component: status-light
|
|
319
|
+
- `variant`
|
|
320
|
+
- `seafoam`
|
|
321
|
+
- `pink`
|
|
322
|
+
- `turquoise`
|
|
323
|
+
- `cinnamon`
|
|
324
|
+
- `brown`
|
|
325
|
+
- `silver`
|
|
326
|
+
- component: text-area
|
|
327
|
+
- `helpText`
|
|
328
|
+
- component: text-field
|
|
329
|
+
- `helpText`
|
|
350
330
|
|
|
351
331
|
### Properties removed
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
* `isReadOnly`
|
|
332
|
+
- component: search-field
|
|
333
|
+
- `isQuiet`
|
|
334
|
+
- component: text-area
|
|
335
|
+
- `isQuiet`
|
|
336
|
+
- `isReadOnly`
|
|
337
|
+
- component: text-field
|
|
338
|
+
- `isQuiet`
|
|
339
|
+
- `isReadOnly`
|
|
361
340
|
|
|
362
341
|
### Properties updated
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
* `default`: `6` -> `8`
|
|
342
|
+
- component: meter
|
|
343
|
+
- `size`:
|
|
344
|
+
- `enum`: `["small", "large"]` -> `["s", "m", "l", "xl"]`
|
|
345
|
+
- `default`: `large` -> `m`
|
|
346
|
+
- component: popover
|
|
347
|
+
- `showTip`:
|
|
348
|
+
- `default`: `false` -> `true`
|
|
349
|
+
- `placement`:
|
|
350
|
+
- `default`: `bottom` -> `top`
|
|
351
|
+
- `offset`:
|
|
352
|
+
- `default`: `6` -> `8`
|
|
375
353
|
|
|
376
354
|
### New Component
|
|
377
|
-
|
|
378
|
-
* select-box
|
|
355
|
+
- select-box
|
|
379
356
|
|
|
380
357
|
## 0.0.0
|
|
381
358
|
|
|
382
359
|
### Minor Changes
|
|
383
360
|
|
|
384
|
-
|
|
361
|
+
- [#353](https://github.com/adobe/spectrum-design-data/pull/353) [`71e674a`](https://github.com/adobe/spectrum-design-data/commit/71e674ad6baa630a900785ae21c9dcae93233b21) Thanks [@karstens](https://github.com/karstens)! - Release to latest branch
|
|
385
362
|
|
|
386
363
|
## 0.0.0-schema-20240821152525
|
|
387
364
|
|
|
388
365
|
### Patch Changes
|
|
389
366
|
|
|
390
|
-
|
|
367
|
+
- [#353](https://github.com/adobe/spectrum-design-data/pull/353) [`dc2d6c6`](https://github.com/adobe/spectrum-design-data/commit/dc2d6c6e12c1ea4fdc0d891b3fd50ea0b1697dd7) Thanks [@karstens](https://github.com/karstens)! - Making adjustments to bring the schema more in line with what was on the spectrum website.
|
|
391
368
|
|
|
392
369
|
## 0.0.0-schema-20240620220450
|
|
393
370
|
|
|
394
371
|
### Minor Changes
|
|
395
372
|
|
|
396
|
-
|
|
373
|
+
- [#353](https://github.com/adobe/spectrum-design-data/pull/353) [`64379eb`](https://github.com/adobe/spectrum-design-data/commit/64379ebeaf9402fe77ca1adfd020f42df60c60d9) Thanks [@karstens](https://github.com/karstens)! - Added schema for search-field and fixed some path bugs in testing
|
|
397
374
|
|
|
398
375
|
## 0.0.0-schema-20240618053842
|
|
399
376
|
|
|
400
377
|
### Minor Changes
|
|
401
378
|
|
|
402
|
-
|
|
379
|
+
- [#353](https://github.com/adobe/spectrum-design-data/pull/353) [`b5c1579`](https://github.com/adobe/spectrum-design-data/commit/b5c15792ec5f5e5c269bfa7bf58af3df42e648c1) Thanks [@karstens](https://github.com/karstens)! - Initial release
|
|
403
380
|
|
|
404
381
|
## 0.0.0-schema-20240614194147
|
|
405
382
|
|
|
406
383
|
### Patch Changes
|
|
407
384
|
|
|
408
|
-
|
|
385
|
+
- [#353](https://github.com/adobe/spectrum-design-data/pull/353) [`9805167`](https://github.com/adobe/spectrum-design-data/commit/980516791c0bef9e2f0bbeffe6515f103f3ad7a2) Thanks [@karstens](https://github.com/karstens)! - fixed some bugs
|
|
409
386
|
|
|
410
387
|
## 0.0.0-schema-20240613154750
|
|
411
388
|
|
|
412
389
|
### Patch Changes
|
|
413
390
|
|
|
414
|
-
|
|
391
|
+
- [#353](https://github.com/adobe/spectrum-design-data/pull/353) [`6ff5ad7`](https://github.com/adobe/spectrum-design-data/commit/6ff5ad7a75356f4b93d07a2818b357da19ce5b4b) Thanks [@karstens](https://github.com/karstens)! - Initial release
|
package/package.json
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@adobe/spectrum-component-api-schemas",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "6.0.0",
|
|
4
4
|
"description": "",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "index.js",
|
|
7
7
|
"repository": {
|
|
8
8
|
"type": "git",
|
|
9
|
-
"url": "git+https://github.com/adobe/spectrum-
|
|
9
|
+
"url": "git+https://github.com/adobe/spectrum-design-data.git"
|
|
10
10
|
},
|
|
11
11
|
"author": "Garth Braithwaite <garthdb@gmail.com> (https://garthdb.com/)",
|
|
12
12
|
"bugs": {
|
|
13
|
-
"url": "https://github.com/adobe/spectrum-
|
|
13
|
+
"url": "https://github.com/adobe/spectrum-design-data/issues"
|
|
14
14
|
},
|
|
15
15
|
"publishConfig": {
|
|
16
16
|
"provenance": true
|
|
17
17
|
},
|
|
18
|
-
"homepage": "https://github.com/adobe/spectrum-
|
|
18
|
+
"homepage": "https://github.com/adobe/spectrum-design-data/tree/main/packages/component-schemas#readme",
|
|
19
19
|
"license": "Apache-2.0",
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"glob": "^10.3.12"
|
package/schemas/component.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
-
"$id": "https://opensource.adobe.com/spectrum-
|
|
3
|
+
"$id": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
|
|
4
4
|
"title": "Component",
|
|
5
5
|
"type": "object",
|
|
6
6
|
"properties": {
|
|
@@ -20,7 +20,10 @@
|
|
|
20
20
|
"typography"
|
|
21
21
|
]
|
|
22
22
|
},
|
|
23
|
-
"documentationUrl": {
|
|
23
|
+
"documentationUrl": {
|
|
24
|
+
"type": "string",
|
|
25
|
+
"format": "uri"
|
|
26
|
+
}
|
|
24
27
|
},
|
|
25
28
|
"required": ["category", "documentationUrl"]
|
|
26
29
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
|
-
"$schema": "https://opensource.adobe.com/spectrum-
|
|
3
|
-
"$id": "https://opensource.adobe.com/spectrum-
|
|
2
|
+
"$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
|
|
3
|
+
"$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/accordion.json",
|
|
4
4
|
"title": "Accordion",
|
|
5
5
|
"description": "An accordion is a vertically stacked set of interactive headings that each contain a title and a content area.",
|
|
6
6
|
"meta": {
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
|
-
"$schema": "https://opensource.adobe.com/spectrum-
|
|
3
|
-
"$id": "https://opensource.adobe.com/spectrum-
|
|
2
|
+
"$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
|
|
3
|
+
"$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/action-bar.json",
|
|
4
4
|
"title": "Action bar",
|
|
5
5
|
"description": "Action bars are used for single and bulk selection patterns, when a user needs to perform actions on either a single or multiple items at the same time.",
|
|
6
6
|
"meta": {
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
|
-
"$schema": "https://opensource.adobe.com/spectrum-
|
|
3
|
-
"$id": "https://opensource.adobe.com/spectrum-
|
|
2
|
+
"$schema": "https://opensource.adobe.com/spectrum-design-data/schemas/component.json",
|
|
3
|
+
"$id": "https://opensource.adobe.com/spectrum-design-data/schemas/components/action-button.json",
|
|
4
4
|
"title": "Action button",
|
|
5
5
|
"description": "Action buttons allow users to perform an action or mark a selection. They're used for similar, task-based options within a workflow, and are ideal for interfaces where buttons aren't meant to draw a lot of attention.",
|
|
6
6
|
"meta": {
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"default": false
|
|
18
18
|
},
|
|
19
19
|
"icon": {
|
|
20
|
-
"$ref": "https://opensource.adobe.com/spectrum-
|
|
20
|
+
"$ref": "https://opensource.adobe.com/spectrum-design-data/schemas/types/workflow-icon.json",
|
|
21
21
|
"description": "Icon must be present if the label is not defined."
|
|
22
22
|
},
|
|
23
23
|
"size": {
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
"description": "Static color must not be set for the default version of this component."
|
|
44
44
|
},
|
|
45
45
|
"selectedTextColor": {
|
|
46
|
-
"$ref": "https://opensource.adobe.com/spectrum-
|
|
46
|
+
"$ref": "https://opensource.adobe.com/spectrum-design-data/schemas/types/hex-color.json"
|
|
47
47
|
},
|
|
48
48
|
"hasHoldIcon": {
|
|
49
49
|
"type": "boolean",
|