@synergy-design-system/assets 1.5.0 → 1.5.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 +7 -0
- package/README.md +37 -1
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,10 @@
|
|
|
1
|
+
# [@synergy-design-system/assets-v1.5.1](https://github.com/synergy-design-system/synergy-design-system/compare/assets/1.5.0...assets/1.5.1) (2024-04-23)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Bug Fixes
|
|
5
|
+
|
|
6
|
+
* 🤔 update dependencies ([#438](https://github.com/synergy-design-system/synergy-design-system/issues/438)) ([f3d648b](https://github.com/synergy-design-system/synergy-design-system/commit/f3d648b2071214cd6d58ff18d66e434dd32bfc76))
|
|
7
|
+
|
|
1
8
|
# [@synergy-design-system/assets-v1.5.0](https://github.com/synergy-design-system/synergy-design-system/compare/assets/1.4.0...assets/1.5.0) (2024-04-08)
|
|
2
9
|
|
|
3
10
|
|
package/README.md
CHANGED
|
@@ -1,4 +1,40 @@
|
|
|
1
|
-
|
|
1
|
+
# @synergy-design-system/assets
|
|
2
|
+
|
|
3
|
+
This package provides assets like:
|
|
4
|
+
|
|
5
|
+
- **logos:** a collection of various logos (such as the variants of the SICK brand logo)
|
|
6
|
+
- **icons:** the standard icons based on [Material Icons](https://fonts.google.com/icons)
|
|
7
|
+
- **system-icons:** a small subset of icons, that are internally used by the Synergy components
|
|
8
|
+
|
|
9
|
+
The source of the assets can be found at [Figma](https://www.figma.com/file/bZFqk9urD3NlghGUKrkKCR/Synergy-Digital-Design-System?type=design&node-id=104-233&mode=design&t=GPu4VVd9yffLLAaS-0)
|
|
10
|
+
|
|
11
|
+
### Installation
|
|
12
|
+
|
|
13
|
+
Please make sure to install the assets package as a dependency:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm install --save @synergy-design-system/assets
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
### Usage
|
|
20
|
+
|
|
21
|
+
All assets are provided as svg's.
|
|
22
|
+
|
|
23
|
+
The recommended way of using the icons is using the [<syn-icon> Synergy component](https://synergy-design-system.github.io/?path=/docs/components-syn-icon--docs). Here you will also get more information about how setting up the assets package on bundlers like vite.
|
|
24
|
+
|
|
25
|
+
```html
|
|
26
|
+
<syn-icon name="warning"></syn-icon>
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
But the assets could also be used like following:
|
|
30
|
+
|
|
31
|
+
```html
|
|
32
|
+
<img src="assets/icons/warning.svg" />
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
---
|
|
36
|
+
|
|
37
|
+
## Development
|
|
2
38
|
|
|
3
39
|
This package is taking care about getting assets (like logos, system icons and default icons) from Figma.
|
|
4
40
|
The folder structure of the assets corresponds to the structure of the Figma page.
|
package/package.json
CHANGED
|
@@ -9,8 +9,8 @@
|
|
|
9
9
|
"@semantic-release/changelog": "^6.0.3",
|
|
10
10
|
"@semantic-release/git": "^10.0.1",
|
|
11
11
|
"chalk": "^5.3.0",
|
|
12
|
-
"dotenv": "^16.4.
|
|
13
|
-
"eslint": "^8.
|
|
12
|
+
"dotenv": "^16.4.5",
|
|
13
|
+
"eslint": "^8.57.0",
|
|
14
14
|
"eslint-plugin-import": "^2.29.1",
|
|
15
15
|
"figma-export-assets": "^1.0.4",
|
|
16
16
|
"rimraf": "^5.0.5",
|
|
@@ -102,7 +102,7 @@
|
|
|
102
102
|
]
|
|
103
103
|
},
|
|
104
104
|
"type": "module",
|
|
105
|
-
"version": "1.5.
|
|
105
|
+
"version": "1.5.1",
|
|
106
106
|
"scripts": {
|
|
107
107
|
"lint": "eslint .",
|
|
108
108
|
"format.eslint": "pnpm lint --fix",
|