You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: BREAKING_CHANGES.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -12,4 +12,4 @@ Please select your target version
12
12
13
13
## Questions ❓🙋♀️
14
14
15
-
If you have further questions or you are facing any problems during migration please [contact us over our forum](https://community.siemens.com/c/ix/).
15
+
If you have any further questions, or you encounter any issues during the migration, please [contact us over our forum](https://community.siemens.com/c/ix/).
Copy file name to clipboardExpand all lines: BREAKING_CHANGES/v3.md
+11-11Lines changed: 11 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -4,27 +4,27 @@
4
4
5
5
The `@siemens/ix-icons` package requires manual bootstrapping. For detailed installation instructions, please refer to the [`@siemens/ix-icons`](https://github.com/siemens/ix-icons) repository.
6
6
7
-
If you are using one of the framework wrappers like `@siemens/ix-angular`, `@siemens/ix-react` or `@siemens/ix-vue`see sections below.
7
+
If you are using one of the framework wrappers such as `@siemens/ix-angular`, `@siemens/ix-react` or `@siemens/ix-vue`refer to the sections below.
8
8
9
9
### Usage of icons inside `@siemens/ix-react` and `@siemens/ix-vue` changed
10
10
11
-
Icon imports by name (e.g. `<IxIcon name="star" />`) are not supported by default any more.
11
+
Icon imports by name (e.g. `<IxIcon name="star" />`) are no longer supported by default.
If you want to use the "legacy" style (`<IxIcon name="star" />`) you have do some setup tasks.
25
+
If you want to use the "legacy" style (`<IxIcon name="star" />`), you'll need to do some additional setup tasks.
26
26
27
-
Create a copy task to ensure that all icons from the `@siemens/ix-icons` package is available as a static resource. Example of a vite config (build only) example:
27
+
Create a copy task to ensure that all icons from the `@siemens/ix-icons` package are available as a static resource. Below is an example of a vite configuration (build only) example:
28
28
29
29
```ts
30
30
exportdefaultdefineConfig({
@@ -45,7 +45,7 @@ export default defineConfig({
45
45
46
46
### Usage of icons inside `@siemens/ix-angular` changed
47
47
48
-
To use imports by name (e.g. `<ix-icon name="star"></ix-icon>`) an additional configuration entry is required inside of `angular.json`:
48
+
To use imports by name (e.g. `<ix-icon name="star"></ix-icon>`), you need to add a configuration entry inside of `angular.json`:
49
49
50
50
```json
51
51
"assets": [
@@ -89,11 +89,11 @@ To configure the asset path from which domain the `ix-icon` component will load
89
89
<IxIconname="star"></IxIcon>
90
90
```
91
91
92
-
Will fetch the svg from `https://some-resource-domain/star.svg`
92
+
Above will fetch the svg from `https://some-resource-domain/star.svg`
93
93
94
94
#### with `setAssetPath`-function
95
95
96
-
Ensure to call the `setAssetPath`-function before using the `IxIcon` component e.g in the main file.
96
+
Make sure to call the `setAssetPath`-function before using the `IxIcon` component, such as in the main file.
Will fetch the svg from `https://some-resource-domain/star.svg`
108
+
Above will fetch the svg from `https://some-resource-domain/star.svg`
109
109
110
-
This will preload all icons without providing the SVGs as assets. The downside of doing this that it results in a larger bundle size. **not recommended**
110
+
This will preload all icons without including the SVGs as assets, which results in a larger bundle size. This approach ist **NOT recommended**.
0 commit comments