Skip to content
This repository was archived by the owner on Mar 7, 2026. It is now read-only.

Commit 9d60ecf

Browse files
committed
feat: add Etherisc logo and update package references
1 parent a28fc6e commit 9d60ecf

File tree

10 files changed

+528
-9
lines changed

10 files changed

+528
-9
lines changed

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
],
99
"scripts": {
1010
"build": "pnpm -r build",
11-
"dev": "pnpm --filter @org/ui-kit dev",
11+
"dev": "pnpm --filter @etherisc/ui-kit dev",
1212
"test": "pnpm -r test",
1313
"test:a11y": "cd packages/ui-kit && pnpm run test-storybook:ci",
1414
"lint": "pnpm -r lint",

packages/showcase/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"dependencies": {
1616
"@faker-js/faker": "^9.8.0",
1717
"@hookform/resolvers": "^3.6.1",
18-
"@org/ui-kit": "workspace:*",
18+
"@etherisc/ui-kit": "workspace:*",
1919
"bcryptjs": "^3.0.2",
2020
"react": "^19.1.0",
2121
"react-dom": "^19.1.0",

packages/ui-kit/CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# @org/ui-kit
1+
# @etherisc/ui-kit
22

33
## 0.2.0
44

packages/ui-kit/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@org/ui-kit",
2+
"name": "@etherisc/ui-kit",
33
"version": "0.1.0-beta",
44
"private": true,
55
"type": "module",

packages/ui-kit/src/Welcome.mdx

Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
import { Meta } from "@storybook/blocks";
2+
import { EtheriscLogo } from "./components/brand/EtheriscLogo";
3+
4+
<Meta title="Welcome" />
5+
6+
<div
7+
style={{
8+
display: "flex",
9+
alignItems: "center",
10+
gap: "1rem",
11+
marginBottom: "2rem",
12+
}}
13+
>
14+
<EtheriscLogo size="xl" />
15+
</div>
16+
17+
# 🚀 Etherisc UI Kit
18+
19+
Welcome to the **Etherisc UI Kit** - a comprehensive React component library built with modern web standards and accessibility in mind.
20+
21+
## 📦 Installation
22+
23+
Install the UI Kit in your project:
24+
25+
```bash
26+
npm install @etherisc/ui-kit
27+
```
28+
29+
Or with pnpm:
30+
31+
```bash
32+
pnpm add @etherisc/ui-kit
33+
```
34+
35+
## 🎯 Quick Start
36+
37+
```tsx
38+
import { Button, ThemeProvider } from "@etherisc/ui-kit";
39+
import "@etherisc/ui-kit/dist/style.css";
40+
41+
function App() {
42+
return (
43+
<ThemeProvider>
44+
<Button variant="primary">Hello Etherisc!</Button>
45+
</ThemeProvider>
46+
);
47+
}
48+
```
49+
50+
## 🧩 Component Categories
51+
52+
### 🎨 **Primitives**
53+
54+
Basic building blocks for your application:
55+
56+
- **Button** - Various button styles and states
57+
- **Input** - Text, number, and form inputs
58+
- **Checkbox** - Accessible checkbox components
59+
- **ThemeToggle** - Dark/light mode switcher
60+
61+
### 📋 **Form Components**
62+
63+
Complete form building blocks:
64+
65+
- **TextInput** - Enhanced text input with validation
66+
- **NumberInput** - Numeric input with min/max constraints
67+
- **Form Examples** - Accessible form patterns
68+
69+
### 🏗️ **Layout Components**
70+
71+
Structure your application:
72+
73+
- **AppShell** - Complete application layout
74+
- **AuthShell** - Authentication page layouts
75+
- **MinimalShell** - Minimal page layouts
76+
- **ContentWrapper** - Content area management
77+
- **Breadcrumbs** - Navigation breadcrumbs
78+
- **Logo** - Brand logo component
79+
- **NavItem** - Navigation items
80+
81+
### 🔧 **Providers**
82+
83+
Context providers for global functionality:
84+
85+
- **ThemeProvider** - Theme and dark mode management
86+
- **ToastProvider** - Toast notification system
87+
- **ErrorBoundary** - Error handling and recovery
88+
89+
### 🎨 **Brand Components**
90+
91+
Official Etherisc branding elements:
92+
93+
- **EtheriscLogo** - Official Etherisc logo with multiple variants
94+
95+
## ✨ Key Features
96+
97+
- **🎨 Modern Design System** - Built with Tailwind CSS and DaisyUI
98+
- **♿ Accessibility First** - WCAG 2.1 AA compliant components
99+
- **🌙 Dark Mode Support** - Seamless theme switching
100+
- **📱 Responsive Design** - Mobile-first approach
101+
- **🔧 TypeScript** - Full type safety and IntelliSense
102+
- **📚 Comprehensive Documentation** - Detailed examples and API docs
103+
- **🧪 Thoroughly Tested** - Unit tests and accessibility testing
104+
- **📦 Tree Shakeable** - Import only what you need
105+
106+
## 🎨 Design Tokens
107+
108+
The UI Kit uses a consistent design system with:
109+
110+
- **Colors** - Primary, secondary, accent, and semantic colors
111+
- **Typography** - Consistent font scales and weights
112+
- **Spacing** - Harmonious spacing scale
113+
- **Shadows** - Subtle depth and elevation
114+
- **Border Radius** - Consistent corner rounding
115+
116+
## 🔍 Explore Components
117+
118+
Use the sidebar to explore all available components. Each component includes:
119+
120+
- **📖 Documentation** - Usage guidelines and best practices
121+
- **🎮 Interactive Examples** - Live component playground
122+
- **⚙️ Props API** - Complete property documentation
123+
- **♿ Accessibility Notes** - ARIA patterns and keyboard navigation
124+
125+
## 🚀 Getting Started
126+
127+
1. **Browse Components** - Explore the component library in the sidebar
128+
2. **Read Documentation** - Check the "Docs" tab for each component
129+
3. **Try Examples** - Interact with components in the "Canvas" tab
130+
4. **Copy Code** - Use the code examples in your project
131+
132+
## 📚 Additional Resources
133+
134+
- **GitHub Repository** - [etherisc/ui-kit](https://github.com/etherisc/ui-kit)
135+
- **NPM Package** - [@etherisc/ui-kit](https://www.npmjs.com/package/@etherisc/ui-kit)
136+
- **Build Information** - [Build Details](/build-info.html)
137+
138+
## 🤝 Contributing
139+
140+
We welcome contributions! Please see our contributing guidelines in the repository.
141+
142+
---
143+
144+
**Version:** {window.BUILD_INFO?.version || '0.1.0-beta'} | **Build:** {window.BUILD_INFO?.hash || 'latest'}
145+
146+
Built with ❤️ by the Etherisc team
Lines changed: 113 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)