@utilitywarehouse/hearth-json-assets 0.0.2
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 +42 -0
- package/lib/spot-process-complete-functional.json +7553 -0
- package/package.json +15 -0
package/README.md
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Hearth JSON Assets
|
|
2
|
+
|
|
3
|
+
This package provides animated illustrations as JSON data.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```console
|
|
8
|
+
yarn add @utilitywarehouse/hearth-json-assets
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```tsx
|
|
14
|
+
import SpotProcessCompleteFunctional from '@utilitywarehouse/hearth-json-assets/lib/spot-process-complete-functional.json';
|
|
15
|
+
import Lottie from 'lottie-react';
|
|
16
|
+
|
|
17
|
+
[...]
|
|
18
|
+
|
|
19
|
+
<Lottie animationData={SpotProcessCompleteFunctional} />
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Adding a new asset
|
|
23
|
+
|
|
24
|
+
Adding a new asset must be agreed with UX who can confirm the correct animated
|
|
25
|
+
illustration with Brand & Creative. When agreed, the original JSON file should
|
|
26
|
+
be added to the `raw` directory, and the generation script should be run.
|
|
27
|
+
|
|
28
|
+
### Generate
|
|
29
|
+
|
|
30
|
+
This will normalize the added JSON file, add it to the `lib` directory, and
|
|
31
|
+
update the Storybook documentation.
|
|
32
|
+
|
|
33
|
+
Run the following from the root:
|
|
34
|
+
|
|
35
|
+
```console
|
|
36
|
+
pnpm generate:json-assets
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Publishing
|
|
40
|
+
|
|
41
|
+
IF these new assets need to be released, you should add a changeset file,
|
|
42
|
+
including the added and removed assets.
|