@synergy-design-system/mcp 1.41.1 → 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 +37 -0
- package/README.md +43 -8
- package/dist/bin/create-checksum.js +2 -1
- package/dist/build/assets.js +1 -1
- package/dist/build/components.js +1 -0
- package/dist/build/static.js +15 -7
- package/dist/build/styles.js +1 -1
- package/dist/build/tokens.js +1 -1
- package/dist/tools/asset-info.js +8 -6
- package/dist/tools/component-info.js +0 -1
- package/dist/tools/framework-info.js +0 -1
- 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/tools/template-info.js +0 -1
- package/dist/tools/version.js +3 -1
- package/dist/utilities/checksum.js +2 -1
- package/dist/utilities/migration.d.ts +3 -1
- package/dist/utilities/migration.js +25 -2
- package/dist/utilities/storybook/build-docs.js +2 -1
- package/dist/utilities/storybook/configs.js +3 -3
- package/dist/utilities/storybook/docs-scraper.js +0 -1
- package/dist/utilities/storybook/scraper.js +2 -2
- package/dist/utilities/storybook/storybook-manager.js +1 -2
- package/dist/utilities/version.d.ts +20 -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 +26 -0
- package/metadata/packages/assets/README.md +39 -18
- package/metadata/packages/components/components/syn-alert/component.custom.styles.ts +20 -20
- package/metadata/packages/components/components/syn-badge/component.custom.styles.ts +11 -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 +10 -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 +2 -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/components/syn-validate/component.ts +1 -0
- package/metadata/packages/components/migration/BREAKING_CHANGES.md +433 -14
- package/metadata/packages/components/static/CHANGELOG.md +55 -0
- package/metadata/packages/components/static/LIMITATIONS.md +141 -35
- package/metadata/packages/components/static/README.md +1 -1
- package/metadata/packages/fonts/CHANGELOG.md +8 -0
- package/metadata/packages/fonts/package.json +4 -4
- package/metadata/packages/styles/BREAKING_CHANGES.md +105 -0
- package/metadata/packages/styles/CHANGELOG.md +37 -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 +26 -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 +16 -16
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @synergy-design-system/tokens version 2.48.
|
|
2
|
+
* @synergy-design-system/tokens version 2.48.2
|
|
3
3
|
* SICK Global UX Foundation
|
|
4
4
|
* Do not edit directly, this file was auto-generated.
|
|
5
5
|
*/
|
|
6
6
|
|
|
7
|
-
:root, .syn-sick2025-dark {
|
|
7
|
+
:root, .syn-sick2025-dark, .syn-theme-dark {
|
|
8
8
|
color-scheme: dark;
|
|
9
9
|
|
|
10
10
|
--syn-alert-error-color-background: var(--syn-namur-error-color-background);
|
|
@@ -307,7 +307,8 @@
|
|
|
307
307
|
--syn-option-icon-color-hover: var(--syn-color-neutral-0);
|
|
308
308
|
--syn-overlay-background-blur: 8px;
|
|
309
309
|
--syn-overlay-background-color: rgba(0, 5, 26, 0.6);
|
|
310
|
-
--syn-page-background: var(--syn-color-neutral-0);
|
|
310
|
+
--syn-page-background: var(--syn-color-neutral-0); /** Will be DEPRECATED */
|
|
311
|
+
--syn-page-background-color: var(--syn-color-neutral-0);
|
|
311
312
|
--syn-panel-background-color: var(--syn-color-neutral-50);
|
|
312
313
|
--syn-panel-border-color: var(--syn-color-neutral-300);
|
|
313
314
|
--syn-panel-border-radius: var(--syn-border-radius-medium);
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* @synergy-design-system/tokens version 2.48.
|
|
2
|
+
* @synergy-design-system/tokens version 2.48.2
|
|
3
3
|
* SICK Global UX Foundation
|
|
4
4
|
* Do not edit directly, this file was auto-generated.
|
|
5
5
|
*/
|
|
6
6
|
|
|
7
|
-
:root, .syn-sick2025-light {
|
|
7
|
+
:root, .syn-sick2025-light, .syn-theme-light {
|
|
8
8
|
color-scheme: light;
|
|
9
9
|
|
|
10
10
|
--syn-alert-error-color-background: var(--syn-namur-error-color-background);
|
|
@@ -307,7 +307,8 @@
|
|
|
307
307
|
--syn-option-icon-color-hover: var(--syn-color-neutral-0);
|
|
308
308
|
--syn-overlay-background-blur: 8px;
|
|
309
309
|
--syn-overlay-background-color: rgba(0, 5, 26, 0.3);
|
|
310
|
-
--syn-page-background: #f8f7f6;
|
|
310
|
+
--syn-page-background: #f8f7f6; /** Will be DEPRECATED */
|
|
311
|
+
--syn-page-background-color: #f8f7f6;
|
|
311
312
|
--syn-panel-background-color: var(--syn-color-neutral-0);
|
|
312
313
|
--syn-panel-border-color: #e6e1dc;
|
|
313
314
|
--syn-panel-border-radius: var(--syn-border-radius-medium);
|
|
@@ -81,13 +81,7 @@ Badges can be used without content to just show an status indicator.
|
|
|
81
81
|
<div
|
|
82
82
|
style="display: flex; position: relative; gap: var(--syn-spacing-3x-large)"
|
|
83
83
|
>
|
|
84
|
-
<syn-popup
|
|
85
|
-
active=""
|
|
86
|
-
distance="-8"
|
|
87
|
-
placement="right-start"
|
|
88
|
-
skidding="-10"
|
|
89
|
-
strategy="absolute"
|
|
90
|
-
>
|
|
84
|
+
<syn-popup active="" distance="-8" placement="right-start" skidding="-10">
|
|
91
85
|
<syn-icon
|
|
92
86
|
name="wallpaper"
|
|
93
87
|
style="font-size: var(--syn-font-size-x-large)"
|
|
@@ -98,13 +92,7 @@ Badges can be used without content to just show an status indicator.
|
|
|
98
92
|
<syn-badge variant="primary"></syn-badge>
|
|
99
93
|
</syn-popup>
|
|
100
94
|
|
|
101
|
-
<syn-popup
|
|
102
|
-
active=""
|
|
103
|
-
distance="-8"
|
|
104
|
-
placement="right-start"
|
|
105
|
-
skidding="-10"
|
|
106
|
-
strategy="absolute"
|
|
107
|
-
>
|
|
95
|
+
<syn-popup active="" distance="-8" placement="right-start" skidding="-10">
|
|
108
96
|
<syn-icon
|
|
109
97
|
name="wallpaper"
|
|
110
98
|
style="font-size: var(--syn-font-size-x-large)"
|
|
@@ -4,7 +4,7 @@ Popup is a utility that lets you declaratively anchor “popup” containers to
|
|
|
4
4
|
|
|
5
5
|
```html
|
|
6
6
|
<div class="popup-default">
|
|
7
|
-
<syn-popup active="" arrow-padding="10" placement="top"
|
|
7
|
+
<syn-popup active="" arrow-padding="10" placement="top">
|
|
8
8
|
<div class="box"></div>
|
|
9
9
|
<span slot="anchor"></span>
|
|
10
10
|
</syn-popup>
|
|
@@ -37,7 +37,7 @@ meaning you can have many idle popups on the page without affecting performance.
|
|
|
37
37
|
|
|
38
38
|
```html
|
|
39
39
|
<div class="popup-active">
|
|
40
|
-
<syn-popup placement="top" active=""
|
|
40
|
+
<syn-popup placement="top" active="">
|
|
41
41
|
<span slot="anchor"></span>
|
|
42
42
|
<div class="box"></div>
|
|
43
43
|
</syn-popup>
|
|
@@ -77,12 +77,7 @@ to the anchor property to achieve the same effect without using an id.
|
|
|
77
77
|
```html
|
|
78
78
|
<span id="external-anchor"></span>
|
|
79
79
|
|
|
80
|
-
<syn-popup
|
|
81
|
-
anchor="external-anchor"
|
|
82
|
-
placement="top"
|
|
83
|
-
active=""
|
|
84
|
-
strategy="absolute"
|
|
85
|
-
>
|
|
80
|
+
<syn-popup anchor="external-anchor" placement="top" active="">
|
|
86
81
|
<div class="box"></div>
|
|
87
82
|
</syn-popup>
|
|
88
83
|
|
|
@@ -118,7 +113,7 @@ available space and it will be removed when the popup is deactivated.
|
|
|
118
113
|
|
|
119
114
|
```html
|
|
120
115
|
<div class="popup-placement">
|
|
121
|
-
<syn-popup placement="top" active=""
|
|
116
|
+
<syn-popup placement="top" active="">
|
|
122
117
|
<span slot="anchor"></span>
|
|
123
118
|
<div class="box"></div>
|
|
124
119
|
</syn-popup>
|
|
@@ -248,7 +243,7 @@ A positive value will move the popup further away and a negative value will move
|
|
|
248
243
|
|
|
249
244
|
```html
|
|
250
245
|
<div class="popup-distance">
|
|
251
|
-
<syn-popup placement="top" distance="0" active=""
|
|
246
|
+
<syn-popup placement="top" distance="0" active="">
|
|
252
247
|
<span slot="anchor"></span>
|
|
253
248
|
<div class="box"></div>
|
|
254
249
|
</syn-popup>
|
|
@@ -296,7 +291,7 @@ Both positive and negative values are allowed.
|
|
|
296
291
|
|
|
297
292
|
```html
|
|
298
293
|
<div class="popup-skidding">
|
|
299
|
-
<syn-popup placement="top" skidding="0" active=""
|
|
294
|
+
<syn-popup placement="top" skidding="0" active="">
|
|
300
295
|
<span slot="anchor"></span>
|
|
301
296
|
<div class="box"></div>
|
|
302
297
|
</syn-popup>
|
|
@@ -356,7 +351,6 @@ the arrow to align to the start, end, or center of the instead.
|
|
|
356
351
|
arrow-placement="anchor"
|
|
357
352
|
distance="8"
|
|
358
353
|
active=""
|
|
359
|
-
strategy="absolute"
|
|
360
354
|
>
|
|
361
355
|
<span slot="anchor"></span>
|
|
362
356
|
<div class="box"></div>
|
|
@@ -550,7 +544,7 @@ This is useful for controls that need the popup to stay the same width or height
|
|
|
550
544
|
|
|
551
545
|
```html
|
|
552
546
|
<div class="popup-sync">
|
|
553
|
-
<syn-popup placement="top" sync="width" active=""
|
|
547
|
+
<syn-popup placement="top" sync="width" active="">
|
|
554
548
|
<span slot="anchor"></span>
|
|
555
549
|
<div class="box"></div>
|
|
556
550
|
</syn-popup>
|
|
@@ -631,13 +625,7 @@ Additional options are available to control the flip behavior's boundary and pad
|
|
|
631
625
|
```html
|
|
632
626
|
<div class="popup-flip">
|
|
633
627
|
<div class="overflow">
|
|
634
|
-
<syn-popup
|
|
635
|
-
placement="top"
|
|
636
|
-
flip=""
|
|
637
|
-
active=""
|
|
638
|
-
id="popup-flip"
|
|
639
|
-
strategy="absolute"
|
|
640
|
-
>
|
|
628
|
+
<syn-popup placement="top" flip="" active="" id="popup-flip">
|
|
641
629
|
<span slot="anchor"></span>
|
|
642
630
|
<div class="box"></div>
|
|
643
631
|
</syn-popup>
|
|
@@ -698,7 +686,6 @@ Scroll the container to see how the popup changes it's fallback placement to pre
|
|
|
698
686
|
flip-fallback-placements="right bottom"
|
|
699
687
|
flip-fallback-strategy="initial"
|
|
700
688
|
active=""
|
|
701
|
-
strategy="absolute"
|
|
702
689
|
>
|
|
703
690
|
<span slot="anchor"></span>
|
|
704
691
|
<div class="box"></div>
|
|
@@ -743,13 +730,7 @@ Toggle the switch to see the difference.
|
|
|
743
730
|
```html
|
|
744
731
|
<div class="popup-shift">
|
|
745
732
|
<div class="overflow">
|
|
746
|
-
<syn-popup
|
|
747
|
-
placement="top"
|
|
748
|
-
shift=""
|
|
749
|
-
shift-padding="10"
|
|
750
|
-
active=""
|
|
751
|
-
strategy="absolute"
|
|
752
|
-
>
|
|
733
|
+
<syn-popup placement="top" shift="" shift-padding="10" active="">
|
|
753
734
|
<span slot="anchor"></span>
|
|
754
735
|
<div class="box"></div>
|
|
755
736
|
</syn-popup>
|
|
@@ -796,7 +777,7 @@ As such, a mouse is required to properly view it.
|
|
|
796
777
|
|
|
797
778
|
```html
|
|
798
779
|
<div class="popup-virtual-element">
|
|
799
|
-
<syn-popup placement="right-start"
|
|
780
|
+
<syn-popup placement="right-start">
|
|
800
781
|
<div class="circle"></div>
|
|
801
782
|
</syn-popup>
|
|
802
783
|
|
|
@@ -1,17 +1,57 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Synergy Migration Overview
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
This overview describes the main migration paths from Synergy version 2 to Synergy version 3 and the SICK 2025 theme.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
If you are unsure which guide to follow, start here and choose the path that matches your current setup and your target.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
---
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
- Each headline 3 (`###`) describes a component or feature that was changed
|
|
9
|
+
## Migration Paths
|
|
11
10
|
|
|
12
|
-
|
|
11
|
+
### Path A: Stay on Synergy 2, move from SICK 2018 to SICK 2025
|
|
13
12
|
|
|
14
|
-
-
|
|
15
|
-
-
|
|
16
|
-
-
|
|
17
|
-
-
|
|
13
|
+
- **Current state:** Synergy **2.x**, theme **SICK 2018**
|
|
14
|
+
- **Target state:** Synergy **2.x**, theme **SICK 2025**
|
|
15
|
+
- **Use when:** You want the new SICK 2025 brand look but are not ready to upgrade to Synergy 3 yet.
|
|
16
|
+
- **Guide:** See [Path A: Upgrade from Synergy 2 (SICK 2018) to Synergy 2 (SICK 2025)](?path=/docs/migration-v2-sick-2018-to-v2-sick-2025--docs).
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
### Path B: Synergy 2.x + SICK 2018 → Synergy 3.x + SICK 2025 (recommended)
|
|
21
|
+
|
|
22
|
+
- **Current state:** Synergy **2.x**, theme **SICK 2018**
|
|
23
|
+
- **Target state:** Synergy **3.x**, theme **SICK 2025**
|
|
24
|
+
- **Use when:** You want to fully adopt Synergy 3 and the new SICK 2025 brand.
|
|
25
|
+
- **Guide:** See [Path B: Upgrade from Synergy 2 (SICK 2018) to Synergy 3 (SICK 2025)](?path=/docs/migration-v2-sick-2018-to-v3-sick-2025--docs).
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
### Path C: Synergy 2.x + SICK 2025 → Synergy 3.x + SICK 2025
|
|
30
|
+
|
|
31
|
+
- **Current state:** Synergy **2.x**, theme **SICK 2025** (already migrated using the v2 guide)
|
|
32
|
+
- **Target state:** Synergy **3.x**, theme **SICK 2025**
|
|
33
|
+
- **Use when:** You already use SICK 2025 on Synergy 2 and now want to upgrade to Synergy 3.
|
|
34
|
+
- **Guide:** See [Path C: Upgrade from Synergy 2 to Synergy 3 with SICK 2025](?path=/docs/migration-v2-sick-2025-to-v3-sick-2025--docs).
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
### Path D: Synergy 2.x + SICK 2018 → Synergy 3.x + SICK 2018 (stay on old theme)
|
|
39
|
+
|
|
40
|
+
- **Current state:** Synergy **2.x**, theme **SICK 2018**
|
|
41
|
+
- **Target state:** Synergy **3.x**, theme **SICK 2018**
|
|
42
|
+
- **Use when:** You want to benefit from Synergy 3, but must keep the SICK 2018 theme for now.
|
|
43
|
+
- **Guide:** See [Path D: Upgrade from Synergy 2 to Synergy 3 while staying on SICK 2018](?path=/docs/migration-v2-sick-2018-to-v3-sick-2018--docs).
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## Package-Level Technical Details
|
|
48
|
+
|
|
49
|
+
Each path focuses on the _user perspective_ and high-level steps.
|
|
50
|
+
For package-specific breaking changes and code changes, always consult the dedicated package guides:
|
|
51
|
+
|
|
52
|
+
- Components: [@synergy-design-system/components BREAKING CHANGES](?path=/docs/packages-components-breaking-changes--docs)
|
|
53
|
+
- Tokens: [@synergy-design-system/tokens BREAKING CHANGES](?path=/docs/packages-tokens-breaking-changes--docs)
|
|
54
|
+
- Assets: [@synergy-design-system/assets BREAKING CHANGES](?path=/docs/packages-assets-breaking-changes--docs)
|
|
55
|
+
- Styles: [@synergy-design-system/styles BREAKING CHANGES](?path=/docs/packages-styles-breaking-changes--docs)
|
|
56
|
+
|
|
57
|
+
Use these together with the path-specific guides to plan and execute your migration.
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
# Migrating from Synergy 2.x (SICK 2018) → Synergy 3.x (SICK 2018)
|
|
2
|
+
|
|
3
|
+
This guide describes how to migrate an application from **Synergy 2.x with the SICK 2018 theme** to **Synergy 3.x while staying on the SICK 2018 theme**.
|
|
4
|
+
|
|
5
|
+
Use this path if you want to benefit from Synergy 3 (APIs, fixes, and features) but **must keep the legacy SICK 2018 theme** for the time being.
|
|
6
|
+
|
|
7
|
+
> The SICK 2018 theme is planned for future deprecation.
|
|
8
|
+
> Use this path when you need more time before switching to SICK 2025.
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## Migration Checklist: Quick Overview
|
|
13
|
+
|
|
14
|
+
- [ ] Confirm that your application is using the SICK 2018 theme on Synergy 2.
|
|
15
|
+
- [ ] Update all `@synergy-design-system/*` packages to their compatible Synergy 3 versions.
|
|
16
|
+
- [ ] Keep using the SICK 2018 theme files and classes where necessary.
|
|
17
|
+
- [ ] Apply all relevant breaking changes for:
|
|
18
|
+
- [ ] `@synergy-design-system/components` ([BREAKING_CHANGES](?path=/docs/packages-components-breaking-changes--docs))
|
|
19
|
+
- [ ] `@synergy-design-system/tokens` ([BREAKING_CHANGES](?path=/docs/packages-tokens-breaking-changes--docs))
|
|
20
|
+
- [ ] `@synergy-design-system/assets` ([BREAKING_CHANGES](?path=/docs/packages-assets-breaking-changes--docs))
|
|
21
|
+
- [ ] `@synergy-design-system/styles` ([BREAKING_CHANGES](?path=/docs/packages-styles-breaking-changes--docs))
|
|
22
|
+
- [ ] Explicitly configure SICK 2018 theme imports to avoid accidentally switching to SICK 2025.
|
|
23
|
+
- [ ] Document that you plan to migrate to SICK 2025 later (Path B or C).
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## Important Notes About SICK 2018 in Synergy 3
|
|
28
|
+
|
|
29
|
+
- The default theme behavior in Synergy 3 is oriented around SICK 2025.
|
|
30
|
+
- SICK 2018 remains available but is considered **legacy** and may be removed in a future major release.
|
|
31
|
+
- When using SICK 2018 on Synergy 3, you must:
|
|
32
|
+
- Import the explicit SICK 2018 theme files.
|
|
33
|
+
- Use the SICK 2018 theme classes in your theme switching logic.
|
|
34
|
+
|
|
35
|
+
See the tokens breaking change guide for details:
|
|
36
|
+
|
|
37
|
+
- Tokens: [BREAKING_CHANGES](?path=/docs/packages-tokens-breaking-changes--docs)
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## Migration Steps: Detailed Guide
|
|
42
|
+
|
|
43
|
+
### 1. Prepare and review current setup
|
|
44
|
+
|
|
45
|
+
- Confirm your current Synergy 2 versions for all `@synergy-design-system/*` packages.
|
|
46
|
+
- Confirm that your application uses SICK 2018:
|
|
47
|
+
- SICK 2018 theme files are imported.
|
|
48
|
+
- Theme switching uses `.syn-sick2018-light` and `.syn-sick2018-dark`.
|
|
49
|
+
- Skim the package-level breaking changes for Synergy 3.
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
### 2. Update Synergy packages to version 3
|
|
54
|
+
|
|
55
|
+
Update your dependencies to the compatible Synergy 3 versions:
|
|
56
|
+
|
|
57
|
+
- `@synergy-design-system/components` → latest **3.x**
|
|
58
|
+
- `@synergy-design-system/tokens` → latest **3.x**
|
|
59
|
+
- `@synergy-design-system/assets` → latest **2.x** (or the version recommended in the release notes)
|
|
60
|
+
- `@synergy-design-system/styles` → latest **2.x** (or the version recommended in the release notes)
|
|
61
|
+
|
|
62
|
+
Update all packages together to avoid version mismatches.
|
|
63
|
+
|
|
64
|
+
---
|
|
65
|
+
|
|
66
|
+
### 3. Keep using SICK 2018 theme files
|
|
67
|
+
|
|
68
|
+
On Synergy 3, some generic theme entry points may now point to SICK 2025.
|
|
69
|
+
To **stay on SICK 2018**, make sure you:
|
|
70
|
+
|
|
71
|
+
- Import the explicit SICK 2018 theme files instead of any generic or default theme files.
|
|
72
|
+
- Continue to use the SICK 2018 theme classes for your theme switching logic.
|
|
73
|
+
|
|
74
|
+
For example (conceptually):
|
|
75
|
+
|
|
76
|
+
- Light theme: use a SICK 2018-specific light theme file and `.syn-sick2018-light`.
|
|
77
|
+
- Dark theme: use a SICK 2018-specific dark theme file and `.syn-sick2018-dark`.
|
|
78
|
+
|
|
79
|
+
See the tokens breaking change guide for the exact file names and recommendations:
|
|
80
|
+
|
|
81
|
+
- Tokens: [BREAKING_CHANGES](?path=/docs/packages-tokens-breaking-changes--docs)
|
|
82
|
+
|
|
83
|
+
---
|
|
84
|
+
|
|
85
|
+
### 4. Apply package-level breaking changes
|
|
86
|
+
|
|
87
|
+
Even though you keep SICK 2018, you still need to migrate to the Synergy 3 APIs and behaviors:
|
|
88
|
+
|
|
89
|
+
-- **Components** ([BREAKING_CHANGES](?path=/docs/packages-components-breaking-changes--docs))
|
|
90
|
+
|
|
91
|
+
- Remove attributes that have been removed in Synergy 3.
|
|
92
|
+
- Adjust to changed defaults (e.g. numeric input strategies, popup behavior).
|
|
93
|
+
- Review any changes to default settings or configuration utilities.
|
|
94
|
+
|
|
95
|
+
-- **Tokens** ([BREAKING_CHANGES](?path=/docs/packages-tokens-breaking-changes--docs))
|
|
96
|
+
|
|
97
|
+
- Confirm that your SICK 2018 theme imports are valid in Synergy 3.
|
|
98
|
+
- Check for deprecated or renamed tokens that may still be used in your CSS.
|
|
99
|
+
|
|
100
|
+
-- **Assets & Styles** ([BREAKING_CHANGES](?path=/docs/packages-assets-breaking-changes--docs), [BREAKING_CHANGES](?path=/docs/packages-styles-breaking-changes--docs))
|
|
101
|
+
|
|
102
|
+
- Align asset paths and CSS utilities with Synergy 3.
|
|
103
|
+
|
|
104
|
+
Apply these changes systematically, running tests as you go.
|
|
105
|
+
|
|
106
|
+
---
|
|
107
|
+
|
|
108
|
+
### 5. Test and verify SICK 2018 on Synergy 3
|
|
109
|
+
|
|
110
|
+
- Test your application in both light and dark mode using SICK 2018.
|
|
111
|
+
- Pay attention to:
|
|
112
|
+
- Any unintended switch to SICK 2025 assets or themes.
|
|
113
|
+
- Components whose behavior changed between Synergy 2 and 3.
|
|
114
|
+
- Layout changes that may result from new spacing or typography defaults.
|
|
115
|
+
- Run your automated tests and, if available, visual regression tests.
|
|
116
|
+
|
|
117
|
+
---
|
|
118
|
+
|
|
119
|
+
## Planning the Future Migration to SICK 2025
|
|
120
|
+
|
|
121
|
+
Staying on SICK 2018 on Synergy 3 is intended as a **temporary** solution.
|
|
122
|
+
To complete the brand migration later:
|
|
123
|
+
|
|
124
|
+
- Plan a follow-up migration from SICK 2018 to SICK 2025 on Synergy 3.
|
|
125
|
+
- When you are ready, you can:
|
|
126
|
+
- Follow the same conceptual steps as in the SICK 2025 guide, but applied to your Synergy 3 setup.
|
|
127
|
+
- Or, if you skipped the SICK 2025 migration on Synergy 2, follow the recommended **Path B** directly in a Synergy 3-compatible way.
|
|
128
|
+
|
|
129
|
+
---
|
|
130
|
+
|
|
131
|
+
## Migration: Breaking Changes & Details
|
|
132
|
+
|
|
133
|
+
This path focuses on **staying on the legacy SICK 2018 theme** while upgrading to Synergy 3.
|
|
134
|
+
For full details, use the technical package guides:
|
|
135
|
+
|
|
136
|
+
- Components: [@synergy-design-system/components BREAKING CHANGES](?path=/docs/packages-components-breaking-changes--docs)
|
|
137
|
+
- Tokens: [@synergy-design-system/tokens BREAKING CHANGES](?path=/docs/packages-tokens-breaking-changes--docs)
|
|
138
|
+
- Assets: [@synergy-design-system/assets BREAKING CHANGES](?path=/docs/packages-assets-breaking-changes--docs)
|
|
139
|
+
- Styles: [@synergy-design-system/styles BREAKING CHANGES](?path=/docs/packages-styles-breaking-changes--docs)
|
|
140
|
+
|
|
141
|
+
---
|
|
142
|
+
|
|
143
|
+
## References & Further Reading
|
|
144
|
+
|
|
145
|
+
- Overall migration paths overview: [Synergy Migration Overview](?path=/docs/migration--docs)
|
|
146
|
+
- SICK 2025 theme migration for Synergy 2: [Migration to SICK 2025 on Synergy 2](?path=/docs/migration-v2-sick-2018-to-v2-sick-2025--docs)
|
|
147
|
+
- Additional Synergy documentation: [Synergy Docs](?path=/docs/welcome--docs)
|
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
# Migrating from Synergy 2.x (SICK 2018) → Synergy 3.x (SICK 2025)
|
|
2
|
+
|
|
3
|
+
This guide describes how to migrate an application from **Synergy 2.x with the SICK 2018 theme** to **Synergy 3.x with the SICK 2025 theme**.
|
|
4
|
+
|
|
5
|
+
This is the **recommended** end state for new and actively maintained applications.
|
|
6
|
+
|
|
7
|
+
> This guide focuses on the _user perspective_ and high-level sequence.
|
|
8
|
+
> For low-level, package-specific changes, always consult the respective `BREAKING_CHANGES.md` documents.
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## Migration Checklist: Quick Overview
|
|
13
|
+
|
|
14
|
+
- [ ] Review the [Migration to SICK 2025 on Synergy 2](?path=/docs/migration-v2-sick-2018-to-v2-sick-2025--docs) to understand the theme and icon changes.
|
|
15
|
+
- [ ] Decide whether you want to migrate the theme **before** or **together with** the Synergy 3 upgrade.
|
|
16
|
+
- [ ] Update all `@synergy-design-system/*` packages to their compatible Synergy 3 versions.
|
|
17
|
+
- [ ] Apply all relevant breaking changes for:
|
|
18
|
+
- [ ] `@synergy-design-system/components` ([BREAKING_CHANGES](?path=/docs/packages-components-breaking-changes--docs))
|
|
19
|
+
- [ ] `@synergy-design-system/tokens` ([BREAKING_CHANGES](?path=/docs/packages-tokens-breaking-changes--docs))
|
|
20
|
+
- [ ] `@synergy-design-system/assets` ([BREAKING_CHANGES](?path=/docs/packages-assets-breaking-changes--docs))
|
|
21
|
+
- [ ] `@synergy-design-system/styles` ([BREAKING_CHANGES](?path=/docs/packages-styles-breaking-changes--docs))
|
|
22
|
+
- [ ] Enable the SICK 2025 theme (tokens, theme classes, icons, font).
|
|
23
|
+
- [ ] Test your application visually and functionally in both light and dark mode.
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## Recommended Strategy
|
|
28
|
+
|
|
29
|
+
There are two practical ways to perform this migration:
|
|
30
|
+
|
|
31
|
+
1. **Two-step migration** (less risk, more control)
|
|
32
|
+
- Step 1: Stay on Synergy 2 but migrate to SICK 2025 using the existing theme migration guide.
|
|
33
|
+
- Step 2: Upgrade from Synergy 2 to Synergy 3 while already using SICK 2025.
|
|
34
|
+
|
|
35
|
+
2. **One-step migration** (fewer intermediate states, more changes at once)
|
|
36
|
+
- Update all packages directly to Synergy 3.
|
|
37
|
+
- Apply package breaking changes and enable SICK 2025 in one go.
|
|
38
|
+
|
|
39
|
+
This guide is written so it works for both strategies. When in doubt, prefer the **two-step** approach.
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## Migration Steps: Detailed Guide
|
|
44
|
+
|
|
45
|
+
### 1. Prepare and review current setup
|
|
46
|
+
|
|
47
|
+
- Confirm your current versions of all `@synergy-design-system/*` packages.
|
|
48
|
+
- Confirm that your application is currently using the **SICK 2018** theme (legacy theme files and theme classes).
|
|
49
|
+
- Skim through the package-specific breaking change guides to understand the scope of changes:
|
|
50
|
+
- Components: [BREAKING_CHANGES](?path=/docs/packages-components-breaking-changes--docs)
|
|
51
|
+
- Tokens: [BREAKING_CHANGES](?path=/docs/packages-tokens-breaking-changes--docs)
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
### 2. (Optional but recommended) First migrate SICK 2018 → SICK 2025 on Synergy 2
|
|
56
|
+
|
|
57
|
+
If you prefer a **safer**, staged migration, first migrate your theme while staying on Synergy 2:
|
|
58
|
+
|
|
59
|
+
- Follow the guide [Migration to SICK 2025 on Synergy 2](?path=/docs/migration-v2-sick-2018-to-v2-sick-2025--docs).
|
|
60
|
+
- Verify:
|
|
61
|
+
- New SICK 2025 icon assets are available and copied by your build.
|
|
62
|
+
- `setSystemIconLibrary('sick2025')` (or `setupIcons('sick2025')`) is called as appropriate.
|
|
63
|
+
- `sick2025_light.css` and `sick2025_dark.css` are imported.
|
|
64
|
+
- Theme switching uses `.syn-sick2025-light` and `.syn-sick2025-dark`.
|
|
65
|
+
- The **SICK Intl** font is loaded.
|
|
66
|
+
|
|
67
|
+
Once this is working, you are effectively in the same state as **Path C** and can continue as in that path when upgrading to Synergy 3.
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
### 3. Update Synergy packages to version 3
|
|
72
|
+
|
|
73
|
+
Update your dependencies to the compatible Synergy 3 versions:
|
|
74
|
+
|
|
75
|
+
- `@synergy-design-system/components` → latest **3.x**
|
|
76
|
+
- `@synergy-design-system/tokens` → latest **3.x**
|
|
77
|
+
- `@synergy-design-system/assets` → latest **2.x** (or the version recommended in the release notes)
|
|
78
|
+
- `@synergy-design-system/styles` → latest **2.x** (or the version recommended in the release notes)
|
|
79
|
+
|
|
80
|
+
Make sure all `@synergy-design-system/*` packages are updated together to avoid version mismatches.
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
|
|
84
|
+
### 4. Apply package-level breaking changes
|
|
85
|
+
|
|
86
|
+
Go through the breaking change guides and adjust your code accordingly.
|
|
87
|
+
Focus especially on:
|
|
88
|
+
|
|
89
|
+
-- **Components** ([BREAKING_CHANGES](?path=/docs/packages-components-breaking-changes--docs))
|
|
90
|
+
|
|
91
|
+
- Removed or renamed attributes (e.g. deprecated attributes on dropdowns, tooltips, popups, etc.).
|
|
92
|
+
- Changes in defaults (e.g. numeric input behavior).
|
|
93
|
+
- Updated settings utilities.
|
|
94
|
+
|
|
95
|
+
-- **Tokens** ([BREAKING_CHANGES](?path=/docs/packages-tokens-breaking-changes--docs))
|
|
96
|
+
|
|
97
|
+
- New default theme behavior (SICK 2025 becoming the default for certain theme imports).
|
|
98
|
+
- The planned deprecation of legacy tokens (e.g. page background tokens).
|
|
99
|
+
|
|
100
|
+
-- **Assets & Styles** ([BREAKING_CHANGES](?path=/docs/packages-assets-breaking-changes--docs), [BREAKING_CHANGES](?path=/docs/packages-styles-breaking-changes--docs))
|
|
101
|
+
|
|
102
|
+
- Any changes in asset paths, build configuration, or CSS utility classes.
|
|
103
|
+
|
|
104
|
+
Handle these changes package by package so that your code compiles and your tests pass.
|
|
105
|
+
|
|
106
|
+
---
|
|
107
|
+
|
|
108
|
+
### 5. Ensure SICK 2025 is active on Synergy 3
|
|
109
|
+
|
|
110
|
+
On Synergy 3, SICK 2025 becomes the **primary** theme. To ensure your application is correctly configured:
|
|
111
|
+
|
|
112
|
+
- Confirm that your theme imports reference the SICK 2025 theme files.
|
|
113
|
+
- Confirm that your runtime theme switching uses `.syn-sick2025-light` and `.syn-sick2025-dark`.
|
|
114
|
+
- Confirm that your icon setup uses the SICK 2025 icon library.
|
|
115
|
+
- Confirm that the SICK Intl font is loaded (via fonts package, CDN, or local hosting).
|
|
116
|
+
|
|
117
|
+
If you used the two-step strategy and already migrated the theme on Synergy 2, this step should mostly be a verification.
|
|
118
|
+
|
|
119
|
+
---
|
|
120
|
+
|
|
121
|
+
### 6. Test and verify
|
|
122
|
+
|
|
123
|
+
- Manually test key user flows in your application in both light and dark mode.
|
|
124
|
+
- Pay special attention to:
|
|
125
|
+
- Layout changes due to new spacing, radii, and typography.
|
|
126
|
+
- Numeric inputs and other controls with changed defaults.
|
|
127
|
+
- Popovers, tooltips, dropdowns, and navigation components after API cleanups.
|
|
128
|
+
- Run your automated tests and visual regression tests (if available).
|
|
129
|
+
|
|
130
|
+
---
|
|
131
|
+
|
|
132
|
+
## Migration: Breaking Changes & Details
|
|
133
|
+
|
|
134
|
+
This path-level guide is intentionally high level.
|
|
135
|
+
For exact API changes, always work with the package-specific documents:
|
|
136
|
+
|
|
137
|
+
- Components: [@synergy-design-system/components BREAKING CHANGES](?path=/docs/packages-components-breaking-changes--docs)
|
|
138
|
+
- Tokens: [@synergy-design-system/tokens BREAKING CHANGES](?path=/docs/packages-tokens-breaking-changes--docs)
|
|
139
|
+
- Assets: [@synergy-design-system/assets BREAKING CHANGES](?path=/docs/packages-assets-breaking-changes--docs)
|
|
140
|
+
- Styles: [@synergy-design-system/styles BREAKING CHANGES](?path=/docs/packages-styles-breaking-changes--docs)
|
|
141
|
+
|
|
142
|
+
You can combine this path guide with those documents to form a project-specific migration plan.
|
|
143
|
+
|
|
144
|
+
---
|
|
145
|
+
|
|
146
|
+
## References & Further Reading
|
|
147
|
+
|
|
148
|
+
- Overall migration paths overview: [Synergy Migration Overview](?path=/docs/migration--docs)
|
|
149
|
+
- SICK 2025 theme migration for Synergy 2: [Migration to SICK 2025 on Synergy 2](?path=/docs/migration-v2-sick-2018-to-v2-sick-2025--docs)
|
|
150
|
+
- Additional Synergy documentation: [Synergy Docs](?path=/docs/welcome--docs)
|