@kakadu/components 0.1.0 → 0.1.1
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/package.json +2 -2
- package/readme.md +44 -2
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -1,9 +1,51 @@
|
|
|
1
1
|
# Kakadu Components
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Kakadu components library.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
Install the package via npm:
|
|
8
|
+
|
|
9
|
+
```
|
|
10
|
+
npm install @kakadu/components
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Next, import the base stylesheet in your application’s entry point (for example `_app.jsx`):
|
|
14
|
+
|
|
15
|
+
```
|
|
16
|
+
import '@kakadu/components/components.css';
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Finally, wrap your application with the `theme`. You can start using components right away:
|
|
20
|
+
|
|
21
|
+
```
|
|
22
|
+
import theme from '@kakadu/components/theme';
|
|
23
|
+
import Box from '@kakadu/components/box';
|
|
24
|
+
|
|
25
|
+
export default function Wrapper({children}) {
|
|
26
|
+
return (
|
|
27
|
+
<div className={theme}>
|
|
28
|
+
<Box>Hello!</Box>
|
|
29
|
+
{children}
|
|
30
|
+
</div>
|
|
31
|
+
);
|
|
32
|
+
}
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Development
|
|
36
|
+
|
|
37
|
+
### Storybook
|
|
38
|
+
|
|
39
|
+
To run Storybook locally:
|
|
6
40
|
|
|
7
41
|
```
|
|
8
42
|
npm run storybook
|
|
9
43
|
```
|
|
44
|
+
|
|
45
|
+
Once started, open [http://localhost:6006](http://localhost:6006) in your browser.
|
|
46
|
+
|
|
47
|
+
## Publishing and release
|
|
48
|
+
|
|
49
|
+
1. Commit your changes.
|
|
50
|
+
2. Depending on the changeset, run `npm version major|minor|patch`.
|
|
51
|
+
3. Run `npm publish`.
|