@openway/ui 1.0.1 → 1.0.3

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.
@@ -1,6 +1,279 @@
1
1
  import { HTMLAttributes, Ref, ReactNode, RefObject } from 'react';
2
+ import { ToasterProps as ToasterProps$1, ToastT } from 'sonner';
2
3
  import { Placement } from '@floating-ui/react';
3
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
+
4
277
  type EmptySize = "sm" | "md" | "lg";
5
278
  type EmptyPresetImage = "default" | "search" | "error" | "folder" | "simple";
6
279
  type EmptyLayout = "vertical" | "horizontal";
@@ -121,9 +394,43 @@ interface SelectFilterField<TValue = unknown> {
121
394
  onChange: (val: TValue) => void;
122
395
  }) => ReactNode;
123
396
  }
397
+ interface SelectConfig {
398
+ /**
399
+ * Đánh dấu trường bắt buộc nhập (hiển thị dấu * đỏ cạnh label)
400
+ * @default false
401
+ */
402
+ isRequired?: boolean;
403
+ /**
404
+ * Trạng thái báo lỗi (viền đỏ)
405
+ * @default false
406
+ */
407
+ isInvalid?: boolean;
408
+ /**
409
+ * Trạng thái đang tải dữ liệu
410
+ * @default false
411
+ */
412
+ isLoading?: boolean;
413
+ /**
414
+ * Hiển thị biểu tượng xoay spinner khi đang ở trạng thái loading
415
+ * @default false
416
+ */
417
+ showSpinner?: boolean;
418
+ /**
419
+ * Hiển thị nút xóa nhanh nội dung khi select có giá trị
420
+ * @default false
421
+ */
422
+ isClearable?: boolean;
423
+ /**
424
+ * Mở rộng chiều rộng 100% của container chứa
425
+ * @default true
426
+ */
427
+ isFullWidth?: boolean;
428
+ }
124
429
  interface BaseSelectProps<TData = unknown, TFilters extends Record<string, unknown> = Record<string, unknown>> {
125
430
  /** Ref chuyển tiếp tới root wrapper element */
126
431
  ref?: Ref<HTMLDivElement>;
432
+ /** Cấu hình tập trung các cờ trạng thái / tính năng */
433
+ config?: SelectConfig;
127
434
  /** Kích thước: xs, sm, md, lg, xl. Mặc định 'md' */
128
435
  size?: SelectSize;
129
436
  /** Biến thể giao diện: outline, filled, ghost, other. Mặc định 'outline' */
@@ -138,7 +445,7 @@ interface BaseSelectProps<TData = unknown, TFilters extends Record<string, unkno
138
445
  id?: string;
139
446
  /** Nhãn tiêu đề của Select */
140
447
  label?: ReactNode;
141
- /** Vị trí nhãn: top, left, floating. Mặc định 'top' */
448
+ /** Vị trí nhãn: top, left, floating. Mặc định 'floating' */
142
449
  labelPlacement?: LabelPlacement;
143
450
  /** ClassName tùy biến cho nhãn */
144
451
  labelClassName?: string;
@@ -148,10 +455,6 @@ interface BaseSelectProps<TData = unknown, TFilters extends Record<string, unkno
148
455
  helperText?: ReactNode;
149
456
  /** Thông báo lỗi khi không hợp lệ */
150
457
  errorMessage?: ReactNode;
151
- /** Trạng thái không hợp lệ */
152
- isInvalid?: boolean;
153
- /** Bắt buộc chọn */
154
- isRequired?: boolean;
155
458
  /** Vô hiệu hóa Select */
156
459
  isDisabled?: boolean;
157
460
  /** Chỉ đọc, không cho phép thay đổi */
@@ -198,16 +501,14 @@ interface BaseSelectProps<TData = unknown, TFilters extends Record<string, unkno
198
501
  debounceMs?: number;
199
502
  /** Hàm custom predicate lọc options ở chế độ client */
200
503
  filterFn?: (option: SelectOptionItem<TData>, query: string, filters: TFilters) => boolean;
201
- /** Trạng thái đang tải dữ liệu */
202
- isLoading?: boolean;
203
504
  /** Văn bản hiển thị khi không có dữ liệu */
204
505
  emptyText?: ReactNode;
205
506
  /** Props tùy biến chuyển tiếp đến component Empty */
206
507
  emptyProps?: Partial<EmptyProps>;
207
- /** Hiển thị nút xoá nhanh toàn bộ giá trị đã chọn */
208
- clearable?: boolean;
209
508
  /** Render menu qua Portal để tránh bị che bởi overflow hidden. Mặc định true */
210
509
  portal?: boolean;
510
+ /** Container để gắn portal menu vào (mặc định document.body, tự động nhận diện `<dialog>` nếu Select nằm trong Modal/Confirm) */
511
+ portalRoot?: HTMLElement | null | React.RefObject<HTMLElement | null>;
211
512
  /** Vị trí hiển thị của popup dropdown. Mặc định 'bottom-start' */
212
513
  placement?: Placement;
213
514
  /** Chiều cao tối đa của vùng cuộn menu. Mặc định 280px */
@@ -231,6 +532,8 @@ interface BaseSelectProps<TData = unknown, TFilters extends Record<string, unkno
231
532
  triggerClassName?: string;
232
533
  /** ClassName cho popup dropdown menu */
233
534
  menuClassName?: string;
535
+ /** ClassName cho phần thông báo helper/error text */
536
+ helperClassName?: string;
234
537
  }
235
538
  /** Props cho component Select (Single Select) */
236
539
  interface SelectProps<TData = unknown, TFilters extends Record<string, unknown> = Record<string, unknown>> extends BaseSelectProps<TData, TFilters> {
@@ -322,4 +625,4 @@ interface UseInfiniteScrollReturn {
322
625
  */
323
626
  declare function useInfiniteScroll({ onLoadMore, hasMore, isLoading, disabled, rootMargin, threshold, root, }: UseInfiniteScrollOptions): UseInfiniteScrollReturn;
324
627
 
325
- export { type BaseSelectProps as B, type EmptyProps as E, type MultiSelectProps as M, type SelectProps as S, type UseInfiniteScrollOptions as U, type EmptyPresetImage as a, type SelectOptionItem as b, type SelectSize as c, type SelectVariant as d, type SelectColor as e, type SelectRadius as f, type SelectSearchPlacement as g, type SelectFilterField as h, type SelectFilterLayout as i, type EmptyLayout as j, type EmptySize as k, type SelectFilterType as l, type SelectSearchMode as m, type SingleSelectProps as n, type UseInfiniteScrollReturn as o, useInfiniteScroll as u };
628
+ 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 };