@odx/icons 4.8.0 → 4.8.1

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 CHANGED
@@ -1,5 +1,11 @@
1
1
  # @odx/icons
2
2
 
3
+ ## 4.8.1
4
+
5
+ ### Bug Fixes
6
+
7
+ - Improve README code examples and documentation
8
+
3
9
  ## 4.8.0
4
10
 
5
11
  ### Minor Changes
package/README.md CHANGED
@@ -80,11 +80,8 @@ Set the CSS `font-size` property on the element to define a custom size.
80
80
  import '@odx/icons/core';
81
81
  </script>
82
82
 
83
- <odx-icon name="user"></odx-icon>
84
83
  <odx-icon name="core::user"></odx-icon>
85
-
86
84
  <odx-icon name="safety::alarm"></odx-icon>
87
- <odx-icon name="alarm" set="safety"></odx-icon>
88
85
  ```
89
86
 
90
87
  #### CDN
@@ -153,10 +150,11 @@ If you are using the CSS variant of the icons
153
150
  you will need to switch to the new custom element or import our compatibility script
154
151
 
155
152
  ```js
156
- // use this instead of '@odx/icons'
157
153
  import '@odx/icons/compat';
158
154
  ```
159
155
 
156
+ > The script replaces elements that look like `<odx-icon data-icon-name="...">` and `<i class="odx-icon" data-icon-name="...">` with the new custom element.
157
+
160
158
  ### Browser Support
161
159
 
162
160
  This library leverages modern web technologies such as Shadow DOM for encapsulation and CSSStyleSheet.replaceSync() for efficient stylesheet updates. It targets the ES2022 specification, taking advantage of the latest JavaScript features. These technologies are widely supported in most modern browsers.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@odx/icons",
3
3
  "description": "A library of icon assets for ODX",
4
- "version": "4.8.0",
4
+ "version": "4.8.1",
5
5
  "author": "Drägerwerk AG & Co.KGaA",
6
6
  "license": "SEE LICENSE IN LICENSE",
7
7
  "homepage": "https://odx.draeger.com",
@@ -15,11 +15,11 @@
15
15
  ],
16
16
  "type": "module",
17
17
  "dependencies": {
18
- "@odx/assets-utils": "^6.0.0"
18
+ "@odx/assets-utils": "^6.1.0"
19
19
  },
20
20
  "devDependencies": {
21
- "@odx-internal/config-typescript": "0.0.0",
22
- "@odx/assets-cli": "0.0.0"
21
+ "@odx/assets-cli": "0.0.0",
22
+ "@odx-internal/config-typescript": "0.0.0"
23
23
  },
24
24
  "sideEffects": true,
25
25
  "exports": {