@xinghunm/compass-ui 0.1.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 +130 -0
- package/dist/index.d.mts +1154 -0
- package/dist/index.d.ts +1154 -0
- package/dist/index.js +1468 -0
- package/dist/index.mjs +1468 -0
- package/package.json +81 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) xinghunm
|
|
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,130 @@
|
|
|
1
|
+
# 🧭 Compass UI
|
|
2
|
+
|
|
3
|
+
> A React component library that guides your way to better user experience
|
|
4
|
+
|
|
5
|
+
Compass UI is a comprehensive React component library inspired by Ant Design, designed to help developers navigate through complex UI challenges with ease and precision.
|
|
6
|
+
|
|
7
|
+
## ✨ Features
|
|
8
|
+
|
|
9
|
+
- 🎯 **Navigation-First Design** - Components designed with user journey in mind
|
|
10
|
+
- 🧭 **Consistent Direction** - Unified design language across all components
|
|
11
|
+
- ⚡ **Performance Optimized** - Lightweight and fast components
|
|
12
|
+
- 🎨 **Highly Customizable** - Flexible theming and styling options
|
|
13
|
+
- 📱 **Responsive Ready** - Mobile-first approach
|
|
14
|
+
- 🔧 **TypeScript Support** - Full type safety out of the box
|
|
15
|
+
- 🌍 **Accessibility** - WCAG 2.1 compliant components
|
|
16
|
+
|
|
17
|
+
## 📦 Installation
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npm install @xinghunm/compass-ui
|
|
21
|
+
# or
|
|
22
|
+
yarn add @xinghunm/compass-ui
|
|
23
|
+
# or
|
|
24
|
+
pnpm add @xinghunm/compass-ui
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## 🚀 Quick Start
|
|
28
|
+
|
|
29
|
+
```tsx
|
|
30
|
+
import React from 'react'
|
|
31
|
+
import { Button, ThemeProvider, defaultTheme } from '@xinghunm/compass-ui'
|
|
32
|
+
|
|
33
|
+
function App() {
|
|
34
|
+
return (
|
|
35
|
+
<ThemeProvider theme={defaultTheme}>
|
|
36
|
+
<Button variant="primary">Navigate Forward</Button>
|
|
37
|
+
</ThemeProvider>
|
|
38
|
+
)
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
export default App
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## 🧭 Design Philosophy
|
|
45
|
+
|
|
46
|
+
### Navigation-Centric
|
|
47
|
+
|
|
48
|
+
Every component is designed to guide users naturally through their journey, like a compass pointing the way.
|
|
49
|
+
|
|
50
|
+
### Consistent & Reliable
|
|
51
|
+
|
|
52
|
+
Just as a compass always points north, our components provide consistent behavior and appearance across your application.
|
|
53
|
+
|
|
54
|
+
### Intuitive Direction
|
|
55
|
+
|
|
56
|
+
Clear visual hierarchy and interaction patterns that feel natural and predictable.
|
|
57
|
+
|
|
58
|
+
## 📚 Components
|
|
59
|
+
|
|
60
|
+
### Navigation
|
|
61
|
+
|
|
62
|
+
- [x] Menu
|
|
63
|
+
- [x] Dropdown
|
|
64
|
+
- [x] Pagination
|
|
65
|
+
- [x] Steps
|
|
66
|
+
- [ ] Breadcrumb
|
|
67
|
+
- [ ] Navigation Bar
|
|
68
|
+
|
|
69
|
+
### Layout
|
|
70
|
+
|
|
71
|
+
- [ ] Container
|
|
72
|
+
- [ ] Grid
|
|
73
|
+
- [ ] Space
|
|
74
|
+
- [ ] Divider
|
|
75
|
+
|
|
76
|
+
### General
|
|
77
|
+
|
|
78
|
+
- [x] Button
|
|
79
|
+
- [x] ConfigProvider
|
|
80
|
+
- [ ] Icon
|
|
81
|
+
- [ ] Typography
|
|
82
|
+
|
|
83
|
+
### Data Entry
|
|
84
|
+
|
|
85
|
+
- [x] Input
|
|
86
|
+
- [x] InputNumber
|
|
87
|
+
- [x] Select
|
|
88
|
+
- [x] DatePicker
|
|
89
|
+
- [ ] Form
|
|
90
|
+
- [ ] Checkbox
|
|
91
|
+
- [ ] Radio
|
|
92
|
+
- [ ] Switch
|
|
93
|
+
|
|
94
|
+
### Data Display
|
|
95
|
+
|
|
96
|
+
- [x] Tree
|
|
97
|
+
- [ ] Table
|
|
98
|
+
- [ ] List
|
|
99
|
+
- [ ] Card
|
|
100
|
+
- [ ] Avatar
|
|
101
|
+
- [ ] Badge
|
|
102
|
+
- [ ] Tag
|
|
103
|
+
- [ ] Tooltip
|
|
104
|
+
|
|
105
|
+
### Feedback
|
|
106
|
+
|
|
107
|
+
- [x] Message
|
|
108
|
+
- [x] Modal
|
|
109
|
+
- [x] Progress
|
|
110
|
+
- [ ] Alert
|
|
111
|
+
- [ ] Drawer
|
|
112
|
+
- [ ] Skeleton
|
|
113
|
+
- [ ] Spin
|
|
114
|
+
|
|
115
|
+
### Theming
|
|
116
|
+
|
|
117
|
+
- [x] ThemeProvider
|
|
118
|
+
- [x] defaultTheme
|
|
119
|
+
|
|
120
|
+
## 📖 Documentation
|
|
121
|
+
|
|
122
|
+
- [API Documentation](./docs/API.md) - Complete API reference
|
|
123
|
+
- [Development Guide](./docs/DEVELOPMENT.md) - Development workflow and standards
|
|
124
|
+
- [Changelog](./CHANGELOG.md) - Version history
|
|
125
|
+
|
|
126
|
+
## 📄 License
|
|
127
|
+
|
|
128
|
+
MIT © [xinghunm](https://github.com/fengyueran)
|
|
129
|
+
|
|
130
|
+
_"A good compass will guide you home, good components will guide users to success."_
|