@luscii-healthtech/web-ui 0.4.3 → 0.4.4
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 +37 -21
- package/dist/web-ui-tailwind.css +0 -13
- package/dist/web-ui.cjs.development.js +159 -59
- package/dist/web-ui.cjs.development.js.map +1 -1
- package/dist/web-ui.cjs.production.min.js +1 -1
- package/dist/web-ui.cjs.production.min.js.map +1 -1
- package/dist/web-ui.esm.js +156 -56
- package/dist/web-ui.esm.js.map +1 -1
- package/package.json +3 -2
- package/src/assets/arrow-down-icon.svg +3 -0
- package/src/components/Datepicker/Datepicker.scss +3 -2
- package/src/components/ListTable/ListTable.tsx +4 -13
- package/src/components/Title/Title.scss +0 -59
- package/dist/web-ui.cjs.development.css +0 -1128
- package/dist/web-ui.cjs.production.min.css +0 -1128
- package/dist/web-ui.esm.css +0 -1128
package/README.md
CHANGED
|
@@ -1,60 +1,76 @@
|
|
|
1
1
|
# web-ui
|
|
2
2
|
|
|
3
|
-
The web-ui repository contains the web UI components for Luscii's front end projects. It is published to NPM for inclusion into our projects. It also uses storybook and is published to chromatic for easy review of changes.
|
|
3
|
+
The web-ui repository contains the web UI components for Luscii's front end projects. It is published to NPM for inclusion into our projects. It also uses storybook and is published to chromatic for easy review of changes.
|
|
4
4
|
|
|
5
5
|
## Running locally
|
|
6
6
|
|
|
7
|
-
If you want to run storybook locally you can use
|
|
7
|
+
If you want to run storybook locally you can use
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
10
|
yarn install
|
|
11
11
|
yarn storybook
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
+
## Testing your production build
|
|
15
|
+
|
|
16
|
+
Assuming the following setup:
|
|
17
|
+
|
|
18
|
+
- The `web-ui` and `cVitals-Web` repositories are siblings are in the same folder
|
|
19
|
+
- You have ran `yarn install` on `cVitals-Web`
|
|
20
|
+
- You have ran `yarn build` on `web-ui`
|
|
21
|
+
|
|
22
|
+
Run the script below in your terminal, _in the parent folder of the repositories_.
|
|
23
|
+
|
|
24
|
+
```
|
|
25
|
+
cp -a web-ui/dist/. cVitals-Web/node_modules/@luscii-healthtech/web-ui/dist
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
When you run cVitals again, it should contain your latest updates in the component library. Use this to make sure your changes are solid before merging a pull request.
|
|
29
|
+
|
|
14
30
|
## Contributing
|
|
15
31
|
|
|
16
32
|
Make sure you understand our design system and follow its guidelines. They are document in storybook. We value consistency, simplicity and usability highly. Don't mess it up.
|
|
17
33
|
|
|
18
|
-
If you want to add components, do so in
|
|
34
|
+
If you want to add components, do so in
|
|
35
|
+
|
|
19
36
|
```
|
|
20
37
|
/src/components
|
|
21
38
|
```
|
|
22
|
-
|
|
39
|
+
|
|
40
|
+
Please stay vigilant when adding components that we implement them consistently in our projects and that it is clear when and where they have to be used. We want to avoid a lot of components that are similar.
|
|
23
41
|
|
|
24
42
|
When you create new components, you must add them to storybook as well. Stories go in
|
|
43
|
+
|
|
25
44
|
```
|
|
26
45
|
/stories
|
|
27
46
|
```
|
|
28
47
|
|
|
29
|
-
|
|
30
48
|
## CI setup
|
|
31
49
|
|
|
32
50
|
#### Branching
|
|
33
51
|
|
|
34
|
-
The `main` branch is our default branch. When you contribute, branch from there and name your branch
|
|
52
|
+
The `main` branch is our default branch. When you contribute, branch from there and name your branch
|
|
35
53
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
major/* //for a new design system or changes that effect our foundations (typography, color)
|
|
40
|
-
minor/* //for new components and stories
|
|
41
|
-
patch/* //for small improvements to existing components, stories
|
|
42
|
-
bug/* //for bugs, fixes
|
|
43
|
-
```
|
|
54
|
+
```
|
|
55
|
+
//Branch names convention (enforced)
|
|
44
56
|
|
|
45
|
-
|
|
57
|
+
major/* //for a new design system or changes that effect our foundations (typography, color)
|
|
58
|
+
minor/* //for new components and stories
|
|
59
|
+
patch/* //for small improvements to existing components, stories
|
|
60
|
+
bug/* //for bugs, fixes
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
We have configured at lot of magic for your convenience.
|
|
46
64
|
|
|
47
65
|
#### On every PR
|
|
48
|
-
1. the module build, lint and tests are checked.
|
|
49
|
-
2. The storybook build is published to chromatic.
|
|
50
|
-
3. Labels are added based on the branch name and PR size.
|
|
51
|
-
4. Branch names must follow the convention and are checked
|
|
52
|
-
|
|
53
66
|
|
|
67
|
+
1. the module build, lint and tests are checked.
|
|
68
|
+
2. The storybook build is published to chromatic.
|
|
69
|
+
3. Labels are added based on the branch name and PR size.
|
|
70
|
+
4. Branch names must follow the convention and are checked
|
|
54
71
|
|
|
55
72
|
#### On merge to main
|
|
56
73
|
|
|
57
74
|
1. Draft a github release
|
|
58
75
|
2. Version bump of the package
|
|
59
76
|
3. Publish new package to NPM
|
|
60
|
-
|
package/dist/web-ui-tailwind.css
CHANGED
|
@@ -1140,10 +1140,6 @@ video {
|
|
|
1140
1140
|
font-size: 0.875rem;
|
|
1141
1141
|
}
|
|
1142
1142
|
|
|
1143
|
-
.text-base {
|
|
1144
|
-
font-size: 1rem;
|
|
1145
|
-
}
|
|
1146
|
-
|
|
1147
1143
|
.text-lg {
|
|
1148
1144
|
font-size: 1.125rem;
|
|
1149
1145
|
}
|
|
@@ -1783,10 +1779,6 @@ video {
|
|
|
1783
1779
|
white-space: nowrap;
|
|
1784
1780
|
}
|
|
1785
1781
|
|
|
1786
|
-
.whitespace-pre-wrap {
|
|
1787
|
-
white-space: pre-wrap;
|
|
1788
|
-
}
|
|
1789
|
-
|
|
1790
1782
|
.break-words {
|
|
1791
1783
|
word-wrap: break-word;
|
|
1792
1784
|
overflow-wrap: break-word;
|
|
@@ -1834,10 +1826,6 @@ video {
|
|
|
1834
1826
|
width: 11.5rem;
|
|
1835
1827
|
}
|
|
1836
1828
|
|
|
1837
|
-
.w-56 {
|
|
1838
|
-
width: 14rem;
|
|
1839
|
-
}
|
|
1840
|
-
|
|
1841
1829
|
.w-80 {
|
|
1842
1830
|
width: 20rem;
|
|
1843
1831
|
}
|
|
@@ -2108,4 +2096,3 @@ video {
|
|
|
2108
2096
|
display: none;
|
|
2109
2097
|
}
|
|
2110
2098
|
}
|
|
2111
|
-
|