@adobe/design-system-registry 0.0.0-layout-20260209174611

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/AUTHORING.md ADDED
@@ -0,0 +1,290 @@
1
+ # Authoring Guide: Spectrum Design System Glossary
2
+
3
+ This guide explains how to author and maintain glossary terms in the Spectrum Design System Registry.
4
+
5
+ ## Overview
6
+
7
+ The Design System Registry serves as the single source of truth for Spectrum design terminology. Each term includes:
8
+
9
+ * **Basic Information**: ID, label, description
10
+ * **Definition**: Structured definition following Spectrum's naming methodology
11
+ * **Platform Variations**: How the term differs across platforms (web, iOS, Android, etc.)
12
+ * **Terminology Metadata**: Classification and naming rationale
13
+ * **Sources**: References to documentation and standards
14
+ * **Governance**: Ownership and review information
15
+ * **Related Terms**: Cross-references to related concepts
16
+
17
+ ## File Structure
18
+
19
+ Registry files are located in `registry/` and organized by type:
20
+
21
+ * `sizes.json` - Size scale values (xs, s, m, l, xl, etc.)
22
+ * `states.json` - Interaction states (default, hover, focus, etc.)
23
+ * `variants.json` - Color and style variants (accent, negative, primary, etc.)
24
+ * `anatomy-terms.json` - Component anatomy parts (edge, visual, text, icon, etc.)
25
+ * `components.json` - Spectrum component names
26
+ * `scale-values.json` - Numeric scale values (50, 75, 100, 200, etc.)
27
+ * `categories.json` - Component categories
28
+ * `platforms.json` - Platform names (desktop, mobile, web, iOS, Android)
29
+
30
+ ## Writing Definitions
31
+
32
+ Follow the [Spectrum Naming and Definition Writing Guide](https://wiki.corp.adobe.com/display/AdobeDesign/Spectrum+Design+System%3A+Naming+and+definition+writing+guide) methodology:
33
+
34
+ ### 1. Superordinate
35
+
36
+ The higher-level category or class this term belongs to. This provides context for the reader.
37
+
38
+ **Examples**:
39
+
40
+ * "interaction state" for states like hover or focus
41
+ * "size value" for size scales
42
+ * "user interface component" for components
43
+ * "design token" for token-related terms
44
+
45
+ ### 2. Description
46
+
47
+ A clear, concise explanation of what the term is and how it differs from related concepts.
48
+
49
+ **Good example**:
50
+
51
+ > "The state when a component receives focus through keyboard navigation, indicating it will respond to keyboard input"
52
+
53
+ **Bad example**:
54
+
55
+ > "When you tab to something"
56
+
57
+ ### 3. Essential Characteristics
58
+
59
+ Key features that distinguish this term from similar concepts. Use bullet points for clarity.
60
+
61
+ **Example for "keyboard-focus"**:
62
+
63
+ * Specifically indicates focus achieved through keyboard interaction (Tab, arrow keys)
64
+ * Requires prominent visual indicator for accessibility (WCAG 2.4.7)
65
+ * Different from generic focus to support :focus-visible patterns
66
+ * Critical for keyboard-only users to understand their current position
67
+
68
+ ## JSON Structure
69
+
70
+ ### Basic Entry (Minimum Required)
71
+
72
+ ```json
73
+ {
74
+ "id": "unique-identifier",
75
+ "label": "Human Readable Label",
76
+ "description": "Brief description of the term",
77
+ "usedIn": ["tokens", "component-schemas"]
78
+ }
79
+ ```
80
+
81
+ ### Enhanced Entry (Full Glossary)
82
+
83
+ ```json
84
+ {
85
+ "id": "keyboard-focus",
86
+ "label": "Keyboard Focus",
87
+ "aliases": ["keyboard focus"],
88
+ "description": "Focused via keyboard navigation",
89
+ "usedIn": ["tokens", "component-options", "component-schemas"],
90
+
91
+ "definition": {
92
+ "superordinate": "interaction state",
93
+ "description": "The state when a component receives focus through keyboard navigation",
94
+ "essentialCharacteristics": [
95
+ "Specifically indicates focus achieved through keyboard interaction",
96
+ "Requires prominent visual indicator for accessibility",
97
+ "Different from generic focus to support :focus-visible patterns"
98
+ ]
99
+ },
100
+
101
+ "platforms": {
102
+ "web": {
103
+ "term": "keyboard-focus",
104
+ "notes": "Often implemented with :focus-visible pseudo-class",
105
+ "reference": "https://developer.mozilla.org/en-US/docs/Web/CSS/:focus-visible"
106
+ },
107
+ "iOS": {
108
+ "term": "focused",
109
+ "notes": "UIFocusSystem for keyboard and pointer navigation",
110
+ "reference": "UIFocusSystem"
111
+ }
112
+ },
113
+
114
+ "terminology": {
115
+ "conceptType": "term",
116
+ "namingRationale": "Distinguishes keyboard-based focus from programmatic focus",
117
+ "alternatives": ["tab-focus", "keyboard-navigated"]
118
+ },
119
+
120
+ "sources": [
121
+ {
122
+ "type": "industry-standard",
123
+ "reference": "WCAG 2.4.7 Focus Visible",
124
+ "url": "https://www.w3.org/WAI/WCAG21/Understanding/focus-visible.html",
125
+ "date": "2025-01-12"
126
+ }
127
+ ],
128
+
129
+ "governance": {
130
+ "owner": "Spectrum Core Team",
131
+ "reviewDate": "2025-01-12",
132
+ "status": "approved"
133
+ },
134
+
135
+ "relatedTerms": ["focus", "default", "hover"]
136
+ }
137
+ ```
138
+
139
+ ## Field Reference
140
+
141
+ ### Required Fields
142
+
143
+ | Field | Type | Description |
144
+ | ------- | ------ | ------------------------------ |
145
+ | `id` | string | Unique identifier (kebab-case) |
146
+ | `label` | string | Human-readable label |
147
+
148
+ ### Optional Fields
149
+
150
+ | Field | Type | Description |
151
+ | ------------------ | --------------------- | ---------------------------------------------------------- |
152
+ | `aliases` | array | Alternative names or spellings |
153
+ | `description` | string | Brief description |
154
+ | `default` | boolean | Whether this is the default value |
155
+ | `deprecated` | boolean | Whether this value is deprecated |
156
+ | `usedIn` | array | Where this value is used (tokens, component-schemas, etc.) |
157
+ | `category` | string | Category or grouping |
158
+ | `value` | string/number/boolean | Actual value (if different from id) |
159
+ | `documentationUrl` | string | URL to documentation |
160
+
161
+ ### Enhanced Fields (Glossary)
162
+
163
+ | Field | Type | Description |
164
+ | -------------- | ------ | ---------------------------------------------------------------------------- |
165
+ | `definition` | object | Structured definition (superordinate, description, essentialCharacteristics) |
166
+ | `platforms` | object | Platform-specific terminology and notes |
167
+ | `terminology` | object | Classification and naming rationale |
168
+ | `sources` | array | References to source documentation |
169
+ | `governance` | object | Ownership and review metadata |
170
+ | `relatedTerms` | array | IDs of related terms |
171
+
172
+ ## Concept Types
173
+
174
+ From the Spectrum Naming Guide:
175
+
176
+ * **word**: Fundamental building block with multiple possible meanings
177
+ * **term**: Word or phrase with precise meaning in a specific domain
178
+ * **name**: Identifier that distinguishes one thing from another (proper noun)
179
+ * **concept**: Abstract idea that words/terms/names represent
180
+
181
+ ## Source Types
182
+
183
+ * **wiki**: Internal Spectrum wiki pages
184
+ * **industry-standard**: W3C, WCAG, platform specifications
185
+ * **platform-standard**: Apple HIG, Material Design, etc.
186
+ * **internal-doc**: Internal Adobe documentation
187
+ * **research**: User research or design research
188
+
189
+ ## Governance Status
190
+
191
+ * **draft**: Work in progress, not yet reviewed
192
+ * **review**: Under review by stakeholders
193
+ * **approved**: Reviewed and approved for use
194
+ * **deprecated**: No longer recommended (use `replacedBy` field)
195
+
196
+ ## Workflow
197
+
198
+ ### Adding a New Term
199
+
200
+ 1. **Research**: Understand the concept thoroughly
201
+ 2. **Write Definition**: Follow the naming guide methodology
202
+ 3. **Check References**: Validate against industry standards and platform docs
203
+ 4. **Add Entry**: Create JSON entry with all required fields
204
+ 5. **Validate**: Run `pnpm validate` to check schema compliance
205
+ 6. **Test**: Run `pnpm test` to ensure no regressions
206
+ 7. **Create PR**: Submit for review with changeset
207
+
208
+ ### Updating an Existing Term
209
+
210
+ 1. **Load Term**: Find the term in the appropriate registry file
211
+ 2. **Update Fields**: Make necessary changes
212
+ 3. **Update Governance**: Update `reviewDate` and `owner` if needed
213
+ 4. **Validate**: Run validation and tests
214
+ 5. **Create PR**: Submit for review with changeset explaining changes
215
+
216
+ ### Deprecating a Term
217
+
218
+ 1. **Set Deprecated**: Add `"deprecated": true`
219
+ 2. **Add Replacement**: Set `governance.replacedBy` to new term ID
220
+ 3. **Update Status**: Set `governance.status` to `"deprecated"`
221
+ 4. **Document Reason**: Add note in PR description
222
+ 5. **Create Changeset**: Document the deprecation
223
+
224
+ ## Best Practices
225
+
226
+ ### Naming
227
+
228
+ * Use kebab-case for IDs
229
+ * Be descriptive but concise
230
+ * Follow industry standards when they exist
231
+ * Avoid metaphorical or fanciful names
232
+ * Name for the action, not the appearance
233
+
234
+ ### Definitions
235
+
236
+ * Start with the superordinate to set context
237
+ * Explain what it is AND how it differs from similar concepts
238
+ * Use essential characteristics to highlight unique features
239
+ * Write for both humans and AI systems
240
+ * Avoid circular definitions
241
+
242
+ ### Platform Variations
243
+
244
+ * Document when platforms use different terminology
245
+ * Include platform-specific implementation notes
246
+ * Link to official platform documentation
247
+ * Help designers understand cross-platform differences
248
+
249
+ ### Cross-References
250
+
251
+ * Link to related terms with `relatedTerms` array
252
+ * Use term IDs, not labels
253
+ * Bi-directional relationships are ideal but not required
254
+ * Help users discover related concepts
255
+
256
+ ## Validation
257
+
258
+ Run validation before submitting:
259
+
260
+ ```bash
261
+ # Validate all registry files
262
+ pnpm validate
263
+
264
+ # Run test suite
265
+ pnpm test
266
+ ```
267
+
268
+ The validation script checks:
269
+
270
+ * JSON schema compliance
271
+ * No duplicate IDs
272
+ * No duplicate aliases
273
+ * Only one default value per registry
274
+ * Valid relatedTerms references
275
+ * Valid governance.replacedBy references
276
+
277
+ ## Questions?
278
+
279
+ For questions or feedback:
280
+
281
+ * Slack: #spectrum\_dna
282
+ * Content Strategists: Jess Sattell, Kari Brookmyer
283
+ * GitHub: [Spectrum Design Data Discussions](https://github.com/adobe/spectrum-design-data/discussions)
284
+
285
+ ## Related Resources
286
+
287
+ * [Spectrum Naming and Definition Writing Guide](https://wiki.corp.adobe.com/display/AdobeDesign/Spectrum+Design+System%3A+Naming+and+definition+writing+guide)
288
+ * [Spectrum Tokens Wiki](https://wiki.corp.adobe.com/display/AdobeDesign/Spectrum+tokens)
289
+ * [Design System Registry Package README](README.md)
290
+ * [RFC: Spectrum Design System Glossary](https://github.com/adobe/spectrum-design-data/discussions/661)
package/CHANGELOG.md ADDED
@@ -0,0 +1,23 @@
1
+ # @adobe/design-system-registry
2
+
3
+ ## 0.0.0-layout-20260209174611
4
+
5
+ ### Patch Changes
6
+
7
+ - Added layout tokens and updated token terminology
8
+
9
+ ## 1.1.0
10
+
11
+ ### Minor Changes
12
+
13
+ - [#660](https://github.com/adobe/spectrum-design-data/pull/660) [`4051014`](https://github.com/adobe/spectrum-design-data/commit/4051014951c5c68c01b69be5ee156b4fc8fe98ed) Thanks [@GarthDB](https://github.com/GarthDB)! - Add Design System Registry package providing a single source of truth for
14
+ terminology used across Spectrum tokens, component schemas, and anatomy.
15
+ Includes registries for sizes, states, variants, anatomy terms, components,
16
+ scale values, categories, and platforms with JSON schema validation and
17
+ comprehensive tests.
18
+
19
+ ## 1.0.0
20
+
21
+ ### Minor Changes
22
+
23
+ - Initial release of Design System Registry package
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "{}"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved.
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.