@openfin/ui-library 0.9.0-alpha.1671734970 → 0.9.0-alpha.1672939977
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 +9 -5
- package/dist/index.js +1 -1
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -28,11 +28,15 @@ This is an opinionated React component library, built on top of [styled-componen
|
|
|
28
28
|
```bash
|
|
29
29
|
# Install the latest version
|
|
30
30
|
$ yarn add @openfin/ui-library styled-components
|
|
31
|
+
# For npm
|
|
32
|
+
$ npm i @openfin/ui-library styled-components
|
|
31
33
|
```
|
|
32
34
|
|
|
33
35
|
```bash
|
|
34
36
|
# Install a specific version
|
|
35
|
-
$ yarn add @openfin/ui-library@
|
|
37
|
+
$ yarn add @openfin/ui-library@v0.8.0
|
|
38
|
+
# For npm
|
|
39
|
+
$ npm i @openfin/ui-library@0.8.0
|
|
36
40
|
```
|
|
37
41
|
|
|
38
42
|
## Usage
|
|
@@ -118,7 +122,7 @@ Great for exploring and experimenting with UI Library components. It's also used
|
|
|
118
122
|
|
|
119
123
|
```bash
|
|
120
124
|
# Run it locally
|
|
121
|
-
$
|
|
125
|
+
$ npm run storybook
|
|
122
126
|
```
|
|
123
127
|
|
|
124
128
|
### Codesandbox.io
|
|
@@ -152,11 +156,11 @@ This links your local copy of UI Library to your app using symlinks and `package
|
|
|
152
156
|
|
|
153
157
|
Once you're setup, subsequent changes in UI Library can be propagated across easily.
|
|
154
158
|
|
|
155
|
-
After making changes in `ui-library`, run `
|
|
159
|
+
After making changes in `ui-library`, run `npm run build && yalc push`. This will apply a version bump to the local yalc package respository. It will also update the package in your app directory, but you will most likely need to restart any development servers to see the changes.
|
|
156
160
|
|
|
157
161
|
```sh
|
|
158
162
|
# push updates from ui-library side to your app
|
|
159
|
-
$
|
|
163
|
+
$ npm run build && yalc push
|
|
160
164
|
```
|
|
161
165
|
|
|
162
166
|
#### Known Issues
|
|
@@ -180,7 +184,7 @@ Extending base config used by `Storybook` to quiet some extraneous warnings.
|
|
|
180
184
|
## Testing
|
|
181
185
|
|
|
182
186
|
```sh
|
|
183
|
-
|
|
187
|
+
npm run test
|
|
184
188
|
```
|
|
185
189
|
|
|
186
190
|
## Versioning & Releasing
|