Skip to content

Commit 33d7df0

Browse files
committed
fix: improve v3 and documentation text
1 parent ace4c67 commit 33d7df0

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

BREAKING_CHANGES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@ Please select your target version
1212

1313
## Questions ❓🙋‍♀️
1414

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/).

BREAKING_CHANGES/v3.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,27 @@
44

55
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.
66

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.
88

99
### Usage of icons inside `@siemens/ix-react` and `@siemens/ix-vue` changed
1010

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.
1212

13-
Do the import of the icon
13+
To import the icon, use the following statement:
1414

1515
```ts
1616
import { iconStar } from '@siemens/ix-icons/icons';
1717
```
1818

19-
Use the icon as attribute assertion
19+
Use the icon as attribute like this:
2020

2121
```html
2222
<IxIcon name="{iconStar}" />
2323
```
2424

25-
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.
2626

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:
2828

2929
```ts
3030
export default defineConfig({
@@ -45,7 +45,7 @@ export default defineConfig({
4545

4646
### Usage of icons inside `@siemens/ix-angular` changed
4747

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`:
4949

5050
```json
5151
"assets": [
@@ -89,11 +89,11 @@ To configure the asset path from which domain the `ix-icon` component will load
8989
<IxIcon name="star"></IxIcon>
9090
```
9191

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`
9393

9494
#### with `setAssetPath`-function
9595

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.
9797

9898
```ts
9999
import { setAssetPath } from '@siemens/ix-icons/components';
@@ -105,9 +105,9 @@ setAssetPath('https://some-resource-domain');
105105
<IxIcon name="star"></IxIcon>
106106
```
107107

108-
Will fetch the svg from `https://some-resource-domain/star.svg`
108+
Above will fetch the svg from `https://some-resource-domain/star.svg`
109109

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**.
111111

112112
## Change props to `@internal`:
113113

0 commit comments

Comments
 (0)