@openway/ui 1.0.0 → 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 +203 -181
- package/dist/chunk-X4LIYOS5.js +3 -0
- package/dist/chunk-X4LIYOS5.js.map +1 -0
- package/dist/index.cjs +5 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +2740 -1473
- package/dist/index.d.ts +2740 -1473
- package/dist/index.js +5 -1
- package/dist/index.js.map +1 -1
- package/dist/query.cjs +3 -0
- package/dist/query.cjs.map +1 -0
- package/dist/query.d.cts +431 -0
- package/dist/query.d.ts +431 -0
- package/dist/query.js +3 -0
- package/dist/query.js.map +1 -0
- package/dist/useInfiniteScroll-D9AW6cQV.d.cts +598 -0
- package/dist/useInfiniteScroll-D9AW6cQV.d.ts +598 -0
- package/docs/AGENTS.md +144 -0
- package/docs/README.md +150 -0
- package/docs/SKILL.md +54 -0
- package/docs/components/alert.md +246 -0
- package/docs/components/badge.md +238 -0
- package/docs/components/button.md +262 -0
- package/docs/components/carousel.md +354 -0
- package/docs/components/checkbox.md +252 -0
- package/docs/components/collapse.md +318 -0
- package/docs/components/confirm.md +322 -0
- package/docs/components/datepicker.md +259 -0
- package/docs/components/daterangepicker.md +260 -0
- package/docs/components/datetimepicker.md +226 -0
- package/docs/components/datetimerangepicker.md +222 -0
- package/docs/components/dropdown.md +275 -0
- package/docs/components/empty.md +200 -0
- package/docs/components/file-preview.md +180 -0
- package/docs/components/input.md +559 -0
- package/docs/components/modal.md +293 -0
- package/docs/components/popover.md +255 -0
- package/docs/components/radio.md +245 -0
- package/docs/components/select.md +254 -0
- package/docs/components/skeleton.md +150 -0
- package/docs/components/slider.md +346 -0
- package/docs/components/table.md +316 -0
- package/docs/components/tabs.md +432 -0
- package/docs/components/textarea.md +193 -0
- package/docs/components/timepicker.md +242 -0
- package/docs/components/timerangepicker.md +210 -0
- package/docs/components/toast.md +282 -0
- package/docs/components/toggle.md +211 -0
- package/docs/components/tooltip.md +213 -0
- package/docs/components/upload-avatar.md +318 -0
- package/docs/components/upload-file.md +245 -0
- package/docs/components/upload-image.md +126 -0
- package/docs/hooks/useDebounce.md +92 -0
- package/docs/hooks/useInfiniteScroll.md +95 -0
- package/docs/hooks/useMutationApp.md +242 -0
- package/docs/hooks/useSelectInfiniteQuery.md +123 -0
- package/docs/hooks/useTableQuery.md +124 -0
- package/package.json +31 -12
|
@@ -0,0 +1,598 @@
|
|
|
1
|
+
import { HTMLAttributes, Ref, ReactNode, RefObject } from 'react';
|
|
2
|
+
import { ToastT, ToasterProps as ToasterProps$1 } from 'sonner';
|
|
3
|
+
import { Placement } from '@floating-ui/react';
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Các kích cỡ tiêu chuẩn của Alert:
|
|
7
|
+
* - 'xs': Siêu nhỏ (text-xs, padding p-2)
|
|
8
|
+
* - 'sm': Nhỏ (text-xs, title text-sm, padding p-2.5)
|
|
9
|
+
* - 'md': Vừa - mặc định (text-sm, padding p-3.5)
|
|
10
|
+
* - 'lg': Lớn (text-base, padding p-4)
|
|
11
|
+
* - 'xl': Rất lớn (text-lg, padding p-5)
|
|
12
|
+
*/
|
|
13
|
+
type AlertSize = "xs" | "sm" | "md" | "lg" | "xl";
|
|
14
|
+
/**
|
|
15
|
+
* Các biến thể giao diện và phong cách hiển thị màu sắc của Alert:
|
|
16
|
+
* - 'soft': Nền nhạt pastel, viền mờ 2px, chữ đậm (mặc định)
|
|
17
|
+
* - 'filled': Nền màu đậm, chữ trắng tương phản cao
|
|
18
|
+
* - 'outline': Nền trắng, viền rõ nét theo màu chủ đề
|
|
19
|
+
* - 'accent-left': Nền pastel kèm viền nhấn dày 4px bên trái
|
|
20
|
+
* - 'ghost': Nền và viền trong suốt
|
|
21
|
+
* - 'other': Bỏ qua màu mặc định, tự do styling qua className
|
|
22
|
+
*/
|
|
23
|
+
type AlertVariant = "soft" | "filled" | "outline" | "accent-left" | "ghost" | "other";
|
|
24
|
+
/**
|
|
25
|
+
* 7 chủ đề màu sắc theo Design System:
|
|
26
|
+
* - 'primary': Màu chủ đạo
|
|
27
|
+
* - 'secondary': Màu phụ
|
|
28
|
+
* - 'neutral': Màu trung tính
|
|
29
|
+
* - 'error': Màu đỏ cảnh báo lỗi nguy cấp
|
|
30
|
+
* - 'success': Màu xanh lá thông báo thành công
|
|
31
|
+
* - 'warning': Màu vàng/cam cảnh báo
|
|
32
|
+
* - 'info': Màu xanh dương thông tin (mặc định)
|
|
33
|
+
*/
|
|
34
|
+
type AlertColor = "primary" | "secondary" | "neutral" | "error" | "success" | "warning" | "info";
|
|
35
|
+
/**
|
|
36
|
+
* Độ bo góc của khung thông báo Alert:
|
|
37
|
+
* - 'none': Góc vuông phẳng (rounded-none)
|
|
38
|
+
* - 'sm': Bo góc nhỏ (rounded-sm)
|
|
39
|
+
* - 'md': Bo góc vừa (rounded-md)
|
|
40
|
+
* - 'lg': Bo góc lớn (rounded-lg - mặc định)
|
|
41
|
+
* - 'xl': Bo góc rất lớn (rounded-xl)
|
|
42
|
+
* - 'full': Bo tròn hoàn toàn (rounded-2xl)
|
|
43
|
+
*/
|
|
44
|
+
type AlertRadius = "none" | "sm" | "md" | "lg" | "xl" | "full";
|
|
45
|
+
/**
|
|
46
|
+
* Props cho component `Alert`.
|
|
47
|
+
*/
|
|
48
|
+
interface AlertProps extends Omit<HTMLAttributes<HTMLDivElement>, "title"> {
|
|
49
|
+
/**
|
|
50
|
+
* Ref chuyển tiếp đến phần tử HTML div của Alert
|
|
51
|
+
*/
|
|
52
|
+
ref?: Ref<HTMLDivElement>;
|
|
53
|
+
/**
|
|
54
|
+
* Kích cỡ của Alert (5 sizes: xs, sm, md, lg, xl)
|
|
55
|
+
* @default 'md'
|
|
56
|
+
*/
|
|
57
|
+
size?: AlertSize;
|
|
58
|
+
/**
|
|
59
|
+
* Biến thể giao diện của Alert:
|
|
60
|
+
* - 'soft': nền nhạt pastel, viền mờ, chữ đậm tương ứng (mặc định)
|
|
61
|
+
* - 'filled': nền màu đậm, chữ tương phản cao
|
|
62
|
+
* - 'outline': nền trắng, viền rõ nét theo màu chủ đề
|
|
63
|
+
* - 'accent-left': viền nhấn dày bên trái, nền pastel
|
|
64
|
+
* - 'ghost': nền và viền trong suốt
|
|
65
|
+
* - 'other': không áp dụng style màu mặc định, tự do tùy biến qua className
|
|
66
|
+
* @default 'soft'
|
|
67
|
+
*/
|
|
68
|
+
variant?: AlertVariant;
|
|
69
|
+
/**
|
|
70
|
+
* Chủ đề màu sắc (primary, secondary, neutral, error, success, warning, info)
|
|
71
|
+
* @default 'info'
|
|
72
|
+
*/
|
|
73
|
+
color?: AlertColor;
|
|
74
|
+
/**
|
|
75
|
+
* Tùy chỉnh độ bo góc:
|
|
76
|
+
* - 'none': góc vuông 0px
|
|
77
|
+
* - 'sm': bo góc nhỏ
|
|
78
|
+
* - 'md': bo góc vừa
|
|
79
|
+
* - 'lg': bo góc lớn (mặc định)
|
|
80
|
+
* - 'xl': bo góc rất lớn
|
|
81
|
+
* - 'full': bo tròn hoàn toàn
|
|
82
|
+
* @default 'lg'
|
|
83
|
+
*/
|
|
84
|
+
radius?: AlertRadius;
|
|
85
|
+
/**
|
|
86
|
+
* Tiêu đề của Alert
|
|
87
|
+
*/
|
|
88
|
+
title?: ReactNode;
|
|
89
|
+
/**
|
|
90
|
+
* Nội dung mô tả chi tiết của Alert (có thể truyền qua prop description hoặc children)
|
|
91
|
+
*/
|
|
92
|
+
description?: ReactNode;
|
|
93
|
+
/**
|
|
94
|
+
* Icon hiển thị ở đầu thông báo:
|
|
95
|
+
* - `true` (hoặc không truyền): tự động hiển thị icon theo `color`
|
|
96
|
+
* - `false`: ẩn icon
|
|
97
|
+
* - `ReactNode`: icon tùy chỉnh
|
|
98
|
+
* @default true
|
|
99
|
+
*/
|
|
100
|
+
icon?: ReactNode | boolean;
|
|
101
|
+
/**
|
|
102
|
+
* Phần tử hành động phụ (Action slot, ví dụ: Nút bấm, liên kết thao tác)
|
|
103
|
+
*/
|
|
104
|
+
action?: ReactNode;
|
|
105
|
+
/**
|
|
106
|
+
* Hiển thị nút đóng (Close button x) để người dùng có thể tắt thông báo. Tự động ẩn Alert khi click.
|
|
107
|
+
* @default true
|
|
108
|
+
*/
|
|
109
|
+
closable?: boolean;
|
|
110
|
+
/**
|
|
111
|
+
* Callback khi người dùng bấm nút đóng
|
|
112
|
+
*/
|
|
113
|
+
onClose?: () => void;
|
|
114
|
+
/**
|
|
115
|
+
* Nhãn accessibility cho nút đóng
|
|
116
|
+
* @default 'Close alert'
|
|
117
|
+
*/
|
|
118
|
+
closeAriaLabel?: string;
|
|
119
|
+
/**
|
|
120
|
+
* Chế độ Banner: Full width, không bo góc (`rounded-none`), không viền 2 bên (`border-x-0`), thích hợp gắn cố định trên cùng màn hình
|
|
121
|
+
* @default false
|
|
122
|
+
*/
|
|
123
|
+
banner?: boolean;
|
|
124
|
+
/**
|
|
125
|
+
* Class tùy biến cho phần tiêu đề (title)
|
|
126
|
+
*/
|
|
127
|
+
titleClassName?: string;
|
|
128
|
+
/**
|
|
129
|
+
* Class tùy biến cho phần nội dung mô tả (description / children)
|
|
130
|
+
*/
|
|
131
|
+
descriptionClassName?: string;
|
|
132
|
+
/**
|
|
133
|
+
* Class tùy biến cho vùng action slot
|
|
134
|
+
*/
|
|
135
|
+
actionClassName?: string;
|
|
136
|
+
/**
|
|
137
|
+
* Class tùy biến cho icon wrapper
|
|
138
|
+
*/
|
|
139
|
+
iconClassName?: string;
|
|
140
|
+
/**
|
|
141
|
+
* Class tùy biến cho nút đóng
|
|
142
|
+
*/
|
|
143
|
+
closeButtonClassName?: string;
|
|
144
|
+
/**
|
|
145
|
+
* Class tùy biến cho container bao ngoài
|
|
146
|
+
*/
|
|
147
|
+
className?: string;
|
|
148
|
+
/**
|
|
149
|
+
* Nội dung tùy biến bên trong Alert
|
|
150
|
+
*/
|
|
151
|
+
children?: ReactNode;
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
/**
|
|
155
|
+
* Vị trí hiển thị của danh sách thông báo Toast trên màn hình.
|
|
156
|
+
*/
|
|
157
|
+
type ToastPosition = "top-left" | "top-right" | "top-center" | "bottom-left" | "bottom-right" | "bottom-center";
|
|
158
|
+
/**
|
|
159
|
+
* Cấu hình tùy chọn cho từng thông báo Toast đơn lẻ:
|
|
160
|
+
* - Dạng gọi hàm chuẩn: `toast.success(title, description?, options?)`
|
|
161
|
+
*/
|
|
162
|
+
interface ToastOptions extends Omit<AlertProps, "title" | "description"> {
|
|
163
|
+
/**
|
|
164
|
+
* Thời gian hiển thị thông báo trước khi tự động đóng (miliseconds). Mặc định 4000ms.
|
|
165
|
+
* @default 4000
|
|
166
|
+
*/
|
|
167
|
+
duration?: number;
|
|
168
|
+
/**
|
|
169
|
+
* Vị trí hiển thị riêng cho thông báo này trên màn hình.
|
|
170
|
+
*/
|
|
171
|
+
position?: ToastPosition;
|
|
172
|
+
/**
|
|
173
|
+
* Callback được gọi khi thông báo bị đóng/gỡ bỏ khỏi màn hình.
|
|
174
|
+
*/
|
|
175
|
+
onDismiss?: (toast: ToastT) => void;
|
|
176
|
+
/**
|
|
177
|
+
* Callback được gọi khi thông báo tự động đóng do hết thời gian duration.
|
|
178
|
+
*/
|
|
179
|
+
onAutoClose?: (toast: ToastT) => void;
|
|
180
|
+
}
|
|
181
|
+
/**
|
|
182
|
+
* Cấu trúc thông báo dạng Object chi tiết cho `toast.promise`.
|
|
183
|
+
*/
|
|
184
|
+
interface ToastMessageObject {
|
|
185
|
+
title?: ReactNode;
|
|
186
|
+
description?: ReactNode;
|
|
187
|
+
color?: AlertColor;
|
|
188
|
+
variant?: AlertVariant;
|
|
189
|
+
}
|
|
190
|
+
/**
|
|
191
|
+
* Kiểu dữ liệu linh hoạt cho nội dung thông báo trả về trong `toast.promise`:
|
|
192
|
+
* - `ReactNode`: Chuỗi text hoặc phần tử JSX thông thường.
|
|
193
|
+
* - `ToastMessageObject`: Object chi tiết gồm `{ title, description, color, variant }`.
|
|
194
|
+
*/
|
|
195
|
+
type ToastMessageResult = ReactNode | ToastMessageObject;
|
|
196
|
+
/**
|
|
197
|
+
* Hàm tạo nội dung thông báo thành công động dựa theo dữ liệu `data: T` trả về từ Promise.
|
|
198
|
+
*/
|
|
199
|
+
type ToastPromiseFunction<T> = (data: T) => ToastMessageResult;
|
|
200
|
+
/**
|
|
201
|
+
* Cấu hình các trạng thái cho `toast.promise(promise, options)`.
|
|
202
|
+
*/
|
|
203
|
+
interface ToastPromiseOptions<T = unknown> {
|
|
204
|
+
/**
|
|
205
|
+
* Nội dung hiển thị trong lúc Promise đang thực thi (Loading state).
|
|
206
|
+
*/
|
|
207
|
+
loading: ToastMessageResult;
|
|
208
|
+
/**
|
|
209
|
+
* Nội dung hiển thị khi Promise thực thi thành công (Resolve state).
|
|
210
|
+
* Có thể truyền trực tiếp nội dung hoặc một hàm nhận `data: T`.
|
|
211
|
+
*/
|
|
212
|
+
success: ToastMessageResult | ToastPromiseFunction<T>;
|
|
213
|
+
/**
|
|
214
|
+
* Nội dung hiển thị khi Promise gặp lỗi (Reject state).
|
|
215
|
+
* Có thể truyền trực tiếp nội dung hoặc một hàm nhận `error: unknown`.
|
|
216
|
+
*/
|
|
217
|
+
error: ToastMessageResult | ((error: unknown) => ToastMessageResult);
|
|
218
|
+
/**
|
|
219
|
+
* Callback chạy sau khi Promise hoàn tất (cả khi resolve hoặc reject).
|
|
220
|
+
*/
|
|
221
|
+
finally?: () => void | Promise<void>;
|
|
222
|
+
/**
|
|
223
|
+
* Thời gian hiển thị thông báo kết quả (ms). Mặc định 4000ms.
|
|
224
|
+
* @default 4000
|
|
225
|
+
*/
|
|
226
|
+
duration?: number;
|
|
227
|
+
/**
|
|
228
|
+
* Kích cỡ của Alert hiển thị trong Toast.
|
|
229
|
+
*/
|
|
230
|
+
size?: AlertSize;
|
|
231
|
+
/**
|
|
232
|
+
* Biến thể giao diện của Alert hiển thị trong Toast.
|
|
233
|
+
*/
|
|
234
|
+
variant?: AlertVariant;
|
|
235
|
+
/**
|
|
236
|
+
* Tùy chỉnh độ bo góc của Alert hiển thị trong Toast.
|
|
237
|
+
*/
|
|
238
|
+
radius?: AlertRadius;
|
|
239
|
+
}
|
|
240
|
+
/**
|
|
241
|
+
* Props cho component `<Toaster />` được mount tại root layout của ứng dụng.
|
|
242
|
+
*/
|
|
243
|
+
interface ToasterProps extends ToasterProps$1 {
|
|
244
|
+
/**
|
|
245
|
+
* Vị trí mặc định của toàn bộ danh sách toasts trên màn hình.
|
|
246
|
+
* @default 'top-right'
|
|
247
|
+
*/
|
|
248
|
+
position?: ToastPosition;
|
|
249
|
+
/**
|
|
250
|
+
* Số lượng toast tối đa hiển thị cùng lúc trước khi tự động xếp chồng 3D (stack).
|
|
251
|
+
* @default 3
|
|
252
|
+
*/
|
|
253
|
+
visibleToasts?: number;
|
|
254
|
+
/**
|
|
255
|
+
* Mở rộng toàn bộ danh sách toasts thay vì gộp lại thành 1 stack 3D.
|
|
256
|
+
* - `false` (mặc định): Tự động gộp thẻ 3D, chỉ bung ra khi hover chuột.
|
|
257
|
+
* - `true`: Luôn luôn mở rộng trải dài toàn bộ danh sách.
|
|
258
|
+
* @default false
|
|
259
|
+
*/
|
|
260
|
+
expand?: boolean;
|
|
261
|
+
/**
|
|
262
|
+
* Thời gian hiển thị mặc định của các toasts (miliseconds).
|
|
263
|
+
* @default 4000
|
|
264
|
+
*/
|
|
265
|
+
duration?: number;
|
|
266
|
+
/**
|
|
267
|
+
* Cho phép hiển thị nút đóng `(X)` trên các toasts.
|
|
268
|
+
* @default true
|
|
269
|
+
*/
|
|
270
|
+
closeButton?: boolean;
|
|
271
|
+
/**
|
|
272
|
+
* Tùy biến className bao ngoài container của Toaster.
|
|
273
|
+
*/
|
|
274
|
+
className?: string;
|
|
275
|
+
}
|
|
276
|
+
|
|
277
|
+
type EmptySize = "sm" | "md" | "lg";
|
|
278
|
+
type EmptyPresetImage = "default" | "search" | "error" | "folder" | "simple";
|
|
279
|
+
type EmptyLayout = "vertical" | "horizontal";
|
|
280
|
+
interface EmptyProps extends Omit<HTMLAttributes<HTMLDivElement>, "title"> {
|
|
281
|
+
/**
|
|
282
|
+
* Ref chuyển tiếp đến phần tử HTML div
|
|
283
|
+
*/
|
|
284
|
+
ref?: Ref<HTMLDivElement>;
|
|
285
|
+
/**
|
|
286
|
+
* Kích cỡ của Empty component:
|
|
287
|
+
* - 'sm': Nhỏ gọn, thích hợp cho dropdown, popover, bảng nhỏ
|
|
288
|
+
* - 'md': Tiêu chuẩn, thích hợp cho card, section, modal
|
|
289
|
+
* - 'lg': Lớn, thích hợp cho toàn trang, dashboard
|
|
290
|
+
* @default 'md'
|
|
291
|
+
*/
|
|
292
|
+
size?: EmptySize;
|
|
293
|
+
/**
|
|
294
|
+
* Bố cục hiển thị:
|
|
295
|
+
* - 'vertical': Xếp dọc ảnh -> tiêu đề -> mô tả -> hành động
|
|
296
|
+
* - 'horizontal': Dàn ngang ảnh bên trái, nội dung & hành động bên phải
|
|
297
|
+
* @default 'vertical'
|
|
298
|
+
*/
|
|
299
|
+
layout?: EmptyLayout;
|
|
300
|
+
/**
|
|
301
|
+
* Ảnh hoặc minh họa:
|
|
302
|
+
* - Tên preset: 'default' | 'search' | 'error' | 'folder' | 'simple'
|
|
303
|
+
* - URL hình ảnh (string bắt đầu bằng http://, https://, /, hoặc ./)
|
|
304
|
+
* - ReactNode tùy biến (SVG icon, custom component, v.v.)
|
|
305
|
+
* @default 'default'
|
|
306
|
+
*/
|
|
307
|
+
image?: EmptyPresetImage | (string & {}) | ReactNode;
|
|
308
|
+
/**
|
|
309
|
+
* Kích thước tùy chỉnh cho ảnh / illustration (pixel hoặc chuỗi kích thước CSS)
|
|
310
|
+
*/
|
|
311
|
+
imageSize?: number | string;
|
|
312
|
+
/**
|
|
313
|
+
* Class tùy biến cho phần bao ngoài của ảnh
|
|
314
|
+
*/
|
|
315
|
+
imageClassName?: string;
|
|
316
|
+
/**
|
|
317
|
+
* Thuộc tính alt cho hình ảnh khi truyền URL
|
|
318
|
+
* @default 'Empty'
|
|
319
|
+
*/
|
|
320
|
+
imageAlt?: string;
|
|
321
|
+
/**
|
|
322
|
+
* Tiêu đề của trạng thái rỗng
|
|
323
|
+
*/
|
|
324
|
+
title?: ReactNode;
|
|
325
|
+
/**
|
|
326
|
+
* Class tùy biến cho tiêu đề
|
|
327
|
+
*/
|
|
328
|
+
titleClassName?: string;
|
|
329
|
+
/**
|
|
330
|
+
* Đoạn văn bản mô tả chi tiết hoặc hướng dẫn thao tác
|
|
331
|
+
*/
|
|
332
|
+
description?: ReactNode;
|
|
333
|
+
/**
|
|
334
|
+
* Class tùy biến cho phần mô tả
|
|
335
|
+
*/
|
|
336
|
+
descriptionClassName?: string;
|
|
337
|
+
/**
|
|
338
|
+
* Nút bấm hoặc nhóm hành động bên dưới (Call-to-Action)
|
|
339
|
+
*/
|
|
340
|
+
actions?: ReactNode;
|
|
341
|
+
/**
|
|
342
|
+
* Class tùy biến cho khu vực chứa actions
|
|
343
|
+
*/
|
|
344
|
+
actionsClassName?: string;
|
|
345
|
+
/**
|
|
346
|
+
* Nội dung bổ sung tùy biến bên dưới hoặc thay thế
|
|
347
|
+
*/
|
|
348
|
+
children?: ReactNode;
|
|
349
|
+
}
|
|
350
|
+
|
|
351
|
+
type SelectSize = "xs" | "sm" | "md" | "lg" | "xl";
|
|
352
|
+
type SelectVariant = "outline" | "filled" | "ghost" | "other";
|
|
353
|
+
type SelectColor = "primary" | "secondary" | "error" | "success" | "warning" | "info" | "neutral";
|
|
354
|
+
type SelectRadius = "none" | "sm" | "md" | "lg" | "xl" | "full";
|
|
355
|
+
type SelectSearchMode = "client" | "server";
|
|
356
|
+
type SelectSearchPlacement = "trigger" | "menu" | "both";
|
|
357
|
+
type SelectFilterLayout = "vertical" | "grid";
|
|
358
|
+
type LabelPlacement = "top" | "left" | "floating";
|
|
359
|
+
interface SelectOptionItem<TData = unknown> {
|
|
360
|
+
value: string | number;
|
|
361
|
+
label: string;
|
|
362
|
+
disabled?: boolean;
|
|
363
|
+
description?: ReactNode;
|
|
364
|
+
icon?: ReactNode;
|
|
365
|
+
data?: TData;
|
|
366
|
+
}
|
|
367
|
+
type SelectFilterType = "string" | "text" | "number" | "date" | "date-range" | "checkbox-group" | "custom";
|
|
368
|
+
interface SelectFilterField<TValue = unknown> {
|
|
369
|
+
/** Tên định danh trường lọc (dùng làm key trong object filters) */
|
|
370
|
+
name: string;
|
|
371
|
+
/** Loại component lọc */
|
|
372
|
+
type: SelectFilterType;
|
|
373
|
+
/** Nhãn hiển thị của bộ lọc */
|
|
374
|
+
label?: ReactNode;
|
|
375
|
+
/** Placeholder cho input */
|
|
376
|
+
placeholder?: string;
|
|
377
|
+
/** Giá trị mặc định */
|
|
378
|
+
defaultValue?: TValue;
|
|
379
|
+
/** Giá trị điều khiển */
|
|
380
|
+
value?: TValue;
|
|
381
|
+
/** Số cột chiếm trong grid layout (1, 2, 3...) */
|
|
382
|
+
colSpan?: number;
|
|
383
|
+
/** Danh sách options (dùng cho checkbox-group hoặc select con) */
|
|
384
|
+
options?: {
|
|
385
|
+
label: ReactNode;
|
|
386
|
+
value: string | number;
|
|
387
|
+
disabled?: boolean;
|
|
388
|
+
}[];
|
|
389
|
+
/** Props truyền thêm vào component tương ứng (InputProps, DatePickerProps, ...) */
|
|
390
|
+
props?: Record<string, unknown>;
|
|
391
|
+
/** Custom render khi type="custom" */
|
|
392
|
+
render?: (fieldState: {
|
|
393
|
+
value: TValue | undefined;
|
|
394
|
+
onChange: (val: TValue) => void;
|
|
395
|
+
}) => ReactNode;
|
|
396
|
+
}
|
|
397
|
+
interface BaseSelectProps<TData = unknown, TFilters extends Record<string, unknown> = Record<string, unknown>> {
|
|
398
|
+
/** Ref chuyển tiếp tới root wrapper element */
|
|
399
|
+
ref?: Ref<HTMLDivElement>;
|
|
400
|
+
/** Kích thước: xs, sm, md, lg, xl. Mặc định 'md' */
|
|
401
|
+
size?: SelectSize;
|
|
402
|
+
/** Biến thể giao diện: outline, filled, ghost, other. Mặc định 'outline' */
|
|
403
|
+
variant?: SelectVariant;
|
|
404
|
+
/** Chủ đề màu sắc: primary, secondary, error, success, warning, info, neutral. Mặc định 'primary' */
|
|
405
|
+
color?: SelectColor;
|
|
406
|
+
/** Độ bo góc: none, sm, md, lg, xl, full */
|
|
407
|
+
radius?: SelectRadius;
|
|
408
|
+
/** Danh sách các tùy chọn */
|
|
409
|
+
options: SelectOptionItem<TData>[];
|
|
410
|
+
/** ID định danh cho Select */
|
|
411
|
+
id?: string;
|
|
412
|
+
/** Nhãn tiêu đề của Select */
|
|
413
|
+
label?: ReactNode;
|
|
414
|
+
/** Vị trí nhãn: top, left, floating. Mặc định 'top' */
|
|
415
|
+
labelPlacement?: LabelPlacement;
|
|
416
|
+
/** ClassName tùy biến cho nhãn */
|
|
417
|
+
labelClassName?: string;
|
|
418
|
+
/** Văn bản gợi ý khi chưa chọn */
|
|
419
|
+
placeholder?: string;
|
|
420
|
+
/** Văn bản hướng dẫn bên dưới */
|
|
421
|
+
helperText?: ReactNode;
|
|
422
|
+
/** Thông báo lỗi khi không hợp lệ */
|
|
423
|
+
errorMessage?: ReactNode;
|
|
424
|
+
/** Trạng thái không hợp lệ */
|
|
425
|
+
isInvalid?: boolean;
|
|
426
|
+
/** Bắt buộc chọn */
|
|
427
|
+
isRequired?: boolean;
|
|
428
|
+
/** Vô hiệu hóa Select */
|
|
429
|
+
isDisabled?: boolean;
|
|
430
|
+
/** Chỉ đọc, không cho phép thay đổi */
|
|
431
|
+
readOnly?: boolean;
|
|
432
|
+
/** Tên trường form HTML để submit */
|
|
433
|
+
name?: string;
|
|
434
|
+
/** Cho phép tìm kiếm. Mặc định false */
|
|
435
|
+
searchable?: boolean;
|
|
436
|
+
/** Chế độ tìm kiếm: 'client' (fuzzy search) hoặc 'server' (debounce + API). Mặc định 'client' */
|
|
437
|
+
searchMode?: SelectSearchMode;
|
|
438
|
+
/** Vị trí ô tìm kiếm: 'trigger' (trên trigger), 'menu' (trong dropdown), 'both'. Mặc định 'trigger' */
|
|
439
|
+
searchPlacement?: SelectSearchPlacement;
|
|
440
|
+
/** Placeholder cho ô tìm kiếm */
|
|
441
|
+
searchPlaceholder?: string;
|
|
442
|
+
/** Trường dùng để tìm kiếm (mặc định ['label', 'value']), hỗ trợ string, mảng hoặc hàm accessor tương tự CheckboxGroup */
|
|
443
|
+
searchField?: (keyof SelectOptionItem<TData> | string | ((item: SelectOptionItem<TData>) => string | undefined | null))[] | (keyof SelectOptionItem<TData> | string);
|
|
444
|
+
/** Giá trị từ khóa tìm kiếm (khi controlled) */
|
|
445
|
+
searchValue?: string;
|
|
446
|
+
/** Callback khi từ khóa thay đổi */
|
|
447
|
+
onSearchChange?: (value: string) => void;
|
|
448
|
+
/** Cấu hình danh sách các bộ lọc hiển thị bên trong dropdown menu */
|
|
449
|
+
menuFilters?: SelectFilterField<unknown>[];
|
|
450
|
+
/** Giá trị điều khiển cho các bộ lọc trong menu */
|
|
451
|
+
menuFilterValues?: Partial<TFilters>;
|
|
452
|
+
/** Bố cục danh sách bộ lọc: 'vertical' hoặc 'grid'. Mặc định 'vertical' */
|
|
453
|
+
menuFilterLayout?: SelectFilterLayout;
|
|
454
|
+
/** Số cột khi menuFilterLayout='grid'. Mặc định 2 */
|
|
455
|
+
menuFilterGridCols?: number;
|
|
456
|
+
/** Hiển thị nút Reset / Xóa bộ lọc. Mặc định true khi có menuFilters */
|
|
457
|
+
showResetFilters?: boolean;
|
|
458
|
+
/** Văn bản nút Reset bộ lọc. Mặc định 'Xoá bộ lọc' */
|
|
459
|
+
resetFiltersText?: ReactNode;
|
|
460
|
+
/** Callback khi bất kỳ filter nào trong menu thay đổi */
|
|
461
|
+
onMenuFilterChange?: (filters: TFilters) => void;
|
|
462
|
+
/** Nội dung tùy biến trên đầu menu (trước hoặc thay thế filter) */
|
|
463
|
+
menuHeader?: ReactNode;
|
|
464
|
+
/** Nội dung tùy biến dưới đáy menu */
|
|
465
|
+
menuFooter?: ReactNode;
|
|
466
|
+
/** Nội dung tùy biến ở đáy danh sách tùy chọn bên trong vùng cuộn (ví dụ: Sentinel/Skeleton/Spinner khi phân trang Infinite Scroll) */
|
|
467
|
+
listFooter?: ReactNode;
|
|
468
|
+
/** Callback được gọi sau khi debounce khi search query hoặc menu filters thay đổi (ở Server mode) */
|
|
469
|
+
onSearch?: (query: string, filters: TFilters) => void | Promise<void>;
|
|
470
|
+
/** Thời gian trì hoãn debounce tính theo ms. Mặc định 300 */
|
|
471
|
+
debounceMs?: number;
|
|
472
|
+
/** Hàm custom predicate lọc options ở chế độ client */
|
|
473
|
+
filterFn?: (option: SelectOptionItem<TData>, query: string, filters: TFilters) => boolean;
|
|
474
|
+
/** Trạng thái đang tải dữ liệu */
|
|
475
|
+
isLoading?: boolean;
|
|
476
|
+
/** Văn bản hiển thị khi không có dữ liệu */
|
|
477
|
+
emptyText?: ReactNode;
|
|
478
|
+
/** Props tùy biến chuyển tiếp đến component Empty */
|
|
479
|
+
emptyProps?: Partial<EmptyProps>;
|
|
480
|
+
/** Hiển thị nút xoá nhanh toàn bộ giá trị đã chọn */
|
|
481
|
+
clearable?: boolean;
|
|
482
|
+
/** Render menu qua Portal để tránh bị che bởi overflow hidden. Mặc định true */
|
|
483
|
+
portal?: boolean;
|
|
484
|
+
/** Vị trí hiển thị của popup dropdown. Mặc định 'bottom-start' */
|
|
485
|
+
placement?: Placement;
|
|
486
|
+
/** Chiều cao tối đa của vùng cuộn menu. Mặc định 280px */
|
|
487
|
+
maxMenuHeight?: number | string;
|
|
488
|
+
/** Bật/tắt animation khi dropdown menu xuất hiện/biến mất. Mặc định true */
|
|
489
|
+
animated?: boolean;
|
|
490
|
+
/** Thời lượng hiệu ứng tính bằng mili-giây (ms). Mặc định 150 */
|
|
491
|
+
animationDuration?: number;
|
|
492
|
+
/** Icon hoặc nội dung ở đầu trigger */
|
|
493
|
+
startContent?: ReactNode;
|
|
494
|
+
/** Icon hoặc nội dung ở cuối trigger */
|
|
495
|
+
endContent?: ReactNode;
|
|
496
|
+
/** Tùy biến render từng option trong menu */
|
|
497
|
+
renderOption?: (option: SelectOptionItem<TData>, state: {
|
|
498
|
+
selected: boolean;
|
|
499
|
+
active: boolean;
|
|
500
|
+
}) => ReactNode;
|
|
501
|
+
/** ClassName tùy biến cho wrapper ngoài cùng */
|
|
502
|
+
className?: string;
|
|
503
|
+
/** ClassName cho phần trigger box */
|
|
504
|
+
triggerClassName?: string;
|
|
505
|
+
/** ClassName cho popup dropdown menu */
|
|
506
|
+
menuClassName?: string;
|
|
507
|
+
}
|
|
508
|
+
/** Props cho component Select (Single Select) */
|
|
509
|
+
interface SelectProps<TData = unknown, TFilters extends Record<string, unknown> = Record<string, unknown>> extends BaseSelectProps<TData, TFilters> {
|
|
510
|
+
/** Giá trị đã chọn (controlled) */
|
|
511
|
+
value?: string | number | null;
|
|
512
|
+
/** Giá trị mặc định ban đầu (uncontrolled) */
|
|
513
|
+
defaultValue?: string | number | null;
|
|
514
|
+
/** Callback khi giá trị thay đổi */
|
|
515
|
+
onChange?: (value: string | number | null, option?: SelectOptionItem<TData> | null) => void;
|
|
516
|
+
/** Tùy biến render giá trị hiển thị trên trigger */
|
|
517
|
+
renderValue?: (selected: SelectOptionItem<TData>) => ReactNode;
|
|
518
|
+
}
|
|
519
|
+
/** Alias cho SelectProps */
|
|
520
|
+
type SingleSelectProps<TData = unknown, TFilters extends Record<string, unknown> = Record<string, unknown>> = SelectProps<TData, TFilters>;
|
|
521
|
+
/** Props cho component MultiSelect */
|
|
522
|
+
interface MultiSelectProps<TData = unknown, TFilters extends Record<string, unknown> = Record<string, unknown>> extends BaseSelectProps<TData, TFilters> {
|
|
523
|
+
/** Danh sách giá trị đã chọn (controlled) */
|
|
524
|
+
value?: (string | number)[];
|
|
525
|
+
/** Danh sách giá trị mặc định ban đầu (uncontrolled) */
|
|
526
|
+
defaultValue?: (string | number)[];
|
|
527
|
+
/** Callback khi giá trị thay đổi */
|
|
528
|
+
onChange?: (values: (string | number)[], options?: SelectOptionItem<TData>[]) => void;
|
|
529
|
+
/** Giới hạn số lượng tag Badge hiển thị trước khi gom thành +N */
|
|
530
|
+
maxTagCount?: number;
|
|
531
|
+
/** Tự động ghim bảo lưu các mục đã chọn khi tìm kiếm (tương tự CheckboxGroup). Mặc định true */
|
|
532
|
+
preserveSelected?: boolean;
|
|
533
|
+
/** Tùy biến render giá trị hiển thị trên trigger */
|
|
534
|
+
renderValue?: (selected: SelectOptionItem<TData>[]) => ReactNode;
|
|
535
|
+
}
|
|
536
|
+
|
|
537
|
+
/**
|
|
538
|
+
* Các tùy chọn cấu hình cho hook `useInfiniteScroll`.
|
|
539
|
+
*/
|
|
540
|
+
interface UseInfiniteScrollOptions {
|
|
541
|
+
/**
|
|
542
|
+
* Callback được gọi khi người dùng cuộn đến cuối hoặc phần tử sentinel xuất hiện trong tầm nhìn.
|
|
543
|
+
*/
|
|
544
|
+
onLoadMore: () => void | Promise<void>;
|
|
545
|
+
/**
|
|
546
|
+
* Cho biết còn dữ liệu để tải tiếp hay không.
|
|
547
|
+
* Nếu là `false`, `onLoadMore` sẽ không được kích hoạt.
|
|
548
|
+
* @default true
|
|
549
|
+
*/
|
|
550
|
+
hasMore?: boolean;
|
|
551
|
+
/**
|
|
552
|
+
* Trạng thái đang tải dữ liệu của trang hiện tại / tiếp theo.
|
|
553
|
+
* Nếu là `true`, `onLoadMore` sẽ tạm hoãn cho đến khi lượt tải trước hoàn tất.
|
|
554
|
+
* @default false
|
|
555
|
+
*/
|
|
556
|
+
isLoading?: boolean;
|
|
557
|
+
/**
|
|
558
|
+
* Vô hiệu hóa toàn bộ cơ chế theo dõi cuộn vô hạn.
|
|
559
|
+
* @default false
|
|
560
|
+
*/
|
|
561
|
+
disabled?: boolean;
|
|
562
|
+
/**
|
|
563
|
+
* Khoảng cách biên rootMargin của IntersectionObserver (vd: "100px", "0px 0px 100px 0px").
|
|
564
|
+
* Giúp kích hoạt tải trước khi người dùng chạm tới đáy danh sách để trải nghiệm mượt mà hơn.
|
|
565
|
+
* @default "100px"
|
|
566
|
+
*/
|
|
567
|
+
rootMargin?: string;
|
|
568
|
+
/**
|
|
569
|
+
* Ngưỡng hiển thị threshold của IntersectionObserver (từ 0.0 đến 1.0).
|
|
570
|
+
* @default 0
|
|
571
|
+
*/
|
|
572
|
+
threshold?: number | number[];
|
|
573
|
+
/**
|
|
574
|
+
* Phần tử gốc hoặc RefObject làm khung cuộn cho IntersectionObserver.
|
|
575
|
+
* Nếu là `null` hoặc `undefined`, sẽ dùng viewport của trình duyệt hoặc khung cuộn cha gần nhất.
|
|
576
|
+
* @default null
|
|
577
|
+
*/
|
|
578
|
+
root?: Element | null | RefObject<Element | null>;
|
|
579
|
+
}
|
|
580
|
+
/**
|
|
581
|
+
* Kết quả trả về từ hook `useInfiniteScroll`.
|
|
582
|
+
*/
|
|
583
|
+
interface UseInfiniteScrollReturn {
|
|
584
|
+
/**
|
|
585
|
+
* Ref callback gắn vào phần tử sentinel ở cuối danh sách để theo dõi bằng IntersectionObserver.
|
|
586
|
+
*/
|
|
587
|
+
sentinelRef: (node: HTMLElement | null) => void;
|
|
588
|
+
/**
|
|
589
|
+
* Trạng thái phần tử sentinel có đang nằm trong tầm quan sát hay không.
|
|
590
|
+
*/
|
|
591
|
+
isIntersecting: boolean;
|
|
592
|
+
}
|
|
593
|
+
/**
|
|
594
|
+
* Hook `useInfiniteScroll` độc lập hỗ trợ tải dữ liệu vô tận qua IntersectionObserver.
|
|
595
|
+
*/
|
|
596
|
+
declare function useInfiniteScroll({ onLoadMore, hasMore, isLoading, disabled, rootMargin, threshold, root, }: UseInfiniteScrollOptions): UseInfiniteScrollReturn;
|
|
597
|
+
|
|
598
|
+
export { type AlertProps as A, type BaseSelectProps as B, type EmptyProps as E, type MultiSelectProps as M, type SelectProps as S, type ToasterProps as T, type UseInfiniteScrollOptions as U, type ToastOptions as a, type ToastPromiseOptions as b, type EmptyPresetImage as c, type SelectOptionItem as d, type SelectSize as e, type SelectVariant as f, type SelectColor as g, type SelectRadius as h, type SelectSearchPlacement as i, type SelectFilterField as j, type SelectFilterLayout as k, type AlertColor as l, type AlertRadius as m, type AlertSize as n, type AlertVariant as o, type EmptyLayout as p, type EmptySize as q, type SelectFilterType as r, type SelectSearchMode as s, type SingleSelectProps as t, type ToastMessageObject as u, type ToastMessageResult as v, type ToastPosition as w, type ToastPromiseFunction as x, type UseInfiniteScrollReturn as y, useInfiniteScroll as z };
|