pelatform-ui 1.2.0 → 1.2.1
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 +60 -42
- package/dist/animation.js +2 -40
- package/dist/base.js +2 -873
- package/dist/{chunk-5YSCAE7Y.js → chunk-NOAZYT3J.js} +2 -4
- package/dist/components.js +156 -140
- package/dist/hooks.js +4 -895
- package/dist/index.js +0 -1
- package/dist/radix.js +2 -20737
- package/package.json +31 -3
- package/dist/chunk-4OZO7TEB.js +0 -57803
- package/dist/chunk-4VNS5WPM.js +0 -42
- package/dist/chunk-B3I74Y4P.js +0 -11228
- package/dist/chunk-BQXV2NHY.js +0 -100
- package/dist/chunk-FC24ZVEO.js +0 -553
- package/dist/chunk-WFCSII5G.js +0 -28043
package/README.md
CHANGED
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
# pelatform-ui
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://www.npmjs.com/package/pelatform-ui)
|
|
4
|
+
[](https://opensource.org/licenses/MIT)
|
|
5
|
+
|
|
6
|
+
A Modern and Minimal React UI Library built with TailwindCSS. The main package that provides access to all Pelatform UI components, hooks, and utilities through a unified interface.
|
|
4
7
|
|
|
5
8
|
## Installation
|
|
6
9
|
|
|
@@ -26,22 +29,20 @@ import "pelatform-ui/css";
|
|
|
26
29
|
|
|
27
30
|
pelatform-ui is the main entry point that consolidates all Pelatform UI packages:
|
|
28
31
|
|
|
29
|
-
-
|
|
30
|
-
-
|
|
31
|
-
-
|
|
32
|
-
-
|
|
33
|
-
-
|
|
34
|
-
-
|
|
35
|
-
|
|
36
|
-
Plus additional ready-to-use components for layouts, navigation, and UI elements.
|
|
32
|
+
- **@pelatform/ui.components** - All UI components (172 components)
|
|
33
|
+
- Animation (18 components)
|
|
34
|
+
- Base (77 headless components)
|
|
35
|
+
- Radix (77 styled components)
|
|
36
|
+
- **@pelatform/ui.hook** - React hooks (18 hooks)
|
|
37
|
+
- **Custom components** - Ready-to-use layouts, navigation, providers, and utilities
|
|
37
38
|
|
|
38
39
|
## Import Paths
|
|
39
40
|
|
|
40
41
|
```typescript
|
|
41
42
|
// Main exports (utilities, types, icons)
|
|
42
|
-
import { cn, cva
|
|
43
|
+
import { cn, cva } from "pelatform-ui";
|
|
43
44
|
|
|
44
|
-
//
|
|
45
|
+
// React hooks
|
|
45
46
|
import { useHydrated, useMobile, useMediaQuery } from "pelatform-ui/hooks";
|
|
46
47
|
|
|
47
48
|
// Animation components
|
|
@@ -51,16 +52,13 @@ import {
|
|
|
51
52
|
Marquee,
|
|
52
53
|
} from "pelatform-ui/animation";
|
|
53
54
|
|
|
54
|
-
//
|
|
55
|
-
import { DateField, ShowMore } from "pelatform-ui/aria";
|
|
56
|
-
|
|
57
|
-
// Base components
|
|
55
|
+
// Base headless components (full styling control)
|
|
58
56
|
import { Button, Input, Select } from "pelatform-ui/base";
|
|
59
57
|
|
|
60
|
-
//
|
|
61
|
-
import { Card, DataGrid,
|
|
58
|
+
// Radix styled components (pre-styled)
|
|
59
|
+
import { Card, DataGrid, Calendar } from "pelatform-ui/radix";
|
|
62
60
|
|
|
63
|
-
//
|
|
61
|
+
// Custom Pelatform components
|
|
64
62
|
import { SiteHeader, SiteFooter, CommandMenu } from "pelatform-ui/components";
|
|
65
63
|
|
|
66
64
|
// Styles
|
|
@@ -70,7 +68,7 @@ import "pelatform-ui/css";
|
|
|
70
68
|
## Quick Start
|
|
71
69
|
|
|
72
70
|
```typescript
|
|
73
|
-
import {
|
|
71
|
+
import { Card, Button, Input } from "pelatform-ui/radix";
|
|
74
72
|
import { useHydrated } from "pelatform-ui/hooks";
|
|
75
73
|
import "pelatform-ui/css";
|
|
76
74
|
|
|
@@ -88,7 +86,7 @@ function App() {
|
|
|
88
86
|
}
|
|
89
87
|
```
|
|
90
88
|
|
|
91
|
-
## Components
|
|
89
|
+
## Custom Components
|
|
92
90
|
|
|
93
91
|
### Layout Components
|
|
94
92
|
|
|
@@ -113,9 +111,6 @@ function App() {
|
|
|
113
111
|
### Feedback Components
|
|
114
112
|
|
|
115
113
|
- **Alert** - Alert notifications
|
|
116
|
-
- **AlertToast** - Toast notifications
|
|
117
|
-
- **AlertNotification** - Notification alerts
|
|
118
|
-
- **AlertComingsoon** - Coming soon alert
|
|
119
114
|
- **Dialog** - Modal dialog
|
|
120
115
|
- **ScreenLoader** - Loading screen
|
|
121
116
|
|
|
@@ -127,20 +122,18 @@ function App() {
|
|
|
127
122
|
- **DotsPattern** - Dot pattern background
|
|
128
123
|
- **GridBackground** - Grid pattern background
|
|
129
124
|
- **HexagonBadge** - Hexagon-shaped badge
|
|
130
|
-
- **Icons** - Icon components
|
|
131
125
|
- **ImageInput** - Image upload input
|
|
132
126
|
- **LanguageSwitcher** - Language selector
|
|
133
127
|
- **Logo** - Brand logo
|
|
134
128
|
- **ModeSwitcher** - Theme mode toggle
|
|
135
129
|
- **MovingBorder** - Animated border effect
|
|
136
|
-
- **Subscribe** - Email subscription
|
|
137
130
|
- **Toolbar** - Toolbar component
|
|
138
131
|
- **UserAvatar** - User avatar display
|
|
139
132
|
|
|
140
133
|
### Provider Components
|
|
141
134
|
|
|
142
135
|
- **QueryProvider** - TanStack Query provider
|
|
143
|
-
- **ThemeProvider** - Theme management (next-themes
|
|
136
|
+
- **ThemeProvider** - Theme management (next-themes)
|
|
144
137
|
|
|
145
138
|
### MDX Components
|
|
146
139
|
|
|
@@ -154,7 +147,6 @@ function App() {
|
|
|
154
147
|
### Utility Components
|
|
155
148
|
|
|
156
149
|
- **Fonts** - Font configuration
|
|
157
|
-
- **RecaptchaPopover** - reCAPTCHA integration
|
|
158
150
|
- **Shared** - Shared utilities
|
|
159
151
|
|
|
160
152
|
## Theme Management
|
|
@@ -178,23 +170,48 @@ function App({ children }) {
|
|
|
178
170
|
|
|
179
171
|
## Hooks
|
|
180
172
|
|
|
181
|
-
|
|
173
|
+
18 production-ready hooks for common use cases:
|
|
174
|
+
|
|
175
|
+
### Analytics & Tracking
|
|
182
176
|
|
|
183
177
|
- **useAnalytics** - CRUD operation tracking
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
- **useHydrated** - SSR-safe hydration detection
|
|
178
|
+
|
|
179
|
+
### Responsive Design
|
|
180
|
+
|
|
188
181
|
- **useMediaQuery** - Media query tracking
|
|
182
|
+
- **useIsMobile** - Mobile detection
|
|
183
|
+
- **useViewport** - Viewport dimensions
|
|
184
|
+
- **useIntersectionObserver** - Intersection observation
|
|
185
|
+
|
|
186
|
+
### Form & Input Management
|
|
187
|
+
|
|
188
|
+
- **useFileUpload** - File upload with drag & drop
|
|
189
|
+
- **useSliderInput** - Slider input management
|
|
190
|
+
- **useCopyToClipboard** - Clipboard operations
|
|
191
|
+
|
|
192
|
+
### Navigation & Scrolling
|
|
193
|
+
|
|
189
194
|
- **useMenu** - Menu navigation state
|
|
190
|
-
- **
|
|
191
|
-
|
|
195
|
+
- **useScrollPosition** - Scroll tracking
|
|
196
|
+
|
|
197
|
+
### DOM Management
|
|
198
|
+
|
|
199
|
+
- **useBodyClass** - Body class management
|
|
192
200
|
- **useMutationObserver** - DOM mutation observation
|
|
201
|
+
|
|
202
|
+
### Platform Detection
|
|
203
|
+
|
|
204
|
+
- **useIsMac** - macOS detection
|
|
205
|
+
|
|
206
|
+
### Security
|
|
207
|
+
|
|
193
208
|
- **useRecaptchaV2** - reCAPTCHA integration
|
|
209
|
+
|
|
210
|
+
### Utilities
|
|
211
|
+
|
|
212
|
+
- **useMounted** - Mount state detection
|
|
213
|
+
- **useHydrated** - SSR-safe hydration detection
|
|
194
214
|
- **useRemoveGAParams** - GA parameter cleanup
|
|
195
|
-
- **useScrollPosition** - Scroll tracking
|
|
196
|
-
- **useSliderInput** - Slider input management
|
|
197
|
-
- **useViewport** - Viewport dimensions
|
|
198
215
|
|
|
199
216
|
## Styling
|
|
200
217
|
|
|
@@ -218,8 +235,8 @@ Full TypeScript support with comprehensive type definitions for all components a
|
|
|
218
235
|
|
|
219
236
|
## Features
|
|
220
237
|
|
|
221
|
-
-
|
|
222
|
-
-
|
|
238
|
+
- 172+ total components across all packages
|
|
239
|
+
- 18 React hooks for common use cases
|
|
223
240
|
- Full dark mode support
|
|
224
241
|
- Responsive design
|
|
225
242
|
- Accessibility (WCAG 2.1)
|
|
@@ -233,9 +250,10 @@ Full TypeScript support with comprehensive type definitions for all components a
|
|
|
233
250
|
|
|
234
251
|
### Production Dependencies
|
|
235
252
|
|
|
236
|
-
-
|
|
237
|
-
- `
|
|
238
|
-
- `
|
|
253
|
+
- `class-variance-authority` - Component variants
|
|
254
|
+
- `clsx` - Conditional className
|
|
255
|
+
- `tailwind-merge` - Tailwind class merging
|
|
256
|
+
- `tw-animate-css` - Animation utilities
|
|
239
257
|
|
|
240
258
|
### Peer Dependencies
|
|
241
259
|
|
package/dist/animation.js
CHANGED
|
@@ -1,40 +1,2 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
AvatarGroupItem,
|
|
4
|
-
AvatarGroupTooltip,
|
|
5
|
-
CountingNumber,
|
|
6
|
-
GithubButton,
|
|
7
|
-
GradientBackground,
|
|
8
|
-
GridBackground,
|
|
9
|
-
HoverBackground,
|
|
10
|
-
Marquee,
|
|
11
|
-
ShimmeringText,
|
|
12
|
-
SlidingNumber,
|
|
13
|
-
SvgText,
|
|
14
|
-
TextReveal,
|
|
15
|
-
TypingText,
|
|
16
|
-
VideoText,
|
|
17
|
-
WordRotate,
|
|
18
|
-
githubButtonVariants
|
|
19
|
-
} from "./chunk-B3I74Y4P.js";
|
|
20
|
-
import "./chunk-FC24ZVEO.js";
|
|
21
|
-
import "./chunk-4VNS5WPM.js";
|
|
22
|
-
export {
|
|
23
|
-
AvatarGroup,
|
|
24
|
-
AvatarGroupItem,
|
|
25
|
-
AvatarGroupTooltip,
|
|
26
|
-
CountingNumber,
|
|
27
|
-
GithubButton,
|
|
28
|
-
GradientBackground,
|
|
29
|
-
GridBackground,
|
|
30
|
-
HoverBackground,
|
|
31
|
-
Marquee,
|
|
32
|
-
ShimmeringText,
|
|
33
|
-
SlidingNumber,
|
|
34
|
-
SvgText,
|
|
35
|
-
TextReveal,
|
|
36
|
-
TypingText,
|
|
37
|
-
VideoText,
|
|
38
|
-
WordRotate,
|
|
39
|
-
githubButtonVariants
|
|
40
|
-
};
|
|
1
|
+
// src/animation.ts
|
|
2
|
+
export * from "@pelatform/ui.components/animation";
|