@stratakit/icons 0.2.2 → 0.3.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 +6 -0
- package/LICENSE.md +1 -1
- package/README.md +9 -9
- package/package.json +1 -2
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.3.0
|
|
4
|
+
|
|
5
|
+
### Breaking changes
|
|
6
|
+
|
|
7
|
+
- [#1163](https://github.com/iTwin/design-system/pull/1163): Removed `license-remove.svg` which was previously deprecated and aliased to `license-minus.svg`.
|
|
8
|
+
|
|
3
9
|
## 0.2.2
|
|
4
10
|
|
|
5
11
|
- [#1104](https://github.com/iTwin/design-system/pull/1104): Added new icons:
|
package/LICENSE.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# MIT License
|
|
2
2
|
|
|
3
|
-
Copyright ©
|
|
3
|
+
Copyright © 2024-2026 Bentley Systems, Incorporated. All rights reserved.
|
|
4
4
|
|
|
5
5
|
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
6
6
|
|
package/README.md
CHANGED
|
@@ -25,26 +25,26 @@ npm add @stratakit/icons
|
|
|
25
25
|
|
|
26
26
|
## Usage
|
|
27
27
|
|
|
28
|
-
Preferred usage is with the `Icon` component from `@stratakit/foundations`:
|
|
29
|
-
|
|
30
28
|
1. Import the icon you want to use.
|
|
31
29
|
|
|
32
|
-
Using
|
|
30
|
+
Using a static import to get the URL of the icon:
|
|
33
31
|
|
|
34
32
|
```tsx
|
|
35
|
-
|
|
33
|
+
import placeholderIcon from "@stratakit/icons/placeholder.svg";
|
|
36
34
|
```
|
|
37
35
|
|
|
38
|
-
Or
|
|
36
|
+
Or using the [`import.meta`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/import.meta) feature to get the URL of the icon:
|
|
39
37
|
|
|
40
38
|
```tsx
|
|
41
|
-
|
|
39
|
+
const placeholderIcon = new URL("@stratakit/icons/placeholder.svg", import.meta.url).href;
|
|
42
40
|
```
|
|
43
41
|
|
|
44
|
-
|
|
42
|
+
The static import method is good for use with build tools that support it, while the `import.meta` works better in browsers (but may not work reliably in all build tools).
|
|
43
|
+
|
|
44
|
+
2. Pass it to the `Icon` component from [`@stratakit/mui`](https://www.npmjs.com/package/@stratakit/mui) or [`@stratakit/foundations`](https://www.npmjs.com/package/@stratakit/foundations).
|
|
45
45
|
|
|
46
46
|
```tsx
|
|
47
|
-
import { Icon } from "@stratakit/
|
|
47
|
+
import { Icon } from "@stratakit/mui";
|
|
48
48
|
|
|
49
49
|
<Icon href={placeholderIcon} />;
|
|
50
50
|
```
|
|
@@ -56,7 +56,7 @@ Preferred usage is with the `Icon` component from `@stratakit/foundations`:
|
|
|
56
56
|
<Icon href={`${placeholderIcon}#icon-large`} size="large" />
|
|
57
57
|
```
|
|
58
58
|
|
|
59
|
-
Alternatively, you can `<use>` the SVG sprite directly (without `Icon`):
|
|
59
|
+
Alternatively, you can `<use>` the SVG sprite directly (without the `Icon` component):
|
|
60
60
|
|
|
61
61
|
```tsx
|
|
62
62
|
<svg>
|
package/package.json
CHANGED
|
@@ -1,11 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stratakit/icons",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.3.0",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"exports": {
|
|
7
7
|
"./*.svg": "./icons/*.svg",
|
|
8
|
-
"./license-remove.svg": "./icons/license-minus.svg",
|
|
9
8
|
"./icons-list.json": "./icons-list.json"
|
|
10
9
|
},
|
|
11
10
|
"files": [
|