eglador-ui-react 0.1.0-alpha.10
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 +78 -0
- package/dist/index.d.mts +679 -0
- package/dist/index.d.ts +679 -0
- package/dist/index.js +6974 -0
- package/dist/index.js.map +1 -0
- package/dist/index.mjs +6909 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +88 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Kenan Gundogan
|
|
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,78 @@
|
|
|
1
|
+
<img src=".github/eglador-logo.svg" alt="eglador-ui-react" width="200" />
|
|
2
|
+
|
|
3
|
+
# eglador-ui-react
|
|
4
|
+
|
|
5
|
+
[](https://www.npmjs.com/package/eglador-ui-react)
|
|
6
|
+
[](https://www.npmjs.com/package/eglador-ui-react)
|
|
7
|
+
[](https://github.com/kenangundogan/eglador-ui-react/blob/main/LICENSE)
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
A lightweight, reusable UI component library built with **Tailwind CSS v4** for React-based projects.
|
|
13
|
+
|
|
14
|
+
## Installation
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npm install eglador-ui-react
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
**Peer dependencies:** `react >= 18` | `react-dom >= 18` | `tailwindcss ^4`
|
|
21
|
+
|
|
22
|
+
**Optional (for Carousel):** `embla-carousel ^8` | `embla-carousel-react ^8` | plugin packages as needed (`embla-carousel-autoplay`, `embla-carousel-fade`, etc.)
|
|
23
|
+
|
|
24
|
+
## Setup
|
|
25
|
+
|
|
26
|
+
Add the following to your global stylesheet (e.g. `app/globals.css`) so Tailwind can detect the component classes:
|
|
27
|
+
|
|
28
|
+
```css
|
|
29
|
+
@import "tailwindcss";
|
|
30
|
+
@source "../node_modules/eglador-ui-react/dist/**/*.{js,mjs}";
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Usage
|
|
34
|
+
|
|
35
|
+
```tsx
|
|
36
|
+
import { Button, Input, Modal } from "eglador-ui-react";
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Components
|
|
40
|
+
|
|
41
|
+
| Category | Components |
|
|
42
|
+
|----------|-----------|
|
|
43
|
+
| **Actions** | Button, ButtonGroup, Link |
|
|
44
|
+
| **Forms** | Input, InputGroup, Select, MultiSelect, Checkbox, CheckboxGroup, Radio, RadioGroup, Switch |
|
|
45
|
+
| **Feedback** | Alert, Notification |
|
|
46
|
+
| **Data Display** | Table, Accordion, Tabs, Breadcrumb, Badge, Tooltip, Typewriter |
|
|
47
|
+
| **Overlays** | Modal, Drawer, Dropdown |
|
|
48
|
+
| **Media** | MediaImage, MediaVideo, Carousel |
|
|
49
|
+
|
|
50
|
+
## Development
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
npm install # install dependencies
|
|
54
|
+
npm run storybook # start storybook on http://localhost:6006
|
|
55
|
+
npm run build # production build to dist/
|
|
56
|
+
npm run dev # watch mode with live rebuild
|
|
57
|
+
npm run typecheck # run typescript type checking
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## Publishing
|
|
61
|
+
|
|
62
|
+
Publishing is automated via GitHub Actions. When a GitHub Release is created, the package is automatically published to npm.
|
|
63
|
+
|
|
64
|
+
1. Update `version` in `package.json`
|
|
65
|
+
2. Commit and push
|
|
66
|
+
3. Create a GitHub Release with a matching tag (e.g. `v0.1.0-alpha.10`)
|
|
67
|
+
|
|
68
|
+
## Compatibility
|
|
69
|
+
|
|
70
|
+
Works with any React-based framework: **Next.js**, **Remix**, **Vite + React**, **Gatsby**, and others.
|
|
71
|
+
|
|
72
|
+
## Author
|
|
73
|
+
|
|
74
|
+
**Kenan Gundogan** — [github.com/kenangundogan](https://github.com/kenangundogan)
|
|
75
|
+
|
|
76
|
+
## License
|
|
77
|
+
|
|
78
|
+
MIT
|