@xola/ui-kit 2.0.0-52 → 2.0.0-55
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 +13 -12
- package/build/ui-kit.es.js +1 -1
- package/build/ui-kit.umd.js +1 -1
- package/index.css +4 -0
- package/package.json +2 -1
- package/tailwind.config.js +50 -45
package/README.md
CHANGED
|
@@ -1,31 +1,31 @@
|
|
|
1
|
-
|
|
1
|
+
## Xola UI Kit
|
|
2
2
|
|
|
3
3
|
React component library for the next generation of Xola apps.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
### Requirements
|
|
6
6
|
|
|
7
|
-
- Node.js
|
|
7
|
+
- Node.js v16
|
|
8
8
|
- NPM v7
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
### Usage
|
|
11
11
|
|
|
12
12
|
Install the UI kit:
|
|
13
13
|
|
|
14
14
|
```bash
|
|
15
|
-
|
|
15
|
+
npm install @xola/ui-kit
|
|
16
16
|
```
|
|
17
17
|
|
|
18
18
|
Install peer dependencies:
|
|
19
19
|
|
|
20
20
|
```bash
|
|
21
|
-
|
|
21
|
+
npm install autoprefixer postcss tailwindcss lodash
|
|
22
22
|
```
|
|
23
23
|
|
|
24
24
|
Create PostCSS and Tailwind config files:
|
|
25
25
|
|
|
26
26
|
```bash
|
|
27
|
-
|
|
28
|
-
|
|
27
|
+
echo 'module.exports = require("@xola/ui-kit/tailwind.config");' > tailwind.config.js
|
|
28
|
+
echo 'module.exports = require("@xola/ui-kit/postcss.config");' > postcss.config.js
|
|
29
29
|
```
|
|
30
30
|
|
|
31
31
|
Import main CSS files in your project:
|
|
@@ -50,17 +50,18 @@ import { Button } from "@xola/ui-kit";
|
|
|
50
50
|
Install all required dependencies:
|
|
51
51
|
|
|
52
52
|
```bash
|
|
53
|
-
$ nvm use # Project needs Node.js
|
|
53
|
+
$ nvm use # Project needs Node.js v16 with NPM v7
|
|
54
54
|
$ npm install
|
|
55
55
|
```
|
|
56
56
|
|
|
57
57
|
Start the Storybook development server:
|
|
58
58
|
|
|
59
59
|
```bash
|
|
60
|
-
$ npm
|
|
60
|
+
$ npm start
|
|
61
61
|
```
|
|
62
62
|
|
|
63
|
-
|
|
63
|
+
## Advanced
|
|
64
|
+
### Integrate your app with a locally installed UI Kit
|
|
64
65
|
|
|
65
66
|
In order for this to work you will have to set up an NPM workspace. That means, `ui-kit` and `your-project` has to be in the same directory.
|
|
66
67
|
|
|
@@ -105,7 +106,7 @@ $ cd your-project
|
|
|
105
106
|
$ rm -rf node_modules/@xola
|
|
106
107
|
```
|
|
107
108
|
|
|
108
|
-
|
|
109
|
+
### Troubleshooting
|
|
109
110
|
|
|
110
111
|
If you encounter some package related issues, try removing the following directories and running the install command again:
|
|
111
112
|
|