@justin_evo/evo-ui 1.0.1 â 1.0.2
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 +70 -0
- package/package.json +1 -1
- package/src/index.ts +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# Evo UI
|
|
2
|
+
|
|
3
|
+
**A high-performance, enterprise-grade React UI component library.**
|
|
4
|
+
|
|
5
|
+
Evo UI ships 30+ accessible, themeable React components â with built-in light &
|
|
6
|
+
dark mode, full TypeScript types, `forwardRef` + native attribute pass-through,
|
|
7
|
+
and **zero runtime dependencies**.
|
|
8
|
+
|
|
9
|
+
- ð **Documentation:** https://elevora-ui-document-3fb80.web.app
|
|
10
|
+
- ðŧ **GitHub:** https://github.com/jinchuen/evo
|
|
11
|
+
- ðĶ **npm:** https://www.npmjs.com/package/@justin_evo/evo-ui
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npm install @justin_evo/evo-ui
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
`react` and `react-dom` (>= 17) are peer dependencies. Evo UI itself has no
|
|
20
|
+
runtime dependencies.
|
|
21
|
+
|
|
22
|
+
## Quick start
|
|
23
|
+
|
|
24
|
+
```jsx
|
|
25
|
+
// Import the stylesheet once in your app entry (includes the light/dark theme tokens)
|
|
26
|
+
import '@justin_evo/evo-ui/dist/evo-ui.css'
|
|
27
|
+
|
|
28
|
+
import { EvoThemeProvider, EvoButton } from '@justin_evo/evo-ui'
|
|
29
|
+
|
|
30
|
+
export default function App() {
|
|
31
|
+
return (
|
|
32
|
+
<EvoThemeProvider defaultTheme="system">
|
|
33
|
+
<EvoButton variant="solid" severity="primary">Hello Evo</EvoButton>
|
|
34
|
+
</EvoThemeProvider>
|
|
35
|
+
)
|
|
36
|
+
}
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Why Evo UI
|
|
40
|
+
|
|
41
|
+
- ð **Light & dark mode** out of the box â CSS-variable theming, no runtime cost.
|
|
42
|
+
- ðą **Mobile-ready** â âĨ 44px touch targets, responsive down to 375px.
|
|
43
|
+
- ðĄ **Fully typed** â ships `.d.ts`; every component forwards `ref` and native attributes.
|
|
44
|
+
- ð§Đ **Composable, orthogonal APIs** â e.g. `<Form.Field><Form.Label /></Form.Field>`.
|
|
45
|
+
- ðŠķ **Zero runtime dependencies.**
|
|
46
|
+
|
|
47
|
+
## Components
|
|
48
|
+
|
|
49
|
+
Full props, variants, and live examples for every component live in the
|
|
50
|
+
[documentation](https://elevora-ui-document-3fb80.web.app).
|
|
51
|
+
|
|
52
|
+
| Category | Components |
|
|
53
|
+
| ---------------------- | ---------------------------------------------------------------------------------------------------------- |
|
|
54
|
+
| **Theming** | `EvoThemeProvider`, `EvoThemeToggle` |
|
|
55
|
+
| **Layout & structure** | `EvoStack`, `EvoGrid`, `EvoDivider`, `EvoContainer`, `EvoCard` |
|
|
56
|
+
| **Navigation** | `EvoTabs`, `EvoBreadcrumb`, `EvoNav`, `EvoTopNav`, `EvoPagination`, `EvoCommandPalette` |
|
|
57
|
+
| **Forms & inputs** | `EvoInput`, `EvoRichTextArea`, `EvoSelect`, `EvoTreeSelect`, `EvoAutoComplete`, `EvoCheckbox`, `EvoRadio`, `EvoToggle`, `EvoForm` |
|
|
58
|
+
| **Feedback & overlays**| `EvoModal`, `EvoNotification`, `EvoTooltip`, `EvoAlert` |
|
|
59
|
+
| **Data display** | `EvoBadge`, `EvoSkeleton`, `EvoTable` |
|
|
60
|
+
| **General** | `EvoButton` |
|
|
61
|
+
| **Media** | `EvoImageCropper` |
|
|
62
|
+
|
|
63
|
+
## Documentation
|
|
64
|
+
|
|
65
|
+
Browse the full component catalogue, prop tables, and copy-paste examples at
|
|
66
|
+
**https://elevora-ui-document-3fb80.web.app**.
|
|
67
|
+
|
|
68
|
+
## License
|
|
69
|
+
|
|
70
|
+
MIT ÂĐ Justin Khor
|
package/package.json
CHANGED
package/src/index.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* @module EvoUI
|
|
3
3
|
* @summary A high-performance, enterprise-grade UI component library built for modern web applications.
|
|
4
|
-
* @version 1.0.
|
|
4
|
+
* @version 1.0.2
|
|
5
5
|
* @author Justin Khor
|
|
6
6
|
* @license MIT
|
|
7
7
|
* @see {@link https://github.com/your-repo/evo-ui} Official Documentation
|