@utilitywarehouse/hearth-svg-assets 0.0.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/README.md +31 -0
- package/package.json +20 -0
package/README.md
ADDED
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Hearth SVG Assets
|
|
2
|
+
|
|
3
|
+
This package provides the Hearth Assets as optimized svg assets. These svg assets are
|
|
4
|
+
generated from the [Figma Hearth Illustrations & Assets library](https://www.figma.com/design/bZWlxN5ZzRTlDmnR1EGZun/Hearth-Illustrations---Assets?node-id=1-3&p=f&t=TXanqMDBvlfODavY-0).
|
|
5
|
+
|
|
6
|
+
## Installation
|
|
7
|
+
|
|
8
|
+
```console
|
|
9
|
+
yarn add @utilitywarehouse/hearth-svg-assets
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Usage
|
|
13
|
+
|
|
14
|
+
```tsx
|
|
15
|
+
import LogoFullPurple from '@utilitywarehouse/hearth-svg-assets/lib/logo-full-purple.svg'
|
|
16
|
+
|
|
17
|
+
[...]
|
|
18
|
+
|
|
19
|
+
<img src={LogoFullPurple} alt="Utility Warehouse Logo" />
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Generate
|
|
23
|
+
|
|
24
|
+
To re-create the icons from source, run the generation script in this directory.
|
|
25
|
+
You will need a valid [Figma access token](https://www.figma.com/developers/api#authentication),
|
|
26
|
+
set as an environment variable; `FIGMA_ACCESS_TOKEN`.
|
|
27
|
+
|
|
28
|
+
```console
|
|
29
|
+
pnpm generate
|
|
30
|
+
pnpm format
|
|
31
|
+
```
|
package/package.json
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@utilitywarehouse/hearth-svg-assets",
|
|
3
|
+
"version": "0.0.0",
|
|
4
|
+
"description": "Hearth SVG assets",
|
|
5
|
+
"devDependencies": {
|
|
6
|
+
"cheerio": "1.0.0-rc.12",
|
|
7
|
+
"dotenv": "^16.3.1",
|
|
8
|
+
"fs-extra": "^11.1.1",
|
|
9
|
+
"lodash": "^4.17.21",
|
|
10
|
+
"svgo": "^3.0.2"
|
|
11
|
+
},
|
|
12
|
+
"files": [
|
|
13
|
+
"lib"
|
|
14
|
+
],
|
|
15
|
+
"scripts": {
|
|
16
|
+
"clean:lib": "rm -rf lib",
|
|
17
|
+
"format": "prettier --log-level=silent --write --parser=html \"lib/*.svg\"",
|
|
18
|
+
"generate": "pnpm clean:lib && node ./scripts/generate-svg-assets.js"
|
|
19
|
+
}
|
|
20
|
+
}
|