@sebgroup/green-react 1.0.0-beta.1 → 1.0.0-beta.5
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 +51 -1
- package/index.d.ts +3 -0
- package/index.esm.js +2168 -0
- package/{react.umd.js → index.umd.js} +642 -650
- package/lib/alert/alert.d.ts +3 -2
- package/lib/card/card.d.ts +3 -4
- package/lib/dropdown/dropdown.d.ts +9 -0
- package/lib/dropdown/hooks.d.ts +19 -0
- package/lib/form/{button.d.ts → button/button.d.ts} +0 -0
- package/lib/form/{buttonGroup.d.ts → buttonGroup/buttonGroup.d.ts} +2 -2
- package/lib/form/form.d.ts +4 -4
- package/lib/form/index.d.ts +4 -4
- package/lib/form/{input.d.ts → input/input.d.ts} +1 -2
- package/lib/form/{text.d.ts → text/text.d.ts} +1 -1
- package/lib/layout/flexbox/flexbox.d.ts +9 -0
- package/lib/layout/{group.d.ts → group/group.d.ts} +0 -0
- package/lib/layout/index.d.ts +2 -1
- package/lib/link/link.d.ts +7 -0
- package/lib/list/list.d.ts +14 -0
- package/lib/list/listItem.d.ts +10 -0
- package/lib/modal/modal.d.ts +2 -1
- package/lib/navbar/navbar.d.ts +12 -0
- package/lib/tabs/tabs.d.ts +13 -0
- package/package.json +11 -7
- package/lib/form/buttonGroup.test.d.ts +0 -1
- package/react.esm.js +0 -1718
package/README.md
CHANGED
|
@@ -2,10 +2,60 @@
|
|
|
2
2
|
|
|
3
3
|
> TODO: description
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Install \*
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install --save @sebgroup/green-react
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
yarn add @sebgroup/green-react
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Usage \*
|
|
6
16
|
|
|
7
17
|
```
|
|
8
18
|
const greenReact = require('@sebgroup/green-react');
|
|
9
19
|
|
|
10
20
|
// TODO: DEMONSTRATE API
|
|
11
21
|
```
|
|
22
|
+
|
|
23
|
+
### Components
|
|
24
|
+
|
|
25
|
+
View all components in the Storybook
|
|
26
|
+
|
|
27
|
+
## Develop \*
|
|
28
|
+
|
|
29
|
+
1. Clone the monorepo
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
git clone git@github.com:sebgroup/green.git
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
2. Install the dependencies
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
cd green
|
|
39
|
+
yarn
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
3. Start the Storybook
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
yarn storybook react
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
4. Start the test runner (or make sure your IDE runs the tests continuously)
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
yarn test react --watch
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
5. Pick an issue from the board and pull it into `In progress`
|
|
55
|
+
6. Open a Draft PR and reference the Issue
|
|
56
|
+
7. Start coding 🎉 Don't forget:
|
|
57
|
+
1. Test
|
|
58
|
+
2. Code
|
|
59
|
+
3. Refactor
|
|
60
|
+
|
|
61
|
+
## Commands \*
|