@synergy-design-system/metadata 3.16.1 → 3.18.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 +26 -0
- package/data/core/component/component:syn-button-group.json +0 -5
- package/data/core/component/component:syn-button.json +3 -3
- package/data/core/component/component:syn-chart.json +147 -2
- package/data/core/component/component:syn-radio-button.json +123 -14
- package/data/core/component/component:syn-radio-group.json +11 -0
- package/data/core/setup/setup:angular-components-module.json +1 -1
- package/data/core/setup/setup:angular-forms-module.json +1 -1
- package/data/core/setup/setup:angular-package.json +2 -2
- package/data/core/setup/setup:angular-validators-module.json +1 -1
- package/data/core/setup/setup:components-package.json +2 -2
- package/data/core/setup/setup:react-package.json +2 -2
- package/data/core/setup/setup:tokens-package.json +2 -2
- package/data/core/setup/setup:vue-package.json +2 -2
- package/data/core/token/token:tokens-charts-js-index-d-ts.json +1 -1
- package/data/core/token/token:tokens-charts-js-index-js.json +1 -1
- package/data/core/token/token:tokens-charts-scss-tokens-scss.json +1 -1
- package/data/core/token/token:tokens-charts-themes-sick2025-dark-css.json +1 -1
- package/data/core/token/token:tokens-charts-themes-sick2025-light-css.json +1 -1
- package/data/core/token/token:tokens-figma-variables-sick2018-dark-json.json +1 -1
- package/data/core/token/token:tokens-figma-variables-sick2018-light-json.json +1 -1
- package/data/core/token/token:tokens-figma-variables-sick2025-dark-json.json +1 -1
- package/data/core/token/token:tokens-figma-variables-sick2025-light-json.json +1 -1
- package/data/core/token/token:tokens-js-index-d-ts.json +1 -1
- package/data/core/token/token:tokens-js-index-js.json +1 -1
- package/data/core/token/token:tokens-scss-tokens-scss.json +1 -1
- package/data/core/token/token:tokens-themes-sick2018-dark-css.json +1 -1
- package/data/core/token/token:tokens-themes-sick2018-light-css.json +1 -1
- package/data/core/token/token:tokens-themes-sick2025-dark-css.json +1 -1
- package/data/core/token/token:tokens-themes-sick2025-light-css.json +1 -1
- package/data/index.json +3 -2
- package/data/layers/examples/component/component:syn-chart.md +115 -106
- package/data/layers/examples/component/component:syn-checkbox.md +16 -2
- package/data/layers/examples/component/component:syn-combobox.md +10 -21
- package/data/layers/examples/component/component:syn-file.md +16 -10
- package/data/layers/examples/component/component:syn-input.md +10 -3
- package/data/layers/examples/component/component:syn-radio-button.md +200 -0
- package/data/layers/examples/component/component:syn-radio-group.md +27 -2
- package/data/layers/examples/component/component:syn-radio.md +12 -5
- package/data/layers/examples/component/component:syn-range.md +16 -14
- package/data/layers/examples/component/component:syn-select.md +10 -3
- package/data/layers/examples/component/component:syn-switch.md +10 -3
- package/data/layers/examples/component/component:syn-textarea.md +10 -3
- package/data/layers/full/component/component:syn-button/components/button-group.styles.ts +66 -0
- package/data/layers/full/component/component:syn-button/components/button.component.ts +40 -52
- package/data/layers/full/component/component:syn-button/components/button.styles.ts +162 -173
- package/data/layers/full/component/component:syn-button-group/components/button-group.component.ts +22 -18
- package/data/layers/full/component/component:syn-button-group/components/button-group.styles.ts +0 -2
- package/data/layers/full/component/component:syn-chart/angular/chart.component.ts +11 -5
- package/data/layers/full/component/component:syn-chart/components/chart.component.ts +67 -20
- package/data/layers/full/component/component:syn-chart/components/chart.palettes.ts +59 -59
- package/data/layers/full/component/component:syn-chart/components/types.ts +47 -4
- package/data/layers/full/component/component:syn-chart/react/chart.ts +1 -1
- package/data/layers/full/component/component:syn-chart/vue/SynVueChart.vue +11 -5
- package/data/layers/full/component/component:syn-radio-button/angular/radio-button.component.ts +14 -14
- package/data/layers/full/component/component:syn-radio-button/components/radio-button.component.ts +45 -25
- package/data/layers/full/component/component:syn-radio-button/components/radio-button.styles.ts +87 -25
- package/data/layers/full/component/component:syn-radio-button/react/radio-button.ts +1 -1
- package/data/layers/full/component/component:syn-radio-button/vue/SynVueRadioButton.vue +6 -6
- package/data/layers/full/component/component:syn-radio-group/components/radio-group.component.ts +23 -11
- package/data/layers/full/component/component:syn-radio-group/components/radio-group.styles.ts +51 -6
- package/data/layers/full/setup/setup:angular-package/angular/CHANGELOG.md +38 -0
- package/data/layers/full/setup/setup:angular-package/angular/package.json +1 -1
- package/data/layers/full/setup/setup:components-package/components/CHANGELOG.md +36 -0
- package/data/layers/full/setup/setup:components-package/components/package.json +1 -1
- package/data/layers/full/setup/setup:react-package/react/CHANGELOG.md +28 -0
- package/data/layers/full/setup/setup:react-package/react/package.json +1 -1
- package/data/layers/full/setup/setup:react-package/react/syn-jsx-elements.ts +4 -4
- package/data/layers/full/setup/setup:tokens-package/tokens/CHANGELOG.md +31 -0
- package/data/layers/full/setup/setup:tokens-package/tokens/package.json +1 -1
- package/data/layers/full/setup/setup:vue-package/vue/CHANGELOG.md +38 -0
- package/data/layers/full/setup/setup:vue-package/vue/package.json +1 -1
- package/data/layers/full/tokens/charts/js/index.d.ts +275 -265
- package/data/layers/full/tokens/charts/js/index.js +143 -133
- package/data/layers/full/tokens/charts/scss/_tokens.scss +135 -133
- package/data/layers/full/tokens/charts/themes/sick2025_dark.css +135 -133
- package/data/layers/full/tokens/charts/themes/sick2025_light.css +135 -133
- package/data/layers/full/tokens/figma-variables/sick2018-dark.json +20 -0
- package/data/layers/full/tokens/figma-variables/sick2018-light.json +20 -0
- package/data/layers/full/tokens/figma-variables/sick2025-dark.json +20 -0
- package/data/layers/full/tokens/figma-variables/sick2025-light.json +20 -0
- package/data/layers/full/tokens/js/index.d.ts +31 -1
- package/data/layers/full/tokens/js/index.js +31 -1
- package/data/layers/full/tokens/scss/_tokens.scss +7 -1
- package/data/layers/full/tokens/themes/sick2018_dark.css +7 -1
- package/data/layers/full/tokens/themes/sick2018_light.css +7 -1
- package/data/layers/full/tokens/themes/sick2025_dark.css +7 -1
- package/data/layers/full/tokens/themes/sick2025_light.css +7 -1
- package/data/layers/interface/component/component:syn-chart.json +5 -5
- package/data/layers/interface/component/component:syn-chart.md +4 -4
- package/data/layers/interface/component/component:syn-radio-button.json +14 -12
- package/data/layers/interface/component/component:syn-radio-button.md +6 -4
- package/data/layers/rules/component/component:syn-radio-button.md +16 -11
- package/data/manifest.json +1 -1
- package/dist/intentPolicy/domains/input/capabilities.js +4 -0
- package/dist/intentPolicy/domains/input/patterns.js +9 -0
- package/package.json +5 -5
- package/data/layers/full/component/component:syn-button/components/button.custom.styles.ts +0 -245
- package/data/layers/full/component/component:syn-button-group/components/button-group.custom.styles.ts +0 -5
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,31 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 3.18.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- [#1231](https://github.com/synergy-design-system/synergy-design-system/pull/1231) [`8a6cbf7`](https://github.com/synergy-design-system/synergy-design-system/commit/8a6cbf78fe5236b691815edfad12b34659937df9) Thanks [@schilchSICKAG](https://github.com/schilchSICKAG)! - Released on: 2026-06-30
|
|
8
|
+
|
|
9
|
+
feat: ✨ `<syn-radio-button>` ([#1140](https://github.com/synergy-design-system/synergy-design-system/issues/1140))
|
|
10
|
+
|
|
11
|
+
This release adds the new `<syn-radio-button>` component for single-selection controls with a more prominent, button-like appearance.
|
|
12
|
+
|
|
13
|
+
Use `<syn-radio>` for classic form input patterns, and `<syn-radio-button>` when the same behavior should feel more like an immediate mode, view, or option switch.
|
|
14
|
+
|
|
15
|
+
## 3.17.0
|
|
16
|
+
|
|
17
|
+
### Minor Changes
|
|
18
|
+
|
|
19
|
+
- [#1291](https://github.com/synergy-design-system/synergy-design-system/pull/1291) [`363595e`](https://github.com/synergy-design-system/synergy-design-system/commit/363595ea1fde8baad6e11d69365732aa9f547c10) Thanks [@kirchsuSICKAG](https://github.com/kirchsuSICKAG)! - Released on: 2026-06-24
|
|
20
|
+
|
|
21
|
+
feat: ✨ chart axes mvp ([#1203](https://github.com/synergy-design-system/synergy-design-system/issues/1203))
|
|
22
|
+
|
|
23
|
+
This release introduces the first chart axis MVP for syn-chart.
|
|
24
|
+
|
|
25
|
+
New features:
|
|
26
|
+
- Adds and registers a Synergy ECharts light theme as default for syn-chart.
|
|
27
|
+
- Provides a config callback API with preset methods like `axesShowSplitLines()`, `axesAddXLabelIcons()`, and `axesHideLabels()` as an alternative to raw ECharts configuration objects for the _config_ property. These methods support both method chaining and sequential calling patterns for maximum flexibility.
|
|
28
|
+
|
|
3
29
|
## 3.16.1
|
|
4
30
|
|
|
5
31
|
### Patch Changes
|
|
@@ -206,10 +206,6 @@
|
|
|
206
206
|
"layer": "full",
|
|
207
207
|
"path": "layers/full/component/component:syn-button-group/components/button-group.component.ts"
|
|
208
208
|
},
|
|
209
|
-
{
|
|
210
|
-
"layer": "full",
|
|
211
|
-
"path": "layers/full/component/component:syn-button-group/components/button-group.custom.styles.ts"
|
|
212
|
-
},
|
|
213
209
|
{
|
|
214
210
|
"layer": "full",
|
|
215
211
|
"path": "layers/full/component/component:syn-button-group/components/button-group.styles.ts"
|
|
@@ -255,7 +251,6 @@
|
|
|
255
251
|
"sources": [
|
|
256
252
|
"packages/angular/components/button-group/button-group.component.ts",
|
|
257
253
|
"packages/components/src/components/button-group/button-group.component.ts",
|
|
258
|
-
"packages/components/src/components/button-group/button-group.custom.styles.ts",
|
|
259
254
|
"packages/components/src/components/button-group/button-group.styles.ts",
|
|
260
255
|
"packages/components/src/components/button-group/button-group.ts",
|
|
261
256
|
"packages/react/src/components/button-group.ts",
|
|
@@ -268,11 +268,11 @@
|
|
|
268
268
|
},
|
|
269
269
|
{
|
|
270
270
|
"layer": "full",
|
|
271
|
-
"path": "layers/full/component/component:syn-button/components/button.
|
|
271
|
+
"path": "layers/full/component/component:syn-button/components/button-group.styles.ts"
|
|
272
272
|
},
|
|
273
273
|
{
|
|
274
274
|
"layer": "full",
|
|
275
|
-
"path": "layers/full/component/component:syn-button/components/button.
|
|
275
|
+
"path": "layers/full/component/component:syn-button/components/button.component.ts"
|
|
276
276
|
},
|
|
277
277
|
{
|
|
278
278
|
"layer": "full",
|
|
@@ -327,8 +327,8 @@
|
|
|
327
327
|
"since": "1.0.0",
|
|
328
328
|
"sources": [
|
|
329
329
|
"packages/angular/components/button/button.component.ts",
|
|
330
|
+
"packages/components/src/components/button/button-group.styles.ts",
|
|
330
331
|
"packages/components/src/components/button/button.component.ts",
|
|
331
|
-
"packages/components/src/components/button/button.custom.styles.ts",
|
|
332
332
|
"packages/components/src/components/button/button.styles.ts",
|
|
333
333
|
"packages/components/src/components/button/button.ts",
|
|
334
334
|
"packages/react/src/components/button.ts",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"documentation": "https://synergy-design-system.github.io/?path=/docs/charting-syn-chart--docs",
|
|
18
18
|
"events": [],
|
|
19
19
|
"packageName": "@synergy-design-system/react",
|
|
20
|
-
"since": "
|
|
20
|
+
"since": "3.15.0",
|
|
21
21
|
"sourcePath": "packages/react/src/types/syn-jsx-elements.ts",
|
|
22
22
|
"status": "experimental",
|
|
23
23
|
"subpathExport": "./types/latest",
|
|
@@ -39,6 +39,151 @@
|
|
|
39
39
|
},
|
|
40
40
|
"override": {
|
|
41
41
|
"figmaDocsId": "https://www.figma.com/design/9IpXnDH4GFziUH9sOpnK8V/Chart-Library?node-id=0-1&p=f&t=PkQKC2p7WIr2k0og-0",
|
|
42
|
+
"stories": [
|
|
43
|
+
{
|
|
44
|
+
"description": {
|
|
45
|
+
"type": "text",
|
|
46
|
+
"value": "The chart’s axes define the visual structure of the data and can be customized to match different visualization needs. Both the horizontal and vertical axes support flexible configuration options, allowing you to control how reference lines and labels are displayed.\n\nYou can choose to show only horizontal grid lines, only vertical grid lines, or both, depending on the level of visual guidance you want to provide. "
|
|
47
|
+
},
|
|
48
|
+
"name": "axes-default",
|
|
49
|
+
"title": {
|
|
50
|
+
"type": "text",
|
|
51
|
+
"value": "Axes"
|
|
52
|
+
}
|
|
53
|
+
},
|
|
54
|
+
{
|
|
55
|
+
"description": {
|
|
56
|
+
"type": "text",
|
|
57
|
+
"value": "The default is, that both axes lines as well as the split lines are hidden."
|
|
58
|
+
},
|
|
59
|
+
"name": "axes-split-lines-hidden",
|
|
60
|
+
"title": {
|
|
61
|
+
"type": "text",
|
|
62
|
+
"value": "Hidden Axes Split Lines"
|
|
63
|
+
}
|
|
64
|
+
},
|
|
65
|
+
{
|
|
66
|
+
"description": {
|
|
67
|
+
"type": "text",
|
|
68
|
+
"value": "If you want to display both axes lines and split lines, use the handle method `axesShowSplitLines()`."
|
|
69
|
+
},
|
|
70
|
+
"name": "axes-split-lines-visible",
|
|
71
|
+
"title": {
|
|
72
|
+
"type": "text",
|
|
73
|
+
"value": "Visible Axes Split Lines"
|
|
74
|
+
}
|
|
75
|
+
},
|
|
76
|
+
{
|
|
77
|
+
"description": {
|
|
78
|
+
"type": "text",
|
|
79
|
+
"value": "To show only horizontal split lines, use the handle method `axesShowYSplitLines()`."
|
|
80
|
+
},
|
|
81
|
+
"name": "axes-horizontal-split-lines",
|
|
82
|
+
"title": {
|
|
83
|
+
"type": "text",
|
|
84
|
+
"value": "Horizontal Split Lines Only"
|
|
85
|
+
}
|
|
86
|
+
},
|
|
87
|
+
{
|
|
88
|
+
"description": {
|
|
89
|
+
"type": "text",
|
|
90
|
+
"value": "To show only vertical split lines, use the handle method `axesShowXSplitLines()`."
|
|
91
|
+
},
|
|
92
|
+
"name": "axes-vertical-split-lines",
|
|
93
|
+
"title": {
|
|
94
|
+
"type": "text",
|
|
95
|
+
"value": "Vertical Split Lines Only"
|
|
96
|
+
}
|
|
97
|
+
},
|
|
98
|
+
{
|
|
99
|
+
"description": {
|
|
100
|
+
"type": "text",
|
|
101
|
+
"value": "If you want to hide the axis labels, use the handle method `axesHideLabels()`."
|
|
102
|
+
},
|
|
103
|
+
"name": "axes-labels-hidden",
|
|
104
|
+
"title": {
|
|
105
|
+
"type": "text",
|
|
106
|
+
"value": "Hidden Axis Labels"
|
|
107
|
+
}
|
|
108
|
+
},
|
|
109
|
+
{
|
|
110
|
+
"description": {
|
|
111
|
+
"type": "text",
|
|
112
|
+
"value": "To show axes split lines but hide axis labels, combine `axesShowSplitLines()` and `axesHideLabels()`."
|
|
113
|
+
},
|
|
114
|
+
"name": "axes-lines-visible-labels-hidden",
|
|
115
|
+
"title": {
|
|
116
|
+
"type": "text",
|
|
117
|
+
"value": "Visible Axes Lines with Hidden Values"
|
|
118
|
+
}
|
|
119
|
+
},
|
|
120
|
+
{
|
|
121
|
+
"description": {
|
|
122
|
+
"type": "text",
|
|
123
|
+
"value": "To add icons to axis labels, use the handle methods `axesAddXLabelIcons()` and `axesAddYLabelIcons()`."
|
|
124
|
+
},
|
|
125
|
+
"name": "axes-labels-with-icons",
|
|
126
|
+
"title": {
|
|
127
|
+
"type": "text",
|
|
128
|
+
"value": "Axes Labels with Icons"
|
|
129
|
+
}
|
|
130
|
+
},
|
|
131
|
+
{
|
|
132
|
+
"description": {
|
|
133
|
+
"type": "text",
|
|
134
|
+
"value": "The default story demonstrates a basic line chart configuration. The chart is configured via the `config` property, which accepts an object that maps directly to the ECharts option configuration."
|
|
135
|
+
},
|
|
136
|
+
"name": "default",
|
|
137
|
+
"title": {
|
|
138
|
+
"type": "text",
|
|
139
|
+
"value": "Chart"
|
|
140
|
+
}
|
|
141
|
+
},
|
|
142
|
+
{
|
|
143
|
+
"description": {
|
|
144
|
+
"type": "text",
|
|
145
|
+
"value": "The `config` property is the main way to configure the chart. It accepts an object that maps 1:1 to the ECharts option configuration. Assigning a new object to this property will update the chart with the new configuration."
|
|
146
|
+
},
|
|
147
|
+
"name": "config",
|
|
148
|
+
"title": {
|
|
149
|
+
"type": "text",
|
|
150
|
+
"value": "Config"
|
|
151
|
+
}
|
|
152
|
+
},
|
|
153
|
+
{
|
|
154
|
+
"description": {
|
|
155
|
+
"type": "text",
|
|
156
|
+
"value": "Use the `palette` attribute to apply a Synergy design token color palette to chart series. `categorical` (12 distinct colors for comparing unrelated data series), `sequential-01`–`sequential-07` (10-step single-hue ramps), and `sequential-status-critical/error/info/success/warning` (10-step status ramps). If `option.color` is explicitly set, it takes precedence over the `palette` attribute."
|
|
157
|
+
},
|
|
158
|
+
"name": "palette",
|
|
159
|
+
"title": {
|
|
160
|
+
"type": "text",
|
|
161
|
+
"value": "Palette"
|
|
162
|
+
}
|
|
163
|
+
},
|
|
164
|
+
{
|
|
165
|
+
"description": {
|
|
166
|
+
"type": "text",
|
|
167
|
+
"value": "Use `getInstance()` to access the underlying ECharts instance directly and work with its full native API. This is useful when the `config` property alone is not sufficient — for example to listen to ECharts events, trigger actions, or call `setOption()` with custom merge behavior. This example attaches a click listener via the native ECharts API. Click any data point to see the event payload logged to the browser console."
|
|
168
|
+
},
|
|
169
|
+
"name": "get-instance",
|
|
170
|
+
"title": {
|
|
171
|
+
"type": "text",
|
|
172
|
+
"value": "Get Instance"
|
|
173
|
+
}
|
|
174
|
+
},
|
|
175
|
+
{
|
|
176
|
+
"description": {
|
|
177
|
+
"type": "text",
|
|
178
|
+
"value": "You can use multiple charts in one `<syn-chart>` instance, each with its own configuration. The palette colors or the default colors can be overridden per series item using the `color` property directly on the series object — allowing fine-grained control over individual chart series colors.\n\n**Important:** The `color` property does **not** support CSS variables (e.g. `var(--syn-sequential-05-80)`). This is a limitation of ECharts itself: ECharts renders via the Canvas API, which does not resolve CSS custom properties. To use Synergy design tokens as colors, read the computed hex value first using `getComputedStyle(document.documentElement).getPropertyValue('--your-token').trim()` and pass the resolved value instead."
|
|
179
|
+
},
|
|
180
|
+
"name": "multiple-charts",
|
|
181
|
+
"title": {
|
|
182
|
+
"type": "text",
|
|
183
|
+
"value": "Multiple Charts"
|
|
184
|
+
}
|
|
185
|
+
}
|
|
186
|
+
],
|
|
42
187
|
"storySourcePath": "components.chart",
|
|
43
188
|
"storyTags": [
|
|
44
189
|
"Data Visualization"
|
|
@@ -158,7 +303,7 @@
|
|
|
158
303
|
"name": "syn-chart",
|
|
159
304
|
"package": "components",
|
|
160
305
|
"relations": [],
|
|
161
|
-
"since": "
|
|
306
|
+
"since": "3.15.0",
|
|
162
307
|
"sources": [
|
|
163
308
|
"packages/angular/components/chart/chart.component.ts",
|
|
164
309
|
"packages/components/src/components/chart/chart.component.ts",
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
}
|
|
24
24
|
],
|
|
25
25
|
"packageName": "@synergy-design-system/react",
|
|
26
|
-
"since": "
|
|
26
|
+
"since": "3.17.0",
|
|
27
27
|
"sourcePath": "packages/react/src/types/syn-jsx-elements.ts",
|
|
28
28
|
"status": "stable",
|
|
29
29
|
"subpathExport": "./types/latest",
|
|
@@ -43,10 +43,109 @@
|
|
|
43
43
|
"sourcePath": "packages/vue/src/components/SynVueRadioButton.vue"
|
|
44
44
|
}
|
|
45
45
|
},
|
|
46
|
+
"override": {
|
|
47
|
+
"figmaComponentId": "47863-30109",
|
|
48
|
+
"figmaDocsId": "49697-83768",
|
|
49
|
+
"stories": [
|
|
50
|
+
{
|
|
51
|
+
"description": {
|
|
52
|
+
"type": "text",
|
|
53
|
+
"value": "Radio buttons allow the user to select a single option from a group using a button-like control.\n\nRadio buttons are designed to be used with radio groups. When a radio button has focus, the arrow keys can be used to change the selected option just like standard radio controls."
|
|
54
|
+
},
|
|
55
|
+
"name": "default",
|
|
56
|
+
"title": {
|
|
57
|
+
"type": "text",
|
|
58
|
+
"value": "Radio Button"
|
|
59
|
+
}
|
|
60
|
+
},
|
|
61
|
+
{
|
|
62
|
+
"description": {
|
|
63
|
+
"type": "text",
|
|
64
|
+
"value": "To set the initial value and checked state, use the value attribute on the containing radio group."
|
|
65
|
+
},
|
|
66
|
+
"name": "checked",
|
|
67
|
+
"title": {
|
|
68
|
+
"type": "text",
|
|
69
|
+
"value": "Checked"
|
|
70
|
+
}
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
"description": {
|
|
74
|
+
"type": "text",
|
|
75
|
+
"value": "Use the disabled attribute to disable a radio button."
|
|
76
|
+
},
|
|
77
|
+
"name": "disabled",
|
|
78
|
+
"title": {
|
|
79
|
+
"type": "text",
|
|
80
|
+
"value": "Disabled"
|
|
81
|
+
}
|
|
82
|
+
},
|
|
83
|
+
{
|
|
84
|
+
"description": {
|
|
85
|
+
"type": "text",
|
|
86
|
+
"value": "Add the read-only attribute to render a readonly radio button. Please note that you need to enable the readonly state for each individual radio button."
|
|
87
|
+
},
|
|
88
|
+
"name": "readonly",
|
|
89
|
+
"title": {
|
|
90
|
+
"type": "text",
|
|
91
|
+
"value": "Readonly"
|
|
92
|
+
}
|
|
93
|
+
},
|
|
94
|
+
{
|
|
95
|
+
"description": {
|
|
96
|
+
"type": "text",
|
|
97
|
+
"value": "The invalid status is used to warn the user that the Radio Group is invalid. For example, if the radio-button is mandatory and nothing has been checked."
|
|
98
|
+
},
|
|
99
|
+
"name": "invalid",
|
|
100
|
+
"title": {
|
|
101
|
+
"type": "text",
|
|
102
|
+
"value": "Invalid"
|
|
103
|
+
}
|
|
104
|
+
},
|
|
105
|
+
{
|
|
106
|
+
"description": {
|
|
107
|
+
"type": "text",
|
|
108
|
+
"value": "Use the size attribute to change a radio button’s size."
|
|
109
|
+
},
|
|
110
|
+
"name": "sizes",
|
|
111
|
+
"title": {
|
|
112
|
+
"type": "text",
|
|
113
|
+
"value": "Sizes"
|
|
114
|
+
}
|
|
115
|
+
},
|
|
116
|
+
{
|
|
117
|
+
"description": {
|
|
118
|
+
"type": "text",
|
|
119
|
+
"value": "Use the prefix and suffix slots to add icons."
|
|
120
|
+
},
|
|
121
|
+
"name": "prefix-suffix",
|
|
122
|
+
"title": {
|
|
123
|
+
"type": "text",
|
|
124
|
+
"value": "Prefix and Suffix Icons"
|
|
125
|
+
}
|
|
126
|
+
},
|
|
127
|
+
{
|
|
128
|
+
"description": {
|
|
129
|
+
"type": "text",
|
|
130
|
+
"value": "You can omit button labels and use icons instead. Make sure to set a label attribute on each icon so screen readers will announce each option correctly."
|
|
131
|
+
},
|
|
132
|
+
"name": "buttons-with-icons",
|
|
133
|
+
"title": {
|
|
134
|
+
"type": "text",
|
|
135
|
+
"value": "Buttons with Icons"
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
],
|
|
139
|
+
"storySourcePath": "components.radio-button",
|
|
140
|
+
"storyTags": [
|
|
141
|
+
"Form"
|
|
142
|
+
]
|
|
143
|
+
},
|
|
46
144
|
"rules": {
|
|
47
145
|
"accessibility": [
|
|
48
|
-
"Provide meaningful alternative text for icon-only radio buttons.",
|
|
49
|
-
"Communicate the group's function
|
|
146
|
+
"Provide meaningful alternative text for icon-only radio buttons using the label attribute.",
|
|
147
|
+
"Communicate the group's function—such as filtering or view switching—through clear context or labels.",
|
|
148
|
+
"Ensure each button option has a unique, non-ambiguous label to help assistive technology users understand their choices."
|
|
50
149
|
],
|
|
51
150
|
"component": "syn-radio-button",
|
|
52
151
|
"related": {
|
|
@@ -61,17 +160,19 @@
|
|
|
61
160
|
"usageGuidelines": [
|
|
62
161
|
{
|
|
63
162
|
"content": [
|
|
64
|
-
"Use
|
|
163
|
+
"Use syn-radio-button when you need button-style appearance for single option selection.",
|
|
164
|
+
"Use syn-radio for traditional radio button appearance.",
|
|
165
|
+
"Both work as form inputs when slotted inside syn-radio-group; the difference is visual presentation.",
|
|
166
|
+
"Choose syn-radio-button for use cases like filtering, view switching, or category selection where button styling enhances UX.",
|
|
167
|
+
"Slot inside syn-radio-group to participate in form submission and group state management.",
|
|
168
|
+
"Use only in groups, as they are designed to allow the user to activate one of several options. For single options, use syn-checkbox instead."
|
|
65
169
|
],
|
|
66
|
-
"id": "
|
|
67
|
-
"name": "
|
|
170
|
+
"id": "when_to_use",
|
|
171
|
+
"name": "When to Use"
|
|
68
172
|
},
|
|
69
173
|
{
|
|
70
174
|
"content": [
|
|
71
|
-
"
|
|
72
|
-
"Slot inside of an syn-radio-group.",
|
|
73
|
-
"Use only in groups, as they are designed to allow the user to activate one of several options. To work with a single option, use syn-checkbox instead.",
|
|
74
|
-
"Pre-select always a \"default\" value; there is no invalid state.",
|
|
175
|
+
"Always pre-select a \"default\" value. There is no invalid state; one option must always be selected.",
|
|
75
176
|
"Limit the number of options in the group. Users should be able to retain all options available and not be overwhelmed by them."
|
|
76
177
|
],
|
|
77
178
|
"id": "behavior",
|
|
@@ -95,9 +196,11 @@
|
|
|
95
196
|
}
|
|
96
197
|
],
|
|
97
198
|
"useCases": [
|
|
98
|
-
"
|
|
99
|
-
"
|
|
100
|
-
"
|
|
199
|
+
"Filter or switch between views with button-style appearance and icon support.",
|
|
200
|
+
"Select one option from a group where one is already preselected and no invalid state exists.",
|
|
201
|
+
"Switch between groups of settings with visual button presentation.",
|
|
202
|
+
"Display categorization choices with prominent, icon-enhanced options.",
|
|
203
|
+
"Preference or mode selection in UI controls where traditional form input is not needed."
|
|
101
204
|
]
|
|
102
205
|
},
|
|
103
206
|
"sourceModulePath": "components/radio-button/radio-button.js",
|
|
@@ -106,6 +209,12 @@
|
|
|
106
209
|
"id": "component:syn-radio-button",
|
|
107
210
|
"kind": "component",
|
|
108
211
|
"layers": {
|
|
212
|
+
"examples": [
|
|
213
|
+
{
|
|
214
|
+
"layer": "examples",
|
|
215
|
+
"path": "layers/examples/component/component:syn-radio-button.md"
|
|
216
|
+
}
|
|
217
|
+
],
|
|
109
218
|
"full": [
|
|
110
219
|
{
|
|
111
220
|
"layer": "full",
|
|
@@ -156,7 +265,7 @@
|
|
|
156
265
|
"name": "syn-radio-button",
|
|
157
266
|
"package": "components",
|
|
158
267
|
"relations": [],
|
|
159
|
-
"since": "
|
|
268
|
+
"since": "3.17.0",
|
|
160
269
|
"sources": [
|
|
161
270
|
"packages/angular/components/radio-button/radio-button.component.ts",
|
|
162
271
|
"packages/components/src/components/radio-button/radio-button.component.ts",
|
|
@@ -173,6 +173,17 @@
|
|
|
173
173
|
"type": "text",
|
|
174
174
|
"value": "Checked"
|
|
175
175
|
}
|
|
176
|
+
},
|
|
177
|
+
{
|
|
178
|
+
"description": {
|
|
179
|
+
"type": "text",
|
|
180
|
+
"value": "Radio buttons offer an alternate way to display radio controls. In this case, an internal button group is used to group the buttons into a single, cohesive control."
|
|
181
|
+
},
|
|
182
|
+
"name": "radio-buttons",
|
|
183
|
+
"title": {
|
|
184
|
+
"type": "text",
|
|
185
|
+
"value": "Radio Buttons"
|
|
186
|
+
}
|
|
176
187
|
}
|
|
177
188
|
],
|
|
178
189
|
"storySourcePath": "components.radio-group",
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"custom": {
|
|
3
3
|
"framework": "angular",
|
|
4
4
|
"packageName": "@synergy-design-system/angular",
|
|
5
|
-
"packageVersion": "3.
|
|
5
|
+
"packageVersion": "3.17.0",
|
|
6
6
|
"subpathExports": [
|
|
7
7
|
".",
|
|
8
8
|
"./components/*",
|
|
@@ -39,7 +39,7 @@
|
|
|
39
39
|
"name": "Angular Framework Package",
|
|
40
40
|
"package": "angular",
|
|
41
41
|
"relations": [],
|
|
42
|
-
"since": "3.
|
|
42
|
+
"since": "3.17.0",
|
|
43
43
|
"sources": [
|
|
44
44
|
"packages/angular/README.md",
|
|
45
45
|
"packages/angular/CHANGELOG.md",
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"custom": {
|
|
3
3
|
"packageName": "@synergy-design-system/components",
|
|
4
|
-
"packageVersion": "3.
|
|
4
|
+
"packageVersion": "3.17.0"
|
|
5
5
|
},
|
|
6
6
|
"id": "setup:components-package",
|
|
7
7
|
"kind": "setup",
|
|
@@ -40,7 +40,7 @@
|
|
|
40
40
|
"name": "Components Package",
|
|
41
41
|
"package": "components",
|
|
42
42
|
"relations": [],
|
|
43
|
-
"since": "3.
|
|
43
|
+
"since": "3.17.0",
|
|
44
44
|
"sources": [
|
|
45
45
|
"packages/components/README.md",
|
|
46
46
|
"packages/components/CHANGELOG.md",
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"custom": {
|
|
3
3
|
"framework": "react",
|
|
4
4
|
"packageName": "@synergy-design-system/react",
|
|
5
|
-
"packageVersion": "3.
|
|
5
|
+
"packageVersion": "3.17.0",
|
|
6
6
|
"subpathExports": [
|
|
7
7
|
".",
|
|
8
8
|
"./components/*",
|
|
@@ -42,7 +42,7 @@
|
|
|
42
42
|
"name": "React Framework Package",
|
|
43
43
|
"package": "react",
|
|
44
44
|
"relations": [],
|
|
45
|
-
"since": "3.
|
|
45
|
+
"since": "3.17.0",
|
|
46
46
|
"sources": [
|
|
47
47
|
"packages/react/README.md",
|
|
48
48
|
"packages/react/CHANGELOG.md",
|
|
@@ -32,7 +32,7 @@
|
|
|
32
32
|
"./themes/*"
|
|
33
33
|
],
|
|
34
34
|
"packageName": "@synergy-design-system/tokens",
|
|
35
|
-
"packageVersion": "3.
|
|
35
|
+
"packageVersion": "3.17.0"
|
|
36
36
|
},
|
|
37
37
|
"id": "setup:tokens-package",
|
|
38
38
|
"kind": "setup",
|
|
@@ -59,7 +59,7 @@
|
|
|
59
59
|
"name": "Tokens Package",
|
|
60
60
|
"package": "tokens",
|
|
61
61
|
"relations": [],
|
|
62
|
-
"since": "3.
|
|
62
|
+
"since": "3.17.0",
|
|
63
63
|
"sources": [
|
|
64
64
|
"packages/tokens/BREAKING_CHANGES.md",
|
|
65
65
|
"packages/tokens/CHANGELOG.md",
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"custom": {
|
|
3
3
|
"framework": "vue",
|
|
4
4
|
"packageName": "@synergy-design-system/vue",
|
|
5
|
-
"packageVersion": "3.
|
|
5
|
+
"packageVersion": "3.17.0"
|
|
6
6
|
},
|
|
7
7
|
"id": "setup:vue-package",
|
|
8
8
|
"kind": "setup",
|
|
@@ -33,7 +33,7 @@
|
|
|
33
33
|
"name": "Vue Framework Package",
|
|
34
34
|
"package": "vue",
|
|
35
35
|
"relations": [],
|
|
36
|
-
"since": "3.
|
|
36
|
+
"since": "3.17.0",
|
|
37
37
|
"sources": [
|
|
38
38
|
"packages/vue/README.md",
|
|
39
39
|
"packages/vue/CHANGELOG.md",
|