@umituz/atomic-next 1.4.0
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/LICENSE +21 -0
- package/README.md +104 -0
- package/dist/index.d.mts +1444 -0
- package/dist/index.d.ts +1444 -0
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -0
- package/dist/index.mjs +3 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +98 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 Γmit UZ
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
# @umituz/atomic-next
|
|
2
|
+
|
|
3
|
+
A comprehensive atomic design system for Next.js applications with modern React patterns and TypeScript support.
|
|
4
|
+
|
|
5
|
+
## π Features
|
|
6
|
+
|
|
7
|
+
- π¨ **Atomic Design System**: Built following atomic design principles (Atoms β Molecules β Organisms)
|
|
8
|
+
- β‘ **Modern React**: React 18+ with TypeScript and modern patterns
|
|
9
|
+
- π― **Next.js Optimized**: Built specifically for Next.js applications
|
|
10
|
+
- 𧩠**Radix UI Foundation**: Built on top of Radix UI primitives
|
|
11
|
+
- π¨ **Tailwind CSS**: Styling with Tailwind CSS utilities
|
|
12
|
+
- π± **Responsive**: Mobile-first design with responsive utilities
|
|
13
|
+
- π **Theme Support**: Light/dark mode ready
|
|
14
|
+
- βΏ **Accessible**: WCAG 2.1 AA compliant components
|
|
15
|
+
- π¦ **Tree Shakeable**: Import only what you need
|
|
16
|
+
- π§ **TypeScript**: Full TypeScript support with excellent DX
|
|
17
|
+
|
|
18
|
+
## π¦ Installation
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npm install @umituz/atomic-next
|
|
22
|
+
# or
|
|
23
|
+
yarn add @umituz/atomic-next
|
|
24
|
+
# or
|
|
25
|
+
pnpm add @umituz/atomic-next
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## π¨ Design System Architecture
|
|
29
|
+
|
|
30
|
+
### Design Tokens
|
|
31
|
+
- **Colors**: Primary, semantic, and utility colors
|
|
32
|
+
- **Typography**: Font families, sizes, weights, and line heights
|
|
33
|
+
- **Spacing**: Consistent spacing scale
|
|
34
|
+
- **Shadows**: Box shadow utilities
|
|
35
|
+
- **Borders**: Border radius and border utilities
|
|
36
|
+
- **Animations**: Transition and animation presets
|
|
37
|
+
|
|
38
|
+
### Component Hierarchy
|
|
39
|
+
|
|
40
|
+
#### Atoms (Basic Components)
|
|
41
|
+
- `AtomicButton` - Button variants with loading states
|
|
42
|
+
- `AtomicInput` - Form inputs with validation
|
|
43
|
+
- `AtomicText` - Typography components
|
|
44
|
+
- `AtomicIcon` - Icon wrapper with size variants
|
|
45
|
+
- `AtomicAvatar` - User avatars with fallbacks
|
|
46
|
+
- `AtomicBadge` - Status and count badges
|
|
47
|
+
- `AtomicSpinner` - Loading spinners
|
|
48
|
+
|
|
49
|
+
#### Molecules (Combined Components)
|
|
50
|
+
- `AtomicFormField` - Input with label and validation
|
|
51
|
+
- `AtomicDropdown` - Select and dropdown menus
|
|
52
|
+
- `AtomicNavigation` - Navigation components
|
|
53
|
+
- `AtomicCard` - Content cards with variants
|
|
54
|
+
|
|
55
|
+
#### Organisms (Complex Components)
|
|
56
|
+
- `AtomicForm` - Complete form layouts
|
|
57
|
+
- `AtomicHeader` - Application headers
|
|
58
|
+
- `AtomicLayout` - Page layout components
|
|
59
|
+
|
|
60
|
+
## π Quick Start
|
|
61
|
+
|
|
62
|
+
```tsx
|
|
63
|
+
import {
|
|
64
|
+
AtomicButton,
|
|
65
|
+
AtomicCard,
|
|
66
|
+
AtomicText,
|
|
67
|
+
AtomicThemeProvider
|
|
68
|
+
} from '@umituz/atomic-next'
|
|
69
|
+
|
|
70
|
+
function App() {
|
|
71
|
+
return (
|
|
72
|
+
<AtomicThemeProvider>
|
|
73
|
+
<AtomicCard>
|
|
74
|
+
<AtomicText variant="heading">
|
|
75
|
+
Welcome to Atomic Next
|
|
76
|
+
</AtomicText>
|
|
77
|
+
<AtomicButton
|
|
78
|
+
variant="primary"
|
|
79
|
+
size="lg"
|
|
80
|
+
onClick={() => console.log('Clicked!')}
|
|
81
|
+
>
|
|
82
|
+
Get Started
|
|
83
|
+
</AtomicButton>
|
|
84
|
+
</AtomicCard>
|
|
85
|
+
</AtomicThemeProvider>
|
|
86
|
+
)
|
|
87
|
+
}
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
## π Documentation
|
|
91
|
+
|
|
92
|
+
Visit our [documentation site](https://atomic-next.umituz.com) for detailed guides and API references.
|
|
93
|
+
|
|
94
|
+
## π€ Contributing
|
|
95
|
+
|
|
96
|
+
Contributions are welcome! Please read our [contributing guidelines](CONTRIBUTING.md) first.
|
|
97
|
+
|
|
98
|
+
## π License
|
|
99
|
+
|
|
100
|
+
MIT License - see [LICENSE](LICENSE) for details.
|
|
101
|
+
|
|
102
|
+
## π¨βπ» Author
|
|
103
|
+
|
|
104
|
+
**Γmit UZ** - [umituz.com](https://umituz.com)
|