tenara-ui-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/README.md +58 -21
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,36 +1,73 @@
|
|
|
1
|
-
|
|
1
|
+
# Tenara UI Components
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A React component library built with atomic design principles, featuring reusable UI components for modern web applications.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## Installation
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npm
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
8
|
+
npm install tenara-ui-components
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```jsx
|
|
14
|
+
import { Button, Header } from 'tenara-ui-components';
|
|
15
|
+
|
|
16
|
+
function App() {
|
|
17
|
+
return (
|
|
18
|
+
<div>
|
|
19
|
+
<Header
|
|
20
|
+
onLogin={() => console.log('Login')}
|
|
21
|
+
onCreateAccount={() => console.log('Sign up')}
|
|
22
|
+
/>
|
|
23
|
+
<Button label="Click me" primary />
|
|
24
|
+
</div>
|
|
25
|
+
);
|
|
26
|
+
}
|
|
15
27
|
```
|
|
16
28
|
|
|
17
|
-
|
|
29
|
+
## Components
|
|
18
30
|
|
|
19
|
-
|
|
31
|
+
### Atoms
|
|
32
|
+
- **Button** - Primary UI component for user interaction
|
|
20
33
|
|
|
21
|
-
|
|
34
|
+
### Molecules
|
|
35
|
+
- **Header** - Navigation header with user authentication
|
|
22
36
|
|
|
23
|
-
|
|
37
|
+
### Pages
|
|
38
|
+
- **Page** - Complete page layout example
|
|
39
|
+
|
|
40
|
+
## Development
|
|
41
|
+
|
|
42
|
+
### Install dependencies
|
|
43
|
+
```bash
|
|
44
|
+
npm install
|
|
45
|
+
```
|
|
24
46
|
|
|
25
|
-
|
|
47
|
+
### Run development server
|
|
48
|
+
```bash
|
|
49
|
+
npm run dev
|
|
50
|
+
```
|
|
26
51
|
|
|
27
|
-
|
|
28
|
-
|
|
52
|
+
### Run Storybook
|
|
53
|
+
```bash
|
|
54
|
+
npm run storybook
|
|
55
|
+
```
|
|
29
56
|
|
|
30
|
-
|
|
57
|
+
### Build library
|
|
58
|
+
```bash
|
|
59
|
+
npm run build:lib
|
|
60
|
+
```
|
|
31
61
|
|
|
32
|
-
|
|
62
|
+
### Publish to npm
|
|
63
|
+
```bash
|
|
64
|
+
npm publish --access public
|
|
65
|
+
```
|
|
33
66
|
|
|
34
|
-
|
|
67
|
+
## Built With
|
|
35
68
|
|
|
36
|
-
|
|
69
|
+
- React 19
|
|
70
|
+
- Next.js 15
|
|
71
|
+
- TypeScript
|
|
72
|
+
- Storybook
|
|
73
|
+
- Rollup
|