@synergy-design-system/mcp 1.41.2 → 2.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 +26 -0
- package/README.md +43 -8
- package/dist/build/assets.js +1 -0
- package/dist/build/static.js +15 -7
- package/dist/build/styles.js +1 -0
- package/dist/build/tokens.js +1 -0
- package/dist/tools/asset-info.js +4 -4
- package/dist/tools/index.d.ts +1 -0
- package/dist/tools/index.js +1 -0
- package/dist/tools/migration-info.d.ts +10 -1
- package/dist/tools/migration-info.js +74 -12
- package/dist/tools/migration-list.d.ts +10 -0
- package/dist/tools/migration-list.js +122 -0
- package/dist/utilities/migration.d.ts +3 -1
- package/dist/utilities/migration.js +25 -2
- package/metadata/checksum.txt +1 -1
- package/metadata/packages/angular/README.md +1 -1
- package/metadata/packages/assets/BREAKING_CHANGES.md +305 -0
- package/metadata/packages/assets/CHANGELOG.md +18 -0
- package/metadata/packages/assets/README.md +39 -22
- package/metadata/packages/components/components/syn-alert/component.custom.styles.ts +20 -20
- package/metadata/packages/components/components/syn-badge/component.custom.styles.ts +10 -10
- package/metadata/packages/components/components/syn-breadcrumb-item/component.custom.styles.ts +1 -1
- package/metadata/packages/components/components/syn-button/component.custom.styles.ts +24 -24
- package/metadata/packages/components/components/syn-checkbox/component.custom.styles.ts +7 -7
- package/metadata/packages/components/components/syn-combobox/component.angular.ts +0 -17
- package/metadata/packages/components/components/syn-combobox/component.ts +0 -9
- package/metadata/packages/components/components/syn-combobox/component.vue +0 -9
- package/metadata/packages/components/components/syn-details/component.custom.styles.ts +1 -1
- package/metadata/packages/components/components/syn-dialog/component.custom.styles.ts +1 -1
- package/metadata/packages/components/components/syn-dropdown/component.angular.ts +0 -17
- package/metadata/packages/components/components/syn-dropdown/component.ts +0 -8
- package/metadata/packages/components/components/syn-dropdown/component.vue +0 -9
- package/metadata/packages/components/components/syn-file/component.styles.ts +6 -6
- package/metadata/packages/components/components/syn-header/component.styles.ts +7 -7
- package/metadata/packages/components/components/syn-icon-button/component.custom.styles.ts +8 -8
- package/metadata/packages/components/components/syn-input/component.custom.styles.ts +3 -3
- package/metadata/packages/components/components/syn-input/component.ts +2 -3
- package/metadata/packages/components/components/syn-menu-item/component.custom.styles.ts +11 -11
- package/metadata/packages/components/components/syn-nav-item/component.styles.ts +3 -3
- package/metadata/packages/components/components/syn-optgroup/component.styles.ts +1 -1
- package/metadata/packages/components/components/syn-option/component.custom.styles.ts +13 -13
- package/metadata/packages/components/components/syn-popup/component.angular.ts +0 -16
- package/metadata/packages/components/components/syn-popup/component.ts +3 -10
- package/metadata/packages/components/components/syn-popup/component.vue +0 -10
- package/metadata/packages/components/components/syn-progress-bar/component.custom.styles.ts +2 -2
- package/metadata/packages/components/components/syn-progress-ring/component.custom.styles.ts +2 -2
- package/metadata/packages/components/components/syn-radio/component.custom.styles.ts +7 -7
- package/metadata/packages/components/components/syn-range/component.styles.ts +9 -9
- package/metadata/packages/components/components/syn-range/component.ts +0 -1
- package/metadata/packages/components/components/syn-range-tick/component.styles.ts +1 -1
- package/metadata/packages/components/components/syn-select/component.angular.ts +0 -17
- package/metadata/packages/components/components/syn-select/component.ts +0 -8
- package/metadata/packages/components/components/syn-select/component.vue +0 -9
- package/metadata/packages/components/components/syn-side-nav/component.angular.ts +0 -21
- package/metadata/packages/components/components/syn-side-nav/component.ts +1 -36
- package/metadata/packages/components/components/syn-side-nav/component.vue +0 -13
- package/metadata/packages/components/components/syn-spinner/component.custom.styles.ts +2 -2
- package/metadata/packages/components/components/syn-switch/component.custom.styles.ts +16 -16
- package/metadata/packages/components/components/syn-tab/component.custom.styles.ts +3 -3
- package/metadata/packages/components/components/syn-tab-group/component.custom.styles.ts +2 -2
- package/metadata/packages/components/components/syn-tag/component.custom.styles.ts +1 -1
- package/metadata/packages/components/components/syn-tooltip/component.angular.ts +0 -18
- package/metadata/packages/components/components/syn-tooltip/component.ts +1 -10
- package/metadata/packages/components/components/syn-tooltip/component.vue +0 -10
- package/metadata/packages/components/migration/BREAKING_CHANGES.md +433 -14
- package/metadata/packages/components/static/CHANGELOG.md +44 -0
- package/metadata/packages/components/static/LIMITATIONS.md +141 -35
- package/metadata/packages/styles/BREAKING_CHANGES.md +105 -0
- package/metadata/packages/styles/CHANGELOG.md +26 -0
- package/metadata/packages/styles/index.css +9 -9
- package/metadata/packages/styles/link-list.css +1 -1
- package/metadata/packages/styles/link.css +2 -2
- package/metadata/packages/styles/tables.css +8 -8
- package/metadata/packages/styles/typography.css +1 -1
- package/metadata/packages/tokens/BREAKING_CHANGES.md +180 -0
- package/metadata/packages/tokens/CHANGELOG.md +18 -0
- package/metadata/packages/tokens/README.md +2 -0
- package/metadata/packages/tokens/dark.css +237 -236
- package/metadata/packages/tokens/index.js +6 -1
- package/metadata/packages/tokens/light.css +221 -220
- package/metadata/packages/tokens/sick2018_dark.css +4 -3
- package/metadata/packages/tokens/sick2018_light.css +4 -3
- package/metadata/packages/tokens/sick2025_dark.css +4 -3
- package/metadata/packages/tokens/sick2025_light.css +4 -3
- package/metadata/static/components/syn-badge/docs.md +2 -14
- package/metadata/static/components/syn-popup/docs.md +10 -29
- package/metadata/static/components/syn-range/docs.md +1 -1
- package/metadata/static/migration/index.md +51 -11
- package/metadata/{packages/components/migration/migration-synergy-v3.md → static/migration/v2-2018-to-v2-2025.md} +1 -1
- package/metadata/static/migration/v2-2018-to-v3-2018.md +147 -0
- package/metadata/static/migration/v2-2018-to-v3-2025.md +150 -0
- package/metadata/static/migration/v2-2025-to-v3-2025.md +133 -0
- package/metadata/static/templates/appshell.md +8 -8
- package/metadata/static/templates/footer.md +1 -1
- package/package.json +6 -6
|
@@ -5,13 +5,430 @@ As all our wrappers are based on this package, the changes also hold true for al
|
|
|
5
5
|
|
|
6
6
|
> ⚠️ Migrations **must** always be done from one major version to the next to prevent issues (e.g. with types and property changes)
|
|
7
7
|
> This means when moving from `@synergy-design-system@components` v1.x to v3.x,
|
|
8
|
-
> you will **have to apply** the changes
|
|
8
|
+
> you will **have to apply** the changes from v1.x to v2.x first!
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## Version 3.0
|
|
13
|
+
|
|
14
|
+
> ⚠️ **Important**: When upgrading to Synergy v3.0, update all `@synergy-design-system/*` packages to their respective v3.x versions (or v2.x for `@synergy-design-system/assets`) to ensure compatibility.
|
|
15
|
+
|
|
16
|
+
<h3 id="syn-combobox-v3">`<syn-combobox>`</h3>
|
|
17
|
+
|
|
18
|
+
#### ⚠️ Removed deprecated attribute `hoist`
|
|
19
|
+
|
|
20
|
+
**Associated Ticket(s)**:
|
|
21
|
+
|
|
22
|
+
- [#1149](https://github.com/synergy-design-system/synergy-design-system/issues/1149)
|
|
23
|
+
|
|
24
|
+
**Reason**:
|
|
25
|
+
|
|
26
|
+
The `hoist` attribute was marked as deprecated in Synergy version 2.
|
|
27
|
+
As all major browsers now support the use of the [popover API](https://developer.mozilla.org/docs/Web/API/Popover_API), manually setting this is no longer needed.
|
|
28
|
+
|
|
29
|
+
**Migration Steps**:
|
|
30
|
+
|
|
31
|
+
- Remove all occurrences of the `hoist` property in your code.
|
|
32
|
+
|
|
33
|
+
**Example (before)**:
|
|
34
|
+
|
|
35
|
+
```html
|
|
36
|
+
<syn-combobox hoist></syn-combobox>
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
**Example (after)**:
|
|
40
|
+
|
|
41
|
+
```html
|
|
42
|
+
<syn-combobox></syn-combobox>
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
<h3 id="syn-dropdown-v3">`<syn-dropdown>`</h3>
|
|
48
|
+
|
|
49
|
+
#### ⚠️ Removed deprecated attribute `hoist`
|
|
50
|
+
|
|
51
|
+
**Associated Ticket(s)**:
|
|
52
|
+
|
|
53
|
+
- [#1149](https://github.com/synergy-design-system/synergy-design-system/issues/1149)
|
|
54
|
+
|
|
55
|
+
**Reason**:
|
|
56
|
+
|
|
57
|
+
The `hoist` attribute was marked as deprecated in Synergy version 2.
|
|
58
|
+
As all major browsers now support the use of the [popover API](https://developer.mozilla.org/docs/Web/API/Popover_API), manually setting this is no longer needed.
|
|
59
|
+
|
|
60
|
+
**Migration Steps**:
|
|
61
|
+
|
|
62
|
+
- Remove all occurrences of the `hoist` property in your code.
|
|
63
|
+
|
|
64
|
+
**Example (before)**:
|
|
65
|
+
|
|
66
|
+
```html
|
|
67
|
+
<syn-dropdown hoist></syn-dropdown>
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
**Example (after)**:
|
|
71
|
+
|
|
72
|
+
```html
|
|
73
|
+
<syn-dropdown></syn-dropdown>
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
<h3 id="syn-input-v3">`<syn-input>`</h3>
|
|
79
|
+
|
|
80
|
+
#### ⚠️ Changed default for `numeric-strategy` from "native" to "modern"
|
|
81
|
+
|
|
82
|
+
**Associated Ticket(s)**:
|
|
83
|
+
|
|
84
|
+
- [#1149](https://github.com/synergy-design-system/synergy-design-system/issues/1149)
|
|
85
|
+
- [#417](https://github.com/synergy-design-system/synergy-design-system/issues/417)
|
|
86
|
+
|
|
87
|
+
**Reason**:
|
|
88
|
+
|
|
89
|
+
When we [added the `numeric-strategy` field](https://github.com/synergy-design-system/synergy-design-system/issues/417) we could see that this would be a sane default.
|
|
90
|
+
To keep Synergy version 2 API stable, we chose to leave the default at `native` and make the `modern` version an opt in for interested projects.
|
|
91
|
+
This is now reversed for Synergy version 3: If you need the old behavior back, just set `numeric-strategy` to `native`.
|
|
92
|
+
|
|
93
|
+
> Be aware that the `modern` version may also adjust the width of a rendered `<syn-input>`
|
|
94
|
+
> For more information about this behavior, please have a look at [the known issues](https://synergy-design-system.github.io/?path=/docs/limitations-components--docs#syn-input-number-width).
|
|
95
|
+
|
|
96
|
+
**Migration Steps**:
|
|
97
|
+
|
|
98
|
+
- Remove `numeric-strategy="modern"` from your custom code as it is no longer needed.
|
|
99
|
+
- Optional: Remove `numeric-strategy="modern"` from Synergy Default Settings as this is now the default.
|
|
100
|
+
|
|
101
|
+
**Example (before)**:
|
|
102
|
+
|
|
103
|
+
```html
|
|
104
|
+
<syn-input
|
|
105
|
+
type="number"
|
|
106
|
+
numeric-strategy="modern"
|
|
107
|
+
label="Should use modern"
|
|
108
|
+
></syn-input>
|
|
109
|
+
<syn-input type="number" label="Uses native as default"></syn-input>
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
**Example (after)**:
|
|
113
|
+
|
|
114
|
+
```html
|
|
115
|
+
<syn-input type="number" label="Should use modern"></syn-input>
|
|
116
|
+
<syn-input
|
|
117
|
+
type="number"
|
|
118
|
+
numeric-strategy="native"
|
|
119
|
+
label="Uses native as default"
|
|
120
|
+
></syn-input>
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
---
|
|
124
|
+
|
|
125
|
+
<h3 id="syn-popup-v3">`<syn-popup>`</h3>
|
|
126
|
+
|
|
127
|
+
#### ⚠️ Removed deprecated attribute `strategy`
|
|
128
|
+
|
|
129
|
+
**Associated Ticket(s)**:
|
|
130
|
+
|
|
131
|
+
- [#1149](https://github.com/synergy-design-system/synergy-design-system/issues/1149)
|
|
132
|
+
|
|
133
|
+
**Reason**:
|
|
134
|
+
|
|
135
|
+
The `strategy` attribute was marked as deprecated in Synergy version 2.
|
|
136
|
+
As all major browsers now support the use of the [popover API](https://developer.mozilla.org/docs/Web/API/Popover_API), manually setting this is no longer needed.
|
|
137
|
+
|
|
138
|
+
**Migration Steps**:
|
|
139
|
+
|
|
140
|
+
- Remove all occurrences of the `strategy` property in your code.
|
|
141
|
+
- ⚠️ If your target audience uses outdated browsers that [do not support the Popover API](https://caniuse.com/?search=popover), think about providing a polyfill for this feature.
|
|
142
|
+
|
|
143
|
+
**Example (before)**:
|
|
144
|
+
|
|
145
|
+
```html
|
|
146
|
+
<syn-popup strategy="absolute"></syn-popup>
|
|
147
|
+
|
|
148
|
+
<syn-popup strategy="fixed"></syn-popup>
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
**Example (after)**:
|
|
152
|
+
|
|
153
|
+
```html
|
|
154
|
+
<syn-popup></syn-popup>
|
|
155
|
+
|
|
156
|
+
<syn-popup></syn-popup>
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
---
|
|
160
|
+
|
|
161
|
+
<h3 id="syn-select-v3">`<syn-select>`</h3>
|
|
162
|
+
|
|
163
|
+
#### ⚠️ Removed deprecated attribute `hoist`
|
|
164
|
+
|
|
165
|
+
**Associated Ticket(s)**:
|
|
166
|
+
|
|
167
|
+
- [#1149](https://github.com/synergy-design-system/synergy-design-system/issues/1149)
|
|
168
|
+
|
|
169
|
+
**Reason**:
|
|
170
|
+
|
|
171
|
+
The `hoist` attribute was marked as deprecated in Synergy version 2.
|
|
172
|
+
As all major browsers now support the use of the [popover API](https://developer.mozilla.org/docs/Web/API/Popover_API), manually setting this is no longer needed.
|
|
173
|
+
|
|
174
|
+
**Migration Steps**:
|
|
175
|
+
|
|
176
|
+
- Remove all occurrences of the `hoist` property in your code.
|
|
177
|
+
|
|
178
|
+
**Example (before)**:
|
|
179
|
+
|
|
180
|
+
```html
|
|
181
|
+
<syn-select hoist></syn-select>
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
**Example (after)**:
|
|
185
|
+
|
|
186
|
+
```html
|
|
187
|
+
<syn-select></syn-select>
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
---
|
|
191
|
+
|
|
192
|
+
<h3 id="syn-side-nav-v3">`<syn-side-nav>`</h3>
|
|
193
|
+
|
|
194
|
+
#### ⚠️ Removed deprecated attribute `rail`
|
|
195
|
+
|
|
196
|
+
**Associated Ticket(s)**:
|
|
197
|
+
|
|
198
|
+
- [#1149](https://github.com/synergy-design-system/synergy-design-system/issues/1149)
|
|
199
|
+
|
|
200
|
+
**Reason**:
|
|
201
|
+
|
|
202
|
+
The `rail` attribute was marked as deprecated in Synergy version 2.
|
|
203
|
+
In Synergy version 2.x, it was only left in as a fallback that triggered `variant="rail"` and already warned about the future deprecation.
|
|
204
|
+
|
|
205
|
+
**Migration Steps**:
|
|
206
|
+
|
|
207
|
+
- Exchange all occurrences of the `rail` property for `variant="rail"` in your code.
|
|
208
|
+
|
|
209
|
+
**Example (before)**:
|
|
210
|
+
|
|
211
|
+
```html
|
|
212
|
+
<syn-side-nav rail></syn-side-nav>
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
**Example (after)**:
|
|
216
|
+
|
|
217
|
+
```html
|
|
218
|
+
<syn-side-nav variant="rail"></syn-side-nav>
|
|
219
|
+
```
|
|
220
|
+
|
|
221
|
+
---
|
|
222
|
+
|
|
223
|
+
<h3 id="syn-tooltip-v3">`<syn-tooltip>`</h3>
|
|
224
|
+
|
|
225
|
+
#### ⚠️ Removed deprecated attribute `hoist`
|
|
226
|
+
|
|
227
|
+
**Associated Ticket(s)**:
|
|
228
|
+
|
|
229
|
+
- [#1149](https://github.com/synergy-design-system/synergy-design-system/issues/1149)
|
|
230
|
+
|
|
231
|
+
**Reason**:
|
|
232
|
+
|
|
233
|
+
The `hoist` attribute was marked as deprecated in Synergy version 2.
|
|
234
|
+
As all major browsers now support the use of the [popover API](https://developer.mozilla.org/docs/Web/API/Popover_API), manually setting this is no longer needed.
|
|
235
|
+
|
|
236
|
+
**Migration Steps**:
|
|
237
|
+
|
|
238
|
+
- Remove all occurrences of the `hoist` property in your code.
|
|
239
|
+
|
|
240
|
+
**Example (before)**:
|
|
241
|
+
|
|
242
|
+
```html
|
|
243
|
+
<syn-tooltip hoist></syn-tooltip>
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
**Example (after)**:
|
|
247
|
+
|
|
248
|
+
```html
|
|
249
|
+
<syn-tooltip></syn-tooltip>
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
---
|
|
253
|
+
|
|
254
|
+
<h3 id="defaultSettings-v3">`defaultSettings`</h3>
|
|
255
|
+
|
|
256
|
+
#### ⚠️ Deprecated `enableExperimentalSettingEmitEvents`
|
|
257
|
+
|
|
258
|
+
**Associated Ticket(s)**:
|
|
259
|
+
|
|
260
|
+
- [#1149](https://github.com/synergy-design-system/synergy-design-system/issues/1149)
|
|
261
|
+
|
|
262
|
+
**Reason**:
|
|
263
|
+
|
|
264
|
+
This feature is no longer experimental and was therefore flagged as `deprecated`.
|
|
265
|
+
It will continue to work in Synergy version 3, but calls the new function `enableSettingEmitEvents` underneath.
|
|
266
|
+
|
|
267
|
+
> We aim to remove this wrapper in Synergy version 4.
|
|
268
|
+
|
|
269
|
+
**Migration Steps**:
|
|
270
|
+
|
|
271
|
+
- Exchange all occurrences of `enableExperimentalSettingEmitEvents` with `enableSettingEmitEvents`.
|
|
272
|
+
|
|
273
|
+
**Example (before)**:
|
|
274
|
+
|
|
275
|
+
```javascript
|
|
276
|
+
import { enableExperimentalSettingEmitEvents } from "@synergy-design-system/components";
|
|
277
|
+
enableExperimentalSettingEmitEvents(true);
|
|
278
|
+
```
|
|
279
|
+
|
|
280
|
+
**Example (after)**:
|
|
281
|
+
|
|
282
|
+
```javascript
|
|
283
|
+
import { enableSettingEmitEvents } from "@synergy-design-system/components";
|
|
284
|
+
enableSettingEmitEvents(true);
|
|
285
|
+
```
|
|
286
|
+
|
|
287
|
+
---
|
|
288
|
+
|
|
289
|
+
<h3 id="syn-var-fallbacks-v3">Variable fallbacks</h3>
|
|
290
|
+
|
|
291
|
+
#### ⚠️ Removed all fallback variables in components
|
|
292
|
+
|
|
293
|
+
**Associated Ticket(s)**:
|
|
294
|
+
|
|
295
|
+
- [#1149](https://github.com/synergy-design-system/synergy-design-system/issues/1149)
|
|
296
|
+
|
|
297
|
+
**Reason**:
|
|
298
|
+
|
|
299
|
+
During the migration process of Synergy version 2 to version 3, we added a compatibility layer in the components that made it possible for users with misaligned versions of the components and tokens package to still use the updated styles. This was achieved using fallbacks like this:
|
|
300
|
+
|
|
301
|
+
```css
|
|
302
|
+
/* Original code of Synergy version 2 */
|
|
303
|
+
.alert--success {
|
|
304
|
+
--variant-color-border: var(
|
|
305
|
+
--syn-alert-success-color-border,
|
|
306
|
+
var(--syn-panel-border-color)
|
|
307
|
+
);
|
|
308
|
+
}
|
|
309
|
+
```
|
|
310
|
+
|
|
311
|
+
This helped introduce Synergies new semantic layer without breaking the software. However, this also lead to increased bundle sizes.
|
|
312
|
+
|
|
313
|
+
As the component and token packages are now version aligned, there is no more need for this deprecation layer in the components like this:
|
|
314
|
+
|
|
315
|
+
```css
|
|
316
|
+
/* Updated code of Synergy version 3 */
|
|
317
|
+
.alert--success {
|
|
318
|
+
--variant-color-border: var(--syn-alert-success-color-border);
|
|
319
|
+
}
|
|
320
|
+
```
|
|
321
|
+
|
|
322
|
+
**Migration Steps**:
|
|
323
|
+
|
|
324
|
+
- Make sure you have matching versions of `@synergy-design-system/components` and `@synergy-design-system/tokens`.
|
|
325
|
+
- The components package now declares a `peerDependency` on the same version of `@synergy-design-system/tokens`. You may also remove the installation of `@synergy-design-system/tokens` that was manually needed before.
|
|
326
|
+
|
|
327
|
+
**Example (before)**:
|
|
328
|
+
|
|
329
|
+
```json
|
|
330
|
+
{
|
|
331
|
+
"dependencies": {
|
|
332
|
+
"@synergy-design-system/components": "^2.55.0",
|
|
333
|
+
"@synergy-design-system/tokens": "2.11.0"
|
|
334
|
+
}
|
|
335
|
+
}
|
|
336
|
+
```
|
|
337
|
+
|
|
338
|
+
**Example (after)**:
|
|
339
|
+
|
|
340
|
+
```json
|
|
341
|
+
{
|
|
342
|
+
"dependencies": {
|
|
343
|
+
"@synergy-design-system/components": "^3.0.0"
|
|
344
|
+
}
|
|
345
|
+
}
|
|
346
|
+
```
|
|
347
|
+
|
|
348
|
+
---
|
|
349
|
+
|
|
350
|
+
<h3 id="icons-v3">`IconLibraries`</h3>
|
|
351
|
+
|
|
352
|
+
#### ⚠️ Deprecated icon migration utilities
|
|
353
|
+
|
|
354
|
+
**Associated Ticket(s)**:
|
|
355
|
+
|
|
356
|
+
- [#1149](https://github.com/synergy-design-system/synergy-design-system/issues/1149)
|
|
357
|
+
|
|
358
|
+
**Reason**:
|
|
359
|
+
|
|
360
|
+
Synergy version 2 exposes a couple of low level utilities for managing the migration from the legacy SICK 2018 icon set to the new SICK 2025 icons.
|
|
361
|
+
With Synergy version 3, the use of SICK 2018 icons is discouraged.
|
|
362
|
+
Because of this, the migration utilities are now flagged as `deprecated` and will be removed in a future Synergy release.
|
|
363
|
+
|
|
364
|
+
This applies to:
|
|
365
|
+
|
|
366
|
+
- `createMigrationLibrary`
|
|
367
|
+
- `migrateIconName`
|
|
368
|
+
- `migrateIconNameFilled`
|
|
369
|
+
- `migrationLibrary`
|
|
370
|
+
- `setupIcons`
|
|
371
|
+
|
|
372
|
+
**Migration Steps**:
|
|
373
|
+
|
|
374
|
+
Consider switching to the new SICK 2025 icons directly.
|
|
375
|
+
Update your icon names in markup to use the new naming convention instead of relying on the automatic migration layer.
|
|
376
|
+
|
|
377
|
+
> 📖 For a complete mapping of old to new icon names, see the [SICK 2025 icon migration guide](https://synergy-design-system.github.io/?path=/docs/migration--docs).
|
|
378
|
+
|
|
379
|
+
**Example (before)**:
|
|
380
|
+
|
|
381
|
+
```javascript
|
|
382
|
+
// Using the migration helper to automatically map old icon names
|
|
383
|
+
import { setupIcons } from "@synergy-design-system/components";
|
|
384
|
+
setupIcons("sick2025"); // Enables automatic name migration
|
|
385
|
+
```
|
|
386
|
+
|
|
387
|
+
```html
|
|
388
|
+
<!-- Old SICK 2018 icon names still work due to migration layer -->
|
|
389
|
+
<syn-icon name="access_alarm"></syn-icon>
|
|
390
|
+
<syn-icon name="app_settings_alt"></syn-icon>
|
|
391
|
+
```
|
|
392
|
+
|
|
393
|
+
**Example (after)**:
|
|
394
|
+
|
|
395
|
+
```javascript
|
|
396
|
+
// No setupIcons() call needed when using SICK 2025 icons with correct names
|
|
397
|
+
// Only keep setupIcons('sick2018') if you still need the old SICK 2018 iconset
|
|
398
|
+
```
|
|
399
|
+
|
|
400
|
+
```html
|
|
401
|
+
<!-- Use new SICK 2025 icon names directly -->
|
|
402
|
+
<syn-icon name="alarm"></syn-icon>
|
|
403
|
+
<syn-icon name="phonelink_setup"></syn-icon>
|
|
404
|
+
```
|
|
405
|
+
|
|
406
|
+
---
|
|
407
|
+
|
|
408
|
+
<h3 id="angular-v3">`@synergy-design-system/angular`</h3>
|
|
409
|
+
|
|
410
|
+
#### ⚠️ Removed support for outdated Angular versions
|
|
411
|
+
|
|
412
|
+
**Associated Ticket(s)**:
|
|
413
|
+
|
|
414
|
+
- [#1149](https://github.com/synergy-design-system/synergy-design-system/issues/1149)
|
|
415
|
+
|
|
416
|
+
**Reason**:
|
|
417
|
+
|
|
418
|
+
We have removed support for Angular Version 16 and 17.
|
|
419
|
+
Both angular versions are no longer actively maintained.
|
|
420
|
+
|
|
421
|
+
**Migration Steps**:
|
|
422
|
+
|
|
423
|
+
- Follow the [official angular update guide](https://angular.dev/update)
|
|
424
|
+
- If no upgrade is possible, we advise to stay on Synergy version 2.
|
|
425
|
+
- If you still want to upgrade, you may manually override the `peerDependencies` in the `@synergy-design-system/angular` package. Please have a look at your package managers documentation about how this can be achieved.
|
|
9
426
|
|
|
10
427
|
---
|
|
11
428
|
|
|
12
429
|
## Version 2.0
|
|
13
430
|
|
|
14
|
-
|
|
431
|
+
<h3 id="syn-header-v2">`<syn-header>`</h3>
|
|
15
432
|
|
|
16
433
|
#### ⚠️ Removed default slot in favor of named slot "label".
|
|
17
434
|
|
|
@@ -22,7 +439,7 @@ As all our wrappers are based on this package, the changes also hold true for al
|
|
|
22
439
|
**Reason**:
|
|
23
440
|
|
|
24
441
|
The label was originally taken from the default `slot`.
|
|
25
|
-
However, this
|
|
442
|
+
However, this led to problems as white space characters are also seen as slot contents, preventing the `label` property from working properly.
|
|
26
443
|
|
|
27
444
|
**Migration Steps**:
|
|
28
445
|
|
|
@@ -50,7 +467,7 @@ When using the slot to show the applications name, wrap it with an element that
|
|
|
50
467
|
|
|
51
468
|
**Reason**:
|
|
52
469
|
|
|
53
|
-
The properties `show-burger-menu` and `burger-menu-visible`
|
|
470
|
+
The properties `show-burger-menu` and `burger-menu-visible` were hard to reason about and not aligned with design. They were replaced with an easier to use `burger-menu` property that has one of these different variants: `"hidden"`, `"closed"` or `"open"`.
|
|
54
471
|
|
|
55
472
|
**Migration Steps**:
|
|
56
473
|
|
|
@@ -182,7 +599,9 @@ All occurrences of the used slots `show-burger-menu-icon` and `hide-burger-menu-
|
|
|
182
599
|
</syn-header>
|
|
183
600
|
```
|
|
184
601
|
|
|
185
|
-
|
|
602
|
+
---
|
|
603
|
+
|
|
604
|
+
<h3 id="syn-prio-nav-v2">`<syn-prio-nav>`</h3>
|
|
186
605
|
|
|
187
606
|
#### ⚠️ Removed attribute `priority-menu-label` in favor of static translation
|
|
188
607
|
|
|
@@ -229,7 +648,7 @@ Remove `priority-menu-label` from all `<syn-prio-nav>` elements on the page. Thi
|
|
|
229
648
|
|
|
230
649
|
---
|
|
231
650
|
|
|
232
|
-
|
|
651
|
+
<h3 id="syn-side-nav-v2">`<syn-side-nav>`</h3>
|
|
233
652
|
|
|
234
653
|
#### ⚠️ Adjusted the open width of the side-nav
|
|
235
654
|
|
|
@@ -271,7 +690,7 @@ If for some reason the old width of 400px are desired, the css property `--side-
|
|
|
271
690
|
|
|
272
691
|
---
|
|
273
692
|
|
|
274
|
-
|
|
693
|
+
<h3 id="syn-card-v2">`<syn-card>`</h3>
|
|
275
694
|
|
|
276
695
|
#### ⚠️ Remove property `nested` in favor of `sharp`
|
|
277
696
|
|
|
@@ -308,7 +727,7 @@ The deprecated property has to be mapped to the new `sharp` property in the foll
|
|
|
308
727
|
|
|
309
728
|
---
|
|
310
729
|
|
|
311
|
-
|
|
730
|
+
<h3 id="angular-v2">`@synergy-design-system/angular`</h3>
|
|
312
731
|
|
|
313
732
|
#### ⚠️ Removed custom methods for element member methods.
|
|
314
733
|
|
|
@@ -318,9 +737,9 @@ The deprecated property has to be mapped to the new `sharp` property in the foll
|
|
|
318
737
|
|
|
319
738
|
**Reason**:
|
|
320
739
|
|
|
321
|
-
During generation of the angular wrapper components, custom functions exposed from the web-components
|
|
740
|
+
During generation of the angular wrapper components, custom functions exposed from the web-components were automatically generated. We initially integrated those methods as a helper for better `DX` when using our angular wrappers. However, the inclusion lead to a couple of issues:
|
|
322
741
|
|
|
323
|
-
1. Developers thought they could call those methods
|
|
742
|
+
1. Developers thought they could call those methods safely during render, which may lead to problems as this was never intended to work.
|
|
324
743
|
2. We had do patch the components types to make it work correctly.
|
|
325
744
|
3. We had to rename all method callers to avoid overlaps when defining the components (e.g. if there was a property `size` and a member called `size` it would lead to name clashes, so the `size` method became `callSize`).
|
|
326
745
|
4. Most developers do not even need to call those methods, making them unneeded bloat in the first place.
|
|
@@ -387,7 +806,7 @@ export class Home {
|
|
|
387
806
|
|
|
388
807
|
---
|
|
389
808
|
|
|
390
|
-
|
|
809
|
+
<h3 id="vue-v2">`@synergy-design-system/vue`</h3>
|
|
391
810
|
|
|
392
811
|
#### ⚠️ Removed custom methods for element member methods.
|
|
393
812
|
|
|
@@ -397,9 +816,9 @@ export class Home {
|
|
|
397
816
|
|
|
398
817
|
**Reason**:
|
|
399
818
|
|
|
400
|
-
During generation of the vue wrapper components, custom functions exposed from the web-components
|
|
819
|
+
During generation of the vue wrapper components, custom functions exposed from the web-components were automatically generated. We initially integrated those methods as a helper for better `DX` when using our vue wrappers. However, the inclusion lead to a couple of issues:
|
|
401
820
|
|
|
402
|
-
1. Developers thought they could call those methods
|
|
821
|
+
1. Developers thought they could call those methods safely during render, which may lead to problems as this was never intended to work.
|
|
403
822
|
2. We had do patch the components types to make it work correctly.
|
|
404
823
|
3. We had to rename all method callers to avoid overlaps when defining the components (e.g. if there was a property `size` and a member called `size` it would lead to name clashes, so the `size` method became `callSize`).
|
|
405
824
|
4. Most developers do not even need to call those methods, making them unneeded bloat in the first place.
|
|
@@ -456,7 +875,7 @@ The native element still exposes its types and all of its native functionality.
|
|
|
456
875
|
|
|
457
876
|
<!-- USE THIS AS A TEMPLATE FOR ADDITIONAL MIGRATION STEPS
|
|
458
877
|
|
|
459
|
-
|
|
878
|
+
<h3 id="COMPONENT-VERSION">`<syn-COMPONENT>`</h3>
|
|
460
879
|
|
|
461
880
|
#### ⚠️ DESCRIBE THE CHANGE HERE
|
|
462
881
|
|
|
@@ -1,5 +1,41 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 3.0.0
|
|
4
|
+
|
|
5
|
+
### Major Changes
|
|
6
|
+
|
|
7
|
+
- [#1160](https://github.com/synergy-design-system/synergy-design-system/pull/1160) [`669cbcb`](https://github.com/synergy-design-system/synergy-design-system/commit/669cbcb9cccce72134beac99ac12a2591f3e3c74) Thanks [@schilchSICKAG](https://github.com/schilchSICKAG)! - Released on: 2026-02-02
|
|
8
|
+
|
|
9
|
+
feat: 💥 Component updates and deprecations for Synergy 3.0
|
|
10
|
+
|
|
11
|
+
This release removes deprecated attributes, updates defaults, and improves bundle size by removing fallback variables.
|
|
12
|
+
|
|
13
|
+
**Key Changes:**
|
|
14
|
+
- **Breaking:** Removed `hoist` attribute from `<syn-combobox>`, `<syn-dropdown>`, `<syn-select>`, and `<syn-tooltip>` (no longer needed with Popover API support)
|
|
15
|
+
- **Breaking:** Removed `strategy` attribute from `<syn-popup>` (no longer needed with Popover API support)
|
|
16
|
+
- **Breaking:** Removed `rail` attribute from `<syn-side-nav>` (use `variant="rail"` instead)
|
|
17
|
+
- **Breaking:** Changed default for `<syn-input>` `numeric-strategy` from "native" to "modern"
|
|
18
|
+
- **Breaking:** Variable fallbacks removed - all CSS custom property fallbacks have been eliminated to reduce bundle size
|
|
19
|
+
- **Breaking:** Token package alignment - components now has a `peerDependency` on `@synergy-design-system/tokens@^3.0.0`
|
|
20
|
+
- **Breaking:** Angular support - removed support for Angular 16 and 17 (no longer actively maintained)
|
|
21
|
+
- **Deprecation Notice:** Icon migration utilities (`migrateIconName`, `migrateIconNameFilled`, `migrationLibrary`) are now deprecated
|
|
22
|
+
- **Deprecation Notice:** `enableExperimentalSettingEmitEvents` is now deprecated in favor of `enableSettingEmitEvents`
|
|
23
|
+
|
|
24
|
+
**Migration Steps:**
|
|
25
|
+
- Remove all `hoist` and `strategy` attributes from affected components
|
|
26
|
+
- Update `<syn-side-nav rail>` to `<syn-side-nav variant="rail">`
|
|
27
|
+
- Remove `numeric-strategy="modern"` from `<syn-input>` as it's now the default
|
|
28
|
+
- Update Angular projects to version 18 or higher
|
|
29
|
+
- Replace `enableExperimentalSettingEmitEvents` with `enableSettingEmitEvents`
|
|
30
|
+
- Ensure matching versions of components and tokens packages
|
|
31
|
+
|
|
32
|
+
For detailed migration instructions, please refer to the [breaking changes documentation](https://synergy-design-system.github.io/?path=/docs/packages-components-breaking-changes--docs).
|
|
33
|
+
|
|
34
|
+
### Patch Changes
|
|
35
|
+
|
|
36
|
+
- Updated dependencies [[`669cbcb`](https://github.com/synergy-design-system/synergy-design-system/commit/669cbcb9cccce72134beac99ac12a2591f3e3c74)]:
|
|
37
|
+
- @synergy-design-system/tokens@3.0.0
|
|
38
|
+
|
|
3
39
|
## 2.77.1
|
|
4
40
|
|
|
5
41
|
### Patch Changes
|
|
@@ -13,6 +49,14 @@
|
|
|
13
49
|
|
|
14
50
|
## 2.77.0
|
|
15
51
|
|
|
52
|
+
### Minor Changes
|
|
53
|
+
|
|
54
|
+
- [#1132](https://github.com/synergy-design-system/synergy-design-system/pull/1132) [`13f6b25`](https://github.com/synergy-design-system/synergy-design-system/commit/13f6b259af388a0fbafc7c963443d08e61c4e99f) Thanks [@schilchSICKAG](https://github.com/schilchSICKAG)! - Released on: 2025-12-18
|
|
55
|
+
|
|
56
|
+
feat: ✨ support angular 21 (#1094)
|
|
57
|
+
|
|
58
|
+
Enables the possibility to use `angular@21`.
|
|
59
|
+
|
|
16
60
|
## 2.76.0
|
|
17
61
|
|
|
18
62
|
### Minor Changes
|