@synergy-design-system/mcp 1.41.2 → 2.1.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 +38 -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 +38 -24
- package/metadata/packages/components/components/syn-button-group/component.angular.ts +24 -0
- package/metadata/packages/components/components/syn-button-group/component.custom.styles.ts +5 -0
- package/metadata/packages/components/components/syn-button-group/component.ts +77 -2
- package/metadata/packages/components/components/syn-button-group/component.vue +12 -0
- 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 +61 -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 +30 -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-button-group/docs.md +259 -0
- 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 +5 -5
|
@@ -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)
|
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
# Migrating from Synergy 2.x (SICK 2025) → Synergy 3.x (SICK 2025)
|
|
2
|
+
|
|
3
|
+
This guide describes how to migrate an application from **Synergy 2.x with the SICK 2025 theme** to **Synergy 3.x with the SICK 2025 theme**.
|
|
4
|
+
|
|
5
|
+
Use this path if you already migrated your application to the SICK 2025 theme while staying on Synergy 2 (using the dedicated SICK 2025 migration guide) and now want to upgrade to Synergy 3.
|
|
6
|
+
|
|
7
|
+
> This guide assumes that SICK 2025 is already correctly configured in your Synergy 2 setup.
|
|
8
|
+
> If you are still on SICK 2018, use **Path B** instead.
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## Migration Checklist: Quick Overview
|
|
13
|
+
|
|
14
|
+
- [ ] Confirm that your Synergy 2 application already follows the SICK 2025 migration guide.
|
|
15
|
+
- [ ] Update all `@synergy-design-system/*` packages to their compatible Synergy 3 versions.
|
|
16
|
+
- [ ] Apply all relevant breaking changes for:
|
|
17
|
+
- [ ] `@synergy-design-system/components` ([BREAKING_CHANGES](?path=/docs/packages-components-breaking-changes--docs))
|
|
18
|
+
- [ ] `@synergy-design-system/tokens` ([BREAKING_CHANGES](?path=/docs/packages-tokens-breaking-changes--docs))
|
|
19
|
+
- [ ] `@synergy-design-system/assets` ([BREAKING_CHANGES](?path=/docs/packages-assets-breaking-changes--docs))
|
|
20
|
+
- [ ] `@synergy-design-system/styles` ([BREAKING_CHANGES](?path=/docs/packages-styles-breaking-changes--docs))
|
|
21
|
+
- [ ] Verify that SICK 2025 remains active after the upgrade (themes, icons, font).
|
|
22
|
+
- [ ] Test your application visually and functionally in both light and dark mode.
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## Starting Point: Already on SICK 2025
|
|
27
|
+
|
|
28
|
+
Before you start, you should already have completed:
|
|
29
|
+
|
|
30
|
+
- The theme migration from SICK 2018 to SICK 2025 on Synergy 2, following
|
|
31
|
+
[Migration to SICK 2025 on Synergy 2](?path=/docs/migration-v2-sick-2018-to-v2-sick-2025--docs).
|
|
32
|
+
- Your application:
|
|
33
|
+
- Uses the `sick2025_light.css` and `sick2025_dark.css` theme files.
|
|
34
|
+
- Uses the `.syn-sick2025-light` and `.syn-sick2025-dark` classes for theme switching.
|
|
35
|
+
- Loads the SICK Intl font.
|
|
36
|
+
- Has SICK 2025 icons configured (via direct setup or `setupIcons('sick2025')`).
|
|
37
|
+
|
|
38
|
+
If any of these are not yet true, complete the SICK 2025 migration first.
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## Migration Steps: Detailed Guide
|
|
43
|
+
|
|
44
|
+
### 1. Prepare and review current setup
|
|
45
|
+
|
|
46
|
+
- Confirm your current Synergy versions (2.x) for all `@synergy-design-system/*` packages.
|
|
47
|
+
- Confirm that SICK 2025 is visually working as expected.
|
|
48
|
+
- Skim the package-level breaking change guides to understand the scope of the Synergy 3 upgrade:
|
|
49
|
+
- Components: [BREAKING_CHANGES](?path=/docs/packages-components-breaking-changes--docs)
|
|
50
|
+
- Tokens: [BREAKING_CHANGES](?path=/docs/packages-tokens-breaking-changes--docs)
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
### 2. Update Synergy packages to version 3
|
|
55
|
+
|
|
56
|
+
Update your dependencies to the compatible Synergy 3 versions:
|
|
57
|
+
|
|
58
|
+
- `@synergy-design-system/components` → latest **3.x**
|
|
59
|
+
- `@synergy-design-system/tokens` → latest **3.x**
|
|
60
|
+
- `@synergy-design-system/assets` → latest **2.x** (or the version recommended in the release notes)
|
|
61
|
+
- `@synergy-design-system/styles` → latest **2.x** (or the version recommended in the release notes)
|
|
62
|
+
|
|
63
|
+
Make sure you update all packages together to avoid version drift.
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
### 3. Apply package-level breaking changes
|
|
68
|
+
|
|
69
|
+
With SICK 2025 already in place, your main work for this path is to align with the Synergy 3 API and behavioral changes.
|
|
70
|
+
|
|
71
|
+
-- **Components** ([BREAKING_CHANGES](?path=/docs/packages-components-breaking-changes--docs))
|
|
72
|
+
|
|
73
|
+
- Remove deprecated attributes and properties that were dropped in Synergy 3.
|
|
74
|
+
- Adjust to new defaults (e.g., numeric input strategies, popup behavior, navigation variants).
|
|
75
|
+
- Review any changes in configuration utilities or default settings.
|
|
76
|
+
|
|
77
|
+
-- **Tokens** ([BREAKING_CHANGES](?path=/docs/packages-tokens-breaking-changes--docs))
|
|
78
|
+
|
|
79
|
+
- Verify that your theme imports still point to the correct SICK 2025 theme files.
|
|
80
|
+
- Check for deprecated or renamed tokens and adjust usages accordingly.
|
|
81
|
+
|
|
82
|
+
-- **Assets & Styles** ([BREAKING_CHANGES](?path=/docs/packages-assets-breaking-changes--docs), [BREAKING_CHANGES](?path=/docs/packages-styles-breaking-changes--docs))
|
|
83
|
+
|
|
84
|
+
- Confirm that asset paths and CSS utilities still match your build setup.
|
|
85
|
+
- Apply any required changes to your bundler configuration.
|
|
86
|
+
|
|
87
|
+
Work through these changes systematically to keep the codebase compiling and tests passing.
|
|
88
|
+
|
|
89
|
+
---
|
|
90
|
+
|
|
91
|
+
### 4. Verify SICK 2025 configuration on Synergy 3
|
|
92
|
+
|
|
93
|
+
Because SICK 2025 is the primary theme in Synergy 3, your existing SICK 2025 setup should mostly carry over, but verify the following:
|
|
94
|
+
|
|
95
|
+
- **Theme files**: Your imports reference SICK 2025 theme files compatible with Synergy 3.
|
|
96
|
+
- **Theme classes**: You still use `.syn-sick2025-light` and `.syn-sick2025-dark` consistently.
|
|
97
|
+
- **Icons**: Any utilities you used on Synergy 2 (such as `setupIcons('sick2025')` or `setSystemIconLibrary`) are still called at the right time.
|
|
98
|
+
- **Fonts**: The SICK Intl font is loaded through your preferred method.
|
|
99
|
+
|
|
100
|
+
Adjust only if the breaking change documentation suggests changes.
|
|
101
|
+
|
|
102
|
+
---
|
|
103
|
+
|
|
104
|
+
### 5. Test and verify
|
|
105
|
+
|
|
106
|
+
- Test the application in all key scenarios and supported browsers.
|
|
107
|
+
- Pay attention to:
|
|
108
|
+
- Controls with changed defaults or removed attributes.
|
|
109
|
+
- Components that rely on the Popover API or similar platform features.
|
|
110
|
+
- Visual differences due to adjustments in spacing, radii, and typography.
|
|
111
|
+
- Run your automated test suite and any visual regression checks.
|
|
112
|
+
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
## Migration: Breaking Changes & Details
|
|
116
|
+
|
|
117
|
+
This path is intentionally focused on the **upgrade from Synergy 2 to Synergy 3** with SICK 2025 already in place.
|
|
118
|
+
For detailed, package-specific changes, consult:
|
|
119
|
+
|
|
120
|
+
- Components: [@synergy-design-system/components BREAKING CHANGES](?path=/docs/packages-components-breaking-changes--docs)
|
|
121
|
+
- Tokens: [@synergy-design-system/tokens BREAKING CHANGES](?path=/docs/packages-tokens-breaking-changes--docs)
|
|
122
|
+
- Assets: [@synergy-design-system/assets BREAKING CHANGES](?path=/docs/packages-assets-breaking-changes--docs)
|
|
123
|
+
- Styles: [@synergy-design-system/styles BREAKING CHANGES](?path=/docs/packages-styles-breaking-changes--docs)
|
|
124
|
+
|
|
125
|
+
Combine this path guide with those references to implement and review changes in your codebase.
|
|
126
|
+
|
|
127
|
+
---
|
|
128
|
+
|
|
129
|
+
## References & Further Reading
|
|
130
|
+
|
|
131
|
+
- Overall migration paths overview: [Synergy Migration Overview](?path=/docs/migration--docs)
|
|
132
|
+
- 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)
|
|
133
|
+
- Additional Synergy documentation: [Synergy Docs](?path=/docs/welcome--docs)
|
|
@@ -218,7 +218,7 @@ The side navigation opens when the user clicks on the burger menu. As the side n
|
|
|
218
218
|
}
|
|
219
219
|
|
|
220
220
|
.synergy-demo-content {
|
|
221
|
-
background: var(--syn-page-background);
|
|
221
|
+
background: var(--syn-page-background-color);
|
|
222
222
|
display: flex;
|
|
223
223
|
flex: 1 0 auto;
|
|
224
224
|
flex-direction: column;
|
|
@@ -483,7 +483,7 @@ The side navigation opens when the user clicks on the burger menu. As the side n
|
|
|
483
483
|
}
|
|
484
484
|
|
|
485
485
|
.synergy-demo-content {
|
|
486
|
-
background: var(--syn-page-background);
|
|
486
|
+
background: var(--syn-page-background-color);
|
|
487
487
|
display: flex;
|
|
488
488
|
flex: 1 0 auto;
|
|
489
489
|
flex-direction: column;
|
|
@@ -779,7 +779,7 @@ The navigation opens when the user hovers over it. As the navigation opens, it o
|
|
|
779
779
|
}
|
|
780
780
|
|
|
781
781
|
.synergy-demo-content {
|
|
782
|
-
background: var(--syn-page-background);
|
|
782
|
+
background: var(--syn-page-background-color);
|
|
783
783
|
display: flex;
|
|
784
784
|
flex: 1 0 auto;
|
|
785
785
|
flex-direction: column;
|
|
@@ -1056,7 +1056,7 @@ The navigation opens when the user touches it. As the side navigation opens, a t
|
|
|
1056
1056
|
}
|
|
1057
1057
|
|
|
1058
1058
|
.synergy-demo-content {
|
|
1059
|
-
background: var(--syn-page-background);
|
|
1059
|
+
background: var(--syn-page-background-color);
|
|
1060
1060
|
display: flex;
|
|
1061
1061
|
flex: 1 0 auto;
|
|
1062
1062
|
flex-direction: column;
|
|
@@ -1317,7 +1317,7 @@ General BehaviourThe navigation maintains its compact width until the user click
|
|
|
1317
1317
|
}
|
|
1318
1318
|
|
|
1319
1319
|
.synergy-demo-content {
|
|
1320
|
-
background: var(--syn-page-background);
|
|
1320
|
+
background: var(--syn-page-background-color);
|
|
1321
1321
|
display: flex;
|
|
1322
1322
|
flex: 1 0 auto;
|
|
1323
1323
|
flex-direction: column;
|
|
@@ -1578,7 +1578,7 @@ General BehaviourThe navigation maintains its compact width until the user click
|
|
|
1578
1578
|
}
|
|
1579
1579
|
|
|
1580
1580
|
.synergy-demo-content {
|
|
1581
|
-
background: var(--syn-page-background);
|
|
1581
|
+
background: var(--syn-page-background-color);
|
|
1582
1582
|
display: flex;
|
|
1583
1583
|
flex: 1 0 auto;
|
|
1584
1584
|
flex-direction: column;
|
|
@@ -1796,7 +1796,7 @@ The top navigation can be combined with a light grey background.This variant is
|
|
|
1796
1796
|
}
|
|
1797
1797
|
|
|
1798
1798
|
.synergy-demo-content {
|
|
1799
|
-
background: var(--syn-page-background);
|
|
1799
|
+
background: var(--syn-page-background-color);
|
|
1800
1800
|
display: flex;
|
|
1801
1801
|
flex: 1 0 auto;
|
|
1802
1802
|
flex-direction: column;
|
|
@@ -2002,7 +2002,7 @@ Additionally the top navigation can be combined with an alternative background.
|
|
|
2002
2002
|
}
|
|
2003
2003
|
|
|
2004
2004
|
.synergy-demo-content {
|
|
2005
|
-
background: var(--syn-page-background);
|
|
2005
|
+
background: var(--syn-page-background-color);
|
|
2006
2006
|
display: flex;
|
|
2007
2007
|
flex: 1 0 auto;
|
|
2008
2008
|
flex-direction: column;
|
package/package.json
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
"@modelcontextprotocol/sdk": "^1.25.2",
|
|
11
11
|
"globby": "^16.1.0",
|
|
12
12
|
"zod": "^3.25.76",
|
|
13
|
-
"@synergy-design-system/assets": "
|
|
13
|
+
"@synergy-design-system/assets": "2.0.0"
|
|
14
14
|
},
|
|
15
15
|
"description": "MCP Server for the Synergy Design System",
|
|
16
16
|
"devDependencies": {
|
|
@@ -28,12 +28,12 @@
|
|
|
28
28
|
"serve-handler": "^6.1.6",
|
|
29
29
|
"ts-jest": "^29.4.6",
|
|
30
30
|
"typescript": "^5.9.3",
|
|
31
|
-
"@synergy-design-system/components": "2.77.1",
|
|
32
31
|
"@synergy-design-system/docs": "0.1.0",
|
|
33
32
|
"@synergy-design-system/eslint-config-syn": "^0.1.0",
|
|
33
|
+
"@synergy-design-system/components": "3.1.0",
|
|
34
34
|
"@synergy-design-system/fonts": "1.0.2",
|
|
35
|
-
"@synergy-design-system/styles": "
|
|
36
|
-
"@synergy-design-system/tokens": "^
|
|
35
|
+
"@synergy-design-system/styles": "2.0.0",
|
|
36
|
+
"@synergy-design-system/tokens": "^3.1.0"
|
|
37
37
|
},
|
|
38
38
|
"exports": {
|
|
39
39
|
".": {
|
|
@@ -67,7 +67,7 @@
|
|
|
67
67
|
"directory": "packages/mcp"
|
|
68
68
|
},
|
|
69
69
|
"type": "module",
|
|
70
|
-
"version": "1.
|
|
70
|
+
"version": "2.1.0",
|
|
71
71
|
"scripts": {
|
|
72
72
|
"build": "pnpm run build:ts && pnpm run build:metadata && pnpm build:hash",
|
|
73
73
|
"build:all": "pnpm run build && pnpm run build:storybook",
|