solid-tom-ui 1.0.11 → 1.0.15

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.
Files changed (119) hide show
  1. package/README.md +246 -246
  2. package/dist/README.md +246 -246
  3. package/dist/components/avatar/avatar.js.map +1 -1
  4. package/dist/components/badge/badge.js.map +1 -1
  5. package/dist/components/breadcrumb/breadcrumb.js.map +1 -1
  6. package/dist/components/button/button.js.map +1 -1
  7. package/dist/components/carousel/carousel.js.map +1 -1
  8. package/dist/components/chat-bubble/chatBubble.js.map +1 -1
  9. package/dist/components/checkbox/checkbox.js.map +1 -1
  10. package/dist/components/collapse/collapse.js.map +1 -1
  11. package/dist/components/context-menu/context-menu.js.map +1 -1
  12. package/dist/components/context-menu/context-menu.store.js.map +1 -1
  13. package/dist/components/divider/divider.js.map +1 -1
  14. package/dist/components/dropdown/dropdown.js.map +1 -1
  15. package/dist/components/dropdown/dropdown.store.js.map +1 -1
  16. package/dist/components/float-button/float-button.js.map +1 -1
  17. package/dist/components/hover-3d-image/hover-3d-image.js.map +1 -1
  18. package/dist/components/image-preview/image-preview.js.map +1 -1
  19. package/dist/components/input/input.js.map +1 -1
  20. package/dist/components/input/input.utils.js.map +1 -1
  21. package/dist/components/input/variants/input-color.js.map +1 -1
  22. package/dist/components/input/variants/input-date.js.map +1 -1
  23. package/dist/components/input/variants/input-number.d.ts.map +1 -1
  24. package/dist/components/input/variants/input-number.js +1 -1
  25. package/dist/components/input/variants/input-number.js.map +1 -1
  26. package/dist/components/input/variants/input-otp.js.map +1 -1
  27. package/dist/components/input/variants/input-password.js.map +1 -1
  28. package/dist/components/input/variants/input-radio.js.map +1 -1
  29. package/dist/components/input/variants/input-range.js.map +1 -1
  30. package/dist/components/input/variants/input-text.d.ts.map +1 -1
  31. package/dist/components/input/variants/input-text.js +1 -1
  32. package/dist/components/input/variants/input-text.js.map +1 -1
  33. package/dist/components/input/variants/input-textarea.js.map +1 -1
  34. package/dist/components/loading/loading.js.map +1 -1
  35. package/dist/components/mansory/mansory.js.map +1 -1
  36. package/dist/components/menu/menu.js.map +1 -1
  37. package/dist/components/modal/modal.js.map +1 -1
  38. package/dist/components/modal/modalContext.js.map +1 -1
  39. package/dist/components/pagination/pagination.js.map +1 -1
  40. package/dist/components/progress-bar/progress-bar.js.map +1 -1
  41. package/dist/components/qr-code/qr-code.js.map +1 -1
  42. package/dist/components/select/select.js +1 -1
  43. package/dist/components/select/select.js.map +1 -1
  44. package/dist/components/select-zone/select-zone.js.map +1 -1
  45. package/dist/components/skeleton/skeleton.js.map +1 -1
  46. package/dist/components/slider/slider.js.map +1 -1
  47. package/dist/components/splitter/splitter.js.map +1 -1
  48. package/dist/components/steps/steps.js.map +1 -1
  49. package/dist/components/swap/swap.js.map +1 -1
  50. package/dist/components/switch/switch.js.map +1 -1
  51. package/dist/components/tab/tab.js.map +1 -1
  52. package/dist/components/table/table.js.map +1 -1
  53. package/dist/components/timeline/timeline.js.map +1 -1
  54. package/dist/components/toast/icons/ErrorIcon.js.map +1 -1
  55. package/dist/components/toast/icons/IconCircle.js.map +1 -1
  56. package/dist/components/toast/icons/InfoIcon.js.map +1 -1
  57. package/dist/components/toast/icons/LoaderIcon.js.map +1 -1
  58. package/dist/components/toast/icons/SuccessIcon.js.map +1 -1
  59. package/dist/components/toast/icons/WarningIcon.js.map +1 -1
  60. package/dist/components/toast/toast.js.map +1 -1
  61. package/dist/components/toast/toast.store.js.map +1 -1
  62. package/dist/components/tooltip/tooltip.js.map +1 -1
  63. package/dist/components/tour/tour.js.map +1 -1
  64. package/dist/components/upload/upload.js.map +1 -1
  65. package/dist/components/z-index/z-index.context.js.map +1 -1
  66. package/dist/components/z-index/z-index.js.map +1 -1
  67. package/dist/components/z-index/z-index.store.js.map +1 -1
  68. package/dist/components/z-index/z-index.types.js.map +1 -1
  69. package/dist/package.json +1 -1
  70. package/dist/skill/avatar.skill.md.txt +255 -255
  71. package/dist/skill/badge.skill.md.txt +223 -223
  72. package/dist/skill/breadcrumb.skill.md.txt +177 -177
  73. package/dist/skill/button.skill.md.txt +198 -198
  74. package/dist/skill/carousel.skill.md.txt +406 -406
  75. package/dist/skill/chat-bubble.skill.md.txt +342 -342
  76. package/dist/skill/checkbox.skill.md.txt +326 -326
  77. package/dist/skill/code-preview.skill.md.txt +240 -240
  78. package/dist/skill/collapse.skill.md.txt +329 -329
  79. package/dist/skill/context-menu.skill.md.txt +233 -233
  80. package/dist/skill/diff.skill.md.txt +244 -244
  81. package/dist/skill/divider.skill.md.txt +151 -151
  82. package/dist/skill/doc.skill.md.txt +191 -191
  83. package/dist/skill/drawer.skill.md.txt +157 -157
  84. package/dist/skill/dropdown.skill.md.txt +198 -198
  85. package/dist/skill/float-button.skill.md.txt +315 -315
  86. package/dist/skill/hover-3d-image.skill.md.txt +120 -120
  87. package/dist/skill/iframe.skill.md.txt +114 -114
  88. package/dist/skill/image-preview.skill.md.txt +162 -162
  89. package/dist/skill/indicator.skill.md.txt +60 -60
  90. package/dist/skill/input.skill.md.txt +489 -489
  91. package/dist/skill/loading.skill.md.txt +127 -127
  92. package/dist/skill/menu.skill.md.txt +476 -476
  93. package/dist/skill/modal.skill.md.txt +359 -359
  94. package/dist/skill/pagination.skill.md.txt +405 -405
  95. package/dist/skill/progress-bar.skill.md.txt +207 -207
  96. package/dist/skill/qr-code.skill.md.txt +136 -136
  97. package/dist/skill/rating.skill.md.txt +167 -167
  98. package/dist/skill/select-zone.skill.md.txt +93 -93
  99. package/dist/skill/select.skill.md.txt +663 -663
  100. package/dist/skill/skeleton.skill.md.txt +192 -192
  101. package/dist/skill/slider.skill.md.txt +404 -404
  102. package/dist/skill/splitter.skill.md.txt +411 -411
  103. package/dist/skill/steps.skill.md.txt +264 -264
  104. package/dist/skill/swap.skill.md.txt +139 -139
  105. package/dist/skill/switch.skill.md.txt +191 -191
  106. package/dist/skill/tab.skill.md.txt +484 -484
  107. package/dist/skill/table.example.header.md.txt +666 -666
  108. package/dist/skill/table.skill.md.txt +1407 -1407
  109. package/dist/skill/text-rotate.skill.md.txt +186 -186
  110. package/dist/skill/timeline.skill.md.txt +247 -247
  111. package/dist/skill/toast.skill.md.txt +531 -531
  112. package/dist/skill/tooltip.skill.md.txt +222 -222
  113. package/dist/skill/tour.skill.md.txt +156 -156
  114. package/dist/skill/upload.skill.md.txt +358 -358
  115. package/dist/utils/cn.js.map +1 -1
  116. package/dist/utils/element-tracker.js.map +1 -1
  117. package/dist/utils/helper.js.map +1 -1
  118. package/dist/utils/hoc.js.map +1 -1
  119. package/package.json +132 -133
@@ -1,405 +1,405 @@
1
- ## COMPONENT IDENTITY
2
- - **Import**: `import { Pagination } from 'solid-tom-ui';`
3
- - **Export**: `Pagination` (named export)
4
- - **Framework**: SolidJS
5
- - **Purpose**: Pagination control with three modes (default, simple, fully); supports controlled and uncontrolled page state
6
-
7
- ## PROP REFERENCE
8
-
9
- ### Shared base props (all modes)
10
-
11
- | Prop | Type | Default | Description |
12
- |---|---|---|---|
13
- | `mode` | `'default' \| 'simple' \| 'fully'` | `'default'` | Rendering mode. Omit for default full-featured pagination. |
14
- | `color` | `BaseColorProps` | — | Theme color applied to active/interactive elements. |
15
- | `current` | `number` | — | Controlled current page (1-indexed). If omitted → uncontrolled. |
16
- | `defaultCurrent` | `number` | `1` | Initial page for uncontrolled mode. |
17
- | `pageSize` | `number` | — | Controlled page size. |
18
- | `defaultPageSize` | `number` | `10` | Initial page size for uncontrolled mode. |
19
- | `total` | `number` | `0` | Total number of data items. Used to compute `totalPages`. |
20
- | `size` | `'xs' \| 'sm' \| 'md' \| 'lg' \| 'xl'` | `'md'` | Visual size variant. |
21
- | `hideOnSinglePage` | `boolean` | `false` | Render nothing when `totalPages <= 1`. |
22
- | `disabled` | `boolean` | `false` | Disable all interactions; adds `opacity-50 pointer-events-none`. |
23
- | `class` | `PaginationClass` | — | Fine-grained class overrides for each sub-element (see **`PaginationClass`** section). |
24
- | `onChange` | `(page: number, pageSize: number) => void` | — | Fires on page **or** pageSize change. |
25
-
26
- ### Default mode props (`mode="default"` or omitted)
27
-
28
- | Prop | Type | Default | Description |
29
- |---|---|---|---|
30
- | `align` | `'start' \| 'center' \| 'end'` | `'start'` | Horizontal alignment via `justify-*` flex. |
31
- | `showLessItems` | `boolean` | `false` | Reduce sibling count in ellipsis algorithm (1 instead of 2). Ellipsis jumps ±3 instead of ±5. |
32
- | `showQuickJumper` | `boolean \| { goButton: JSX.Element }` | `false` | Show "Go to" input. Pass `{ goButton }` to add a clickable button alongside the input. |
33
- | `showSizeChanger` | `boolean \| Record<string, unknown>` | auto | Show page-size `<select>`. Auto-shown when `total > totalBoundaryShowSizeChanger`. |
34
- | `pageSizeOptions` | `number[]` | `[10, 20, 50, 100]` | Options rendered inside the size-changer `<select>`. |
35
- | `totalBoundaryShowSizeChanger` | `number` | `50` | Threshold: auto-enable `showSizeChanger` when `total` exceeds this. |
36
- | `itemRender` | `(page, type, originalElement) => JSX.Element` | — | Override rendering of prev/next/page buttons. `type` is `'prev' \| 'next' \| 'page'`. |
37
- | `showTitle` | `boolean` | `true` | Add `title` attribute to page buttons. |
38
- | `showTotal` | `(total, range) => JSX.Element` | — | Render a label before the prev button. `range` is `[start, end]` (1-indexed, inclusive). |
39
- | `onShowSizeChange` | `(current: number, size: number) => void` | — | Fires only when pageSize changes via the size-changer select. |
40
-
41
- ### Simple mode props (`mode="simple"`)
42
-
43
- | Prop | Type | Default | Description |
44
- |---|---|---|---|
45
- | `align` | `'start' \| 'center' \| 'end'` | `'start'` | Horizontal alignment via `justify-*` flex. |
46
-
47
- ### Fully mode props (`mode="fully"`)
48
-
49
- | Prop | Type | Default | Description |
50
- |---|---|---|---|
51
- | `pageSizeOptions` | `number[]` | `[10, 20, 50, 100]` | Options rendered inside the size-changer `<select>`. |
52
- | `onShowSizeChange` | `(current: number, size: number) => void` | — | Fires when pageSize changes via the size-changer select. |
53
-
54
- ---
55
-
56
- ## `PaginationClass` INTERFACE
57
-
58
- Fine-grained class overrides passed via the `class` prop. All fields are optional strings merged with `cn()`.
59
-
60
- ```ts
61
- interface PaginationClass {
62
- // ── Root wrapper ────────────────────────────────────────────────
63
- root?: string;
64
-
65
- // ── Shared controls (default + simple + fully) ───────────────────
66
- /** Prev / next / page number buttons */
67
- btn?: string;
68
- /** Extra class on a button when it is disabled */
69
- btnDisabled?: string;
70
- /** Active (current) page button */
71
- itemActive?: string;
72
- /** Ellipsis jump button */
73
- ellipsis?: string;
74
- /** Prev button specifically */
75
- prev?: string;
76
- /** Next button specifically */
77
- next?: string;
78
- /** Page-size <select> (default mode) or native <select> (fully mode) */
79
- sizeChanger?: string;
80
-
81
- // ── Default mode ─────────────────────────────────────────────────
82
- /** "Total X items" text */
83
- total?: string;
84
- /** Quick-jumper wrapper <span> */
85
- jumper?: string;
86
- /** "Go to" label inside the quick-jumper */
87
- jumperLabel?: string;
88
- /** Number <input> inside the quick-jumper */
89
- jumperInput?: string;
90
-
91
- // ── Simple mode ───────────────────────────────────────────────────
92
- /** Pager wrapper <span> (contains input + slash + total) */
93
- simplePager?: string;
94
- /** Direct page-number <input> */
95
- simpleInput?: string;
96
- /** "/" separator */
97
- slash?: string;
98
-
99
- // ── Fully mode ────────────────────────────────────────────────────
100
- /** Left section wrapper (size-changer + range) */
101
- fullyLeft?: string;
102
- /** Right section wrapper (page-input + prev/next) */
103
- fullyRight?: string;
104
- /** "Items per page:" label */
105
- fullyLabel?: string;
106
- /** "X–Y of Z items" range text */
107
- fullyRange?: string;
108
- /** "of N pages" label next to page input */
109
- fullyPages?: string;
110
- /** Page-number <input> (underline style) */
111
- fullyPageInput?: string;
112
- }
113
- ```
114
-
115
- ---
116
-
117
- ## BEHAVIORAL RULES (inferred from implementation)
118
-
119
- ### Controlled vs Uncontrolled
120
-
121
- - **Uncontrolled**: omit `current` and `pageSize`. Internal signals (`internalCurrent`, `internalPageSize`) manage state.
122
- - **Controlled**: supply `current` (and/or `pageSize`). The component reads them via `createMemo(() => props.current ?? internalCurrent())`. **You must update the signal yourself in `onChange`**; the component does not force-sync controlled values into internal state on re-render.
123
-
124
- ### Page Clamping
125
-
126
- - `changePage(n)` clamps `n` to `[1, totalPages]`. Navigating to the same page is a no-op (no `onChange` fired).
127
-
128
- ### `totalPages` Computation
129
-
130
- ```
131
- totalPages = Math.max(1, Math.ceil(total / pageSize))
132
- ```
133
-
134
- ### Ellipsis Algorithm
135
-
136
- ```
137
- sibling = showLessItems ? 1 : 2
138
- showAll if totalPages <= (showLessItems ? 7 : 9)
139
- otherwise:
140
- [1] [prev-ellipsis?] [cur-sibling .. cur+sibling] [next-ellipsis?] [totalPages]
141
- ellipsis click jumps: showLessItems ? ±3 pages : ±5 pages
142
- ```
143
-
144
- ### Size Changer Auto-Show
145
-
146
- ```
147
- showSizeChanger === true → always show
148
- showSizeChanger === object → always show
149
- showSizeChanger undefined → show when total > totalBoundaryShowSizeChanger (default 50)
150
- ```
151
-
152
- ### Quick Jumper
153
-
154
- - Pressing `Enter` in the input or clicking `goButton` triggers `changePage(parseInt(value))`.
155
- - Input is cleared after a successful jump.
156
- - `showQuickJumper={true}` → input only (Enter to jump).
157
- - `showQuickJumper={{ goButton: <button>Go</button> }}` → input + clickable element.
158
-
159
- ### Modes
160
-
161
- **`default`** (omit `mode` or `mode="default"`): Full-featured — page buttons, ellipsis, optional quick jumper & size changer. Supports `align`.
162
-
163
- **`simple`** (`mode="simple"`):
164
- - Renders: `[‹] [input / totalPages] [›]`
165
- - Input: jumps on `Enter` or `blur`.
166
- - `showSizeChanger`, `showQuickJumper`, `showTotal`, `itemRender` are **ignored**.
167
- - Supports `align`.
168
-
169
- **`fully`** (`mode="fully"`):
170
- - Full-width layout. Always stretches to 100% width — `align` is **not applicable**.
171
- - Left section: size-changer `<select>` + "X–Y of Z items" range text.
172
- - Right section: page-number `<input>` + "of N pages" label + prev/next buttons.
173
- - Built-in size changer (no need for `showSizeChanger`).
174
- - `showLessItems`, `showQuickJumper`, `showTotal`, `itemRender`, `align` are **ignored**.
175
-
176
- ---
177
-
178
- ## USAGE PATTERNS
179
-
180
- ### 1. Minimal uncontrolled
181
-
182
- ```tsx
183
- <Pagination total={50} />
184
- ```
185
-
186
- ### 2. Controlled with state
187
-
188
- ```tsx
189
- const [page, setPage] = createSignal(1);
190
-
191
- <Pagination
192
- total={200}
193
- current={page()}
194
- onChange={(p, _size) => setPage(p)}
195
- />
196
- ```
197
-
198
- ### 3. Show total items count
199
-
200
- ```tsx
201
- <Pagination
202
- total={85}
203
- showTotal={(total, [start, end]) => (
204
- <span>{start}–{end} of {total}</span>
205
- )}
206
- />
207
- ```
208
-
209
- ### 4. Page size changer + quick jumper (full-featured)
210
-
211
- ```tsx
212
- <Pagination
213
- total={500}
214
- current={page()}
215
- onChange={(p, _size) => setPage(p)}
216
- showSizeChanger
217
- pageSizeOptions={[10, 25, 50]}
218
- showQuickJumper
219
- />
220
- ```
221
-
222
- ### 5. Custom Go button for quick jumper
223
-
224
- ```tsx
225
- <Pagination
226
- total={300}
227
- showQuickJumper={{ goButton: <button class="btn btn-sm btn-primary">Go</button> }}
228
- />
229
- ```
230
-
231
- ### 6. Custom prev/next labels via itemRender
232
-
233
- ```tsx
234
- <Pagination
235
- total={100}
236
- itemRender={(page, type, original) => {
237
- if (type === 'prev') return <button class="sui-pagination-btn px-2">← Prev</button>;
238
- if (type === 'next') return <button class="sui-pagination-btn px-2">Next →</button>;
239
- return original; // keep default page number buttons
240
- }}
241
- />
242
- ```
243
-
244
- ### 7. Simple mode
245
-
246
- ```tsx
247
- <Pagination total={200} mode="simple" />
248
- ```
249
-
250
- ### 8. Hide when only one page
251
-
252
- ```tsx
253
- <Pagination total={5} defaultPageSize={10} hideOnSinglePage />
254
- // renders nothing — totalPages = 1
255
- ```
256
-
257
- ### 9. Alignment
258
-
259
- ```tsx
260
- <Pagination total={100} align="center" />
261
- <Pagination total={100} align="end" />
262
- ```
263
-
264
- ### 10. Size variants
265
-
266
- ```tsx
267
- <Pagination total={100} size="xs" />
268
- <Pagination total={100} size="sm" />
269
- <Pagination total={100} size="md" /> {/* default */}
270
- <Pagination total={100} size="lg" />
271
- <Pagination total={100} size="xl" />
272
- ```
273
-
274
- ### 11. Disabled state
275
-
276
- ```tsx
277
- <Pagination total={200} defaultCurrent={3} showSizeChanger showQuickJumper disabled />
278
- ```
279
-
280
- ### 12. onShowSizeChange callback
281
-
282
- ```tsx
283
- <Pagination
284
- total={200}
285
- showSizeChanger
286
- onShowSizeChange={(current, size) => console.log({ current, size })}
287
- />
288
- ```
289
-
290
- ### 13. Fully mode (full-width layout)
291
-
292
- ```tsx
293
- <Pagination
294
- total={500}
295
- mode="fully"
296
- pageSizeOptions={[10, 25, 50]}
297
- onShowSizeChange={(current, size) => console.log({ current, size })}
298
- />
299
- ```
300
-
301
- ### 14. Custom color
302
-
303
- ```tsx
304
- <Pagination total={100} color="primary" />
305
- <Pagination total={100} color="success" />
306
- ```
307
-
308
- ### 15. Fine-grained class overrides
309
-
310
- ```tsx
311
- <Pagination
312
- total={200}
313
- class={{
314
- root: 'my-pagination',
315
- btn: 'rounded-full',
316
- itemActive: 'font-bold',
317
- jumperInput: 'w-12',
318
- }}
319
- />
320
- ```
321
-
322
- ---
323
-
324
- ## CSS CLASSES (public API for customization)
325
-
326
- | Class | Applied to |
327
- |---|---|
328
- | `sui-pagination` | Root `<div>` |
329
- | `sui-pagination-disabled` | Root when `disabled=true` |
330
- | `sui-pagination-xs/sm/md/lg/xl` | Size modifier on root |
331
- | `sui-pagination-btn` | All button elements (prev, next, page, ellipsis) |
332
- | `sui-pagination-btn-disabled` | Prev/next when at boundary |
333
- | `sui-pagination-prev` | Prev button |
334
- | `sui-pagination-next` | Next button |
335
- | `sui-pagination-item` | Page number button |
336
- | `sui-pagination-item-active` | Active (current) page button |
337
- | `sui-pagination-ellipsis` | Ellipsis `•••` button |
338
- | `sui-pagination-size-changer` | `<select>` for page size (default + fully) |
339
- | **Default mode** | |
340
- | `sui-pagination-total` | showTotal wrapper `<span>` |
341
- | `sui-pagination-jumper` | Quick jumper wrapper `<span>` |
342
- | `sui-pagination-jumper-label` | "Go to" text |
343
- | `sui-pagination-jumper-input` | Quick jumper `<input>` |
344
- | **Simple mode** | |
345
- | `sui-pagination-simple` | Root when `mode="simple"` |
346
- | `sui-pagination-simple-pager` | Input + slash + total wrapper |
347
- | `sui-pagination-simple-input` | Simple mode `<input>` |
348
- | **Fully mode** | |
349
- | `sui-pagination-fully` | Root when `mode="fully"` |
350
- | `sui-pagination-fully-left` | Left section wrapper |
351
- | `sui-pagination-fully-right` | Right section wrapper |
352
- | `sui-pagination-fully-label` | "Items per page:" label |
353
- | `sui-pagination-fully-range` | "X–Y of Z items" range text |
354
- | `sui-pagination-fully-pages` | "of N pages" label |
355
- | `sui-pagination-fully-page-input` | Page-number `<input>` (underline style) |
356
-
357
- To add custom class to any element: use the `class` prop (type `PaginationClass`), e.g. `class={{ root: 'my-class', btn: 'rounded-full' }}`.
358
-
359
- ---
360
-
361
- ## ANIMATION
362
-
363
- - Page button enter: slide-in from right (`translateX(100% → 0)`, `opacity 0→1`, 300ms ease-out).
364
- - Page button exit: scale-out from left origin (`scale(1→0)`, 300ms ease-in).
365
- - Implemented via `solid-transition-group` `<TransitionGroup>` using the Web Animations API.
366
- - Animation only applies to the page-number buttons list, **not** prev/next/ellipsis.
367
-
368
- ---
369
-
370
- ## CONSTRAINTS & EDGE CASES
371
-
372
- - `total=0` → `totalPages=1`; component renders with only page 1.
373
- - `current` prop does NOT force-update `internalCurrent` reactively — always update via `onChange`.
374
- - `mode="simple"` ignores `showSizeChanger`, `showQuickJumper`, `showTotal`, `itemRender`.
375
- - `mode="fully"` ignores `showLessItems`, `showQuickJumper`, `showTotal`, `itemRender`, `align`.
376
- - `hideOnSinglePage=true` + `total <= pageSize` → component returns `null` (nothing rendered).
377
- - `pageSizeOptions` must be `number[]`; strings will fail `Number()` coercion in the select handler.
378
- - `itemRender` receives `page - 1` for `type='prev'` and `page + 1` for `type='next'` (i.e., the target page number, not current).
379
- - Ellipsis buttons are `<button>` elements (not `<span>`), so they receive keyboard focus naturally.
380
- - `mode="fully"` always stretches full width — do not use `align` with it.
381
-
382
- ---
383
-
384
- ## DO / DON'T
385
-
386
- **DO**
387
- - Always provide `total` — without it the component renders a single page.
388
- - Use `current` + `onChange` together for controlled usage.
389
- - Use `class={{ root: 'custom', btn: '...' }}` (`PaginationClass` shape) for fine-grained style overrides.
390
- - Import from the barrel: `import { Pagination } from 'solid-tom-ui'`.
391
- - Use `mode="fully"` when you need a full-width table pagination bar with built-in size changer and range display.
392
-
393
- **DON'T**
394
- - Don't pass `current` without an `onChange` handler (read-only pagination — use `mode="simple"` instead).
395
- - Don't mix `mode="simple"` with `showSizeChanger`/`showQuickJumper` — those props are silently ignored.
396
- - Don't use `align` with `mode="fully"` — the layout always stretches to full width.
397
- - Don't use `hideOnSinglePage` when you need pagination to always be visible (e.g., for layout consistency).
398
- - Don't import `PaginationExample` in production — it's a demo component only.
399
- ---
400
-
401
- ## Component Conventions
402
-
403
- > **CSS encoding**: internal CSS classes use short encoded names (e.g. `pg01`, `pg02`) per project convention.
404
-
405
- > **Unique IDs**: if this component needs to generate HTML `id` attributes, always use `createUniqueId()` from `solid-js` — never `Math.random()` or `Date.now()`.
1
+ ## COMPONENT IDENTITY
2
+ - **Import**: `import { Pagination } from 'solid-tom-ui';`
3
+ - **Export**: `Pagination` (named export)
4
+ - **Framework**: SolidJS
5
+ - **Purpose**: Pagination control with three modes (default, simple, fully); supports controlled and uncontrolled page state
6
+
7
+ ## PROP REFERENCE
8
+
9
+ ### Shared base props (all modes)
10
+
11
+ | Prop | Type | Default | Description |
12
+ |---|---|---|---|
13
+ | `mode` | `'default' \| 'simple' \| 'fully'` | `'default'` | Rendering mode. Omit for default full-featured pagination. |
14
+ | `color` | `BaseColorProps` | — | Theme color applied to active/interactive elements. |
15
+ | `current` | `number` | — | Controlled current page (1-indexed). If omitted → uncontrolled. |
16
+ | `defaultCurrent` | `number` | `1` | Initial page for uncontrolled mode. |
17
+ | `pageSize` | `number` | — | Controlled page size. |
18
+ | `defaultPageSize` | `number` | `10` | Initial page size for uncontrolled mode. |
19
+ | `total` | `number` | `0` | Total number of data items. Used to compute `totalPages`. |
20
+ | `size` | `'xs' \| 'sm' \| 'md' \| 'lg' \| 'xl'` | `'md'` | Visual size variant. |
21
+ | `hideOnSinglePage` | `boolean` | `false` | Render nothing when `totalPages <= 1`. |
22
+ | `disabled` | `boolean` | `false` | Disable all interactions; adds `opacity-50 pointer-events-none`. |
23
+ | `class` | `PaginationClass` | — | Fine-grained class overrides for each sub-element (see **`PaginationClass`** section). |
24
+ | `onChange` | `(page: number, pageSize: number) => void` | — | Fires on page **or** pageSize change. |
25
+
26
+ ### Default mode props (`mode="default"` or omitted)
27
+
28
+ | Prop | Type | Default | Description |
29
+ |---|---|---|---|
30
+ | `align` | `'start' \| 'center' \| 'end'` | `'start'` | Horizontal alignment via `justify-*` flex. |
31
+ | `showLessItems` | `boolean` | `false` | Reduce sibling count in ellipsis algorithm (1 instead of 2). Ellipsis jumps ±3 instead of ±5. |
32
+ | `showQuickJumper` | `boolean \| { goButton: JSX.Element }` | `false` | Show "Go to" input. Pass `{ goButton }` to add a clickable button alongside the input. |
33
+ | `showSizeChanger` | `boolean \| Record<string, unknown>` | auto | Show page-size `<select>`. Auto-shown when `total > totalBoundaryShowSizeChanger`. |
34
+ | `pageSizeOptions` | `number[]` | `[10, 20, 50, 100]` | Options rendered inside the size-changer `<select>`. |
35
+ | `totalBoundaryShowSizeChanger` | `number` | `50` | Threshold: auto-enable `showSizeChanger` when `total` exceeds this. |
36
+ | `itemRender` | `(page, type, originalElement) => JSX.Element` | — | Override rendering of prev/next/page buttons. `type` is `'prev' \| 'next' \| 'page'`. |
37
+ | `showTitle` | `boolean` | `true` | Add `title` attribute to page buttons. |
38
+ | `showTotal` | `(total, range) => JSX.Element` | — | Render a label before the prev button. `range` is `[start, end]` (1-indexed, inclusive). |
39
+ | `onShowSizeChange` | `(current: number, size: number) => void` | — | Fires only when pageSize changes via the size-changer select. |
40
+
41
+ ### Simple mode props (`mode="simple"`)
42
+
43
+ | Prop | Type | Default | Description |
44
+ |---|---|---|---|
45
+ | `align` | `'start' \| 'center' \| 'end'` | `'start'` | Horizontal alignment via `justify-*` flex. |
46
+
47
+ ### Fully mode props (`mode="fully"`)
48
+
49
+ | Prop | Type | Default | Description |
50
+ |---|---|---|---|
51
+ | `pageSizeOptions` | `number[]` | `[10, 20, 50, 100]` | Options rendered inside the size-changer `<select>`. |
52
+ | `onShowSizeChange` | `(current: number, size: number) => void` | — | Fires when pageSize changes via the size-changer select. |
53
+
54
+ ---
55
+
56
+ ## `PaginationClass` INTERFACE
57
+
58
+ Fine-grained class overrides passed via the `class` prop. All fields are optional strings merged with `cn()`.
59
+
60
+ ```ts
61
+ interface PaginationClass {
62
+ // ── Root wrapper ────────────────────────────────────────────────
63
+ root?: string;
64
+
65
+ // ── Shared controls (default + simple + fully) ───────────────────
66
+ /** Prev / next / page number buttons */
67
+ btn?: string;
68
+ /** Extra class on a button when it is disabled */
69
+ btnDisabled?: string;
70
+ /** Active (current) page button */
71
+ itemActive?: string;
72
+ /** Ellipsis jump button */
73
+ ellipsis?: string;
74
+ /** Prev button specifically */
75
+ prev?: string;
76
+ /** Next button specifically */
77
+ next?: string;
78
+ /** Page-size <select> (default mode) or native <select> (fully mode) */
79
+ sizeChanger?: string;
80
+
81
+ // ── Default mode ─────────────────────────────────────────────────
82
+ /** "Total X items" text */
83
+ total?: string;
84
+ /** Quick-jumper wrapper <span> */
85
+ jumper?: string;
86
+ /** "Go to" label inside the quick-jumper */
87
+ jumperLabel?: string;
88
+ /** Number <input> inside the quick-jumper */
89
+ jumperInput?: string;
90
+
91
+ // ── Simple mode ───────────────────────────────────────────────────
92
+ /** Pager wrapper <span> (contains input + slash + total) */
93
+ simplePager?: string;
94
+ /** Direct page-number <input> */
95
+ simpleInput?: string;
96
+ /** "/" separator */
97
+ slash?: string;
98
+
99
+ // ── Fully mode ────────────────────────────────────────────────────
100
+ /** Left section wrapper (size-changer + range) */
101
+ fullyLeft?: string;
102
+ /** Right section wrapper (page-input + prev/next) */
103
+ fullyRight?: string;
104
+ /** "Items per page:" label */
105
+ fullyLabel?: string;
106
+ /** "X–Y of Z items" range text */
107
+ fullyRange?: string;
108
+ /** "of N pages" label next to page input */
109
+ fullyPages?: string;
110
+ /** Page-number <input> (underline style) */
111
+ fullyPageInput?: string;
112
+ }
113
+ ```
114
+
115
+ ---
116
+
117
+ ## BEHAVIORAL RULES (inferred from implementation)
118
+
119
+ ### Controlled vs Uncontrolled
120
+
121
+ - **Uncontrolled**: omit `current` and `pageSize`. Internal signals (`internalCurrent`, `internalPageSize`) manage state.
122
+ - **Controlled**: supply `current` (and/or `pageSize`). The component reads them via `createMemo(() => props.current ?? internalCurrent())`. **You must update the signal yourself in `onChange`**; the component does not force-sync controlled values into internal state on re-render.
123
+
124
+ ### Page Clamping
125
+
126
+ - `changePage(n)` clamps `n` to `[1, totalPages]`. Navigating to the same page is a no-op (no `onChange` fired).
127
+
128
+ ### `totalPages` Computation
129
+
130
+ ```
131
+ totalPages = Math.max(1, Math.ceil(total / pageSize))
132
+ ```
133
+
134
+ ### Ellipsis Algorithm
135
+
136
+ ```
137
+ sibling = showLessItems ? 1 : 2
138
+ showAll if totalPages <= (showLessItems ? 7 : 9)
139
+ otherwise:
140
+ [1] [prev-ellipsis?] [cur-sibling .. cur+sibling] [next-ellipsis?] [totalPages]
141
+ ellipsis click jumps: showLessItems ? ±3 pages : ±5 pages
142
+ ```
143
+
144
+ ### Size Changer Auto-Show
145
+
146
+ ```
147
+ showSizeChanger === true → always show
148
+ showSizeChanger === object → always show
149
+ showSizeChanger undefined → show when total > totalBoundaryShowSizeChanger (default 50)
150
+ ```
151
+
152
+ ### Quick Jumper
153
+
154
+ - Pressing `Enter` in the input or clicking `goButton` triggers `changePage(parseInt(value))`.
155
+ - Input is cleared after a successful jump.
156
+ - `showQuickJumper={true}` → input only (Enter to jump).
157
+ - `showQuickJumper={{ goButton: <button>Go</button> }}` → input + clickable element.
158
+
159
+ ### Modes
160
+
161
+ **`default`** (omit `mode` or `mode="default"`): Full-featured — page buttons, ellipsis, optional quick jumper & size changer. Supports `align`.
162
+
163
+ **`simple`** (`mode="simple"`):
164
+ - Renders: `[‹] [input / totalPages] [›]`
165
+ - Input: jumps on `Enter` or `blur`.
166
+ - `showSizeChanger`, `showQuickJumper`, `showTotal`, `itemRender` are **ignored**.
167
+ - Supports `align`.
168
+
169
+ **`fully`** (`mode="fully"`):
170
+ - Full-width layout. Always stretches to 100% width — `align` is **not applicable**.
171
+ - Left section: size-changer `<select>` + "X–Y of Z items" range text.
172
+ - Right section: page-number `<input>` + "of N pages" label + prev/next buttons.
173
+ - Built-in size changer (no need for `showSizeChanger`).
174
+ - `showLessItems`, `showQuickJumper`, `showTotal`, `itemRender`, `align` are **ignored**.
175
+
176
+ ---
177
+
178
+ ## USAGE PATTERNS
179
+
180
+ ### 1. Minimal uncontrolled
181
+
182
+ ```tsx
183
+ <Pagination total={50} />
184
+ ```
185
+
186
+ ### 2. Controlled with state
187
+
188
+ ```tsx
189
+ const [page, setPage] = createSignal(1);
190
+
191
+ <Pagination
192
+ total={200}
193
+ current={page()}
194
+ onChange={(p, _size) => setPage(p)}
195
+ />
196
+ ```
197
+
198
+ ### 3. Show total items count
199
+
200
+ ```tsx
201
+ <Pagination
202
+ total={85}
203
+ showTotal={(total, [start, end]) => (
204
+ <span>{start}–{end} of {total}</span>
205
+ )}
206
+ />
207
+ ```
208
+
209
+ ### 4. Page size changer + quick jumper (full-featured)
210
+
211
+ ```tsx
212
+ <Pagination
213
+ total={500}
214
+ current={page()}
215
+ onChange={(p, _size) => setPage(p)}
216
+ showSizeChanger
217
+ pageSizeOptions={[10, 25, 50]}
218
+ showQuickJumper
219
+ />
220
+ ```
221
+
222
+ ### 5. Custom Go button for quick jumper
223
+
224
+ ```tsx
225
+ <Pagination
226
+ total={300}
227
+ showQuickJumper={{ goButton: <button class="btn btn-sm btn-primary">Go</button> }}
228
+ />
229
+ ```
230
+
231
+ ### 6. Custom prev/next labels via itemRender
232
+
233
+ ```tsx
234
+ <Pagination
235
+ total={100}
236
+ itemRender={(page, type, original) => {
237
+ if (type === 'prev') return <button class="sui-pagination-btn px-2">← Prev</button>;
238
+ if (type === 'next') return <button class="sui-pagination-btn px-2">Next →</button>;
239
+ return original; // keep default page number buttons
240
+ }}
241
+ />
242
+ ```
243
+
244
+ ### 7. Simple mode
245
+
246
+ ```tsx
247
+ <Pagination total={200} mode="simple" />
248
+ ```
249
+
250
+ ### 8. Hide when only one page
251
+
252
+ ```tsx
253
+ <Pagination total={5} defaultPageSize={10} hideOnSinglePage />
254
+ // renders nothing — totalPages = 1
255
+ ```
256
+
257
+ ### 9. Alignment
258
+
259
+ ```tsx
260
+ <Pagination total={100} align="center" />
261
+ <Pagination total={100} align="end" />
262
+ ```
263
+
264
+ ### 10. Size variants
265
+
266
+ ```tsx
267
+ <Pagination total={100} size="xs" />
268
+ <Pagination total={100} size="sm" />
269
+ <Pagination total={100} size="md" /> {/* default */}
270
+ <Pagination total={100} size="lg" />
271
+ <Pagination total={100} size="xl" />
272
+ ```
273
+
274
+ ### 11. Disabled state
275
+
276
+ ```tsx
277
+ <Pagination total={200} defaultCurrent={3} showSizeChanger showQuickJumper disabled />
278
+ ```
279
+
280
+ ### 12. onShowSizeChange callback
281
+
282
+ ```tsx
283
+ <Pagination
284
+ total={200}
285
+ showSizeChanger
286
+ onShowSizeChange={(current, size) => console.log({ current, size })}
287
+ />
288
+ ```
289
+
290
+ ### 13. Fully mode (full-width layout)
291
+
292
+ ```tsx
293
+ <Pagination
294
+ total={500}
295
+ mode="fully"
296
+ pageSizeOptions={[10, 25, 50]}
297
+ onShowSizeChange={(current, size) => console.log({ current, size })}
298
+ />
299
+ ```
300
+
301
+ ### 14. Custom color
302
+
303
+ ```tsx
304
+ <Pagination total={100} color="primary" />
305
+ <Pagination total={100} color="success" />
306
+ ```
307
+
308
+ ### 15. Fine-grained class overrides
309
+
310
+ ```tsx
311
+ <Pagination
312
+ total={200}
313
+ class={{
314
+ root: 'my-pagination',
315
+ btn: 'rounded-full',
316
+ itemActive: 'font-bold',
317
+ jumperInput: 'w-12',
318
+ }}
319
+ />
320
+ ```
321
+
322
+ ---
323
+
324
+ ## CSS CLASSES (public API for customization)
325
+
326
+ | Class | Applied to |
327
+ |---|---|
328
+ | `sui-pagination` | Root `<div>` |
329
+ | `sui-pagination-disabled` | Root when `disabled=true` |
330
+ | `sui-pagination-xs/sm/md/lg/xl` | Size modifier on root |
331
+ | `sui-pagination-btn` | All button elements (prev, next, page, ellipsis) |
332
+ | `sui-pagination-btn-disabled` | Prev/next when at boundary |
333
+ | `sui-pagination-prev` | Prev button |
334
+ | `sui-pagination-next` | Next button |
335
+ | `sui-pagination-item` | Page number button |
336
+ | `sui-pagination-item-active` | Active (current) page button |
337
+ | `sui-pagination-ellipsis` | Ellipsis `•••` button |
338
+ | `sui-pagination-size-changer` | `<select>` for page size (default + fully) |
339
+ | **Default mode** | |
340
+ | `sui-pagination-total` | showTotal wrapper `<span>` |
341
+ | `sui-pagination-jumper` | Quick jumper wrapper `<span>` |
342
+ | `sui-pagination-jumper-label` | "Go to" text |
343
+ | `sui-pagination-jumper-input` | Quick jumper `<input>` |
344
+ | **Simple mode** | |
345
+ | `sui-pagination-simple` | Root when `mode="simple"` |
346
+ | `sui-pagination-simple-pager` | Input + slash + total wrapper |
347
+ | `sui-pagination-simple-input` | Simple mode `<input>` |
348
+ | **Fully mode** | |
349
+ | `sui-pagination-fully` | Root when `mode="fully"` |
350
+ | `sui-pagination-fully-left` | Left section wrapper |
351
+ | `sui-pagination-fully-right` | Right section wrapper |
352
+ | `sui-pagination-fully-label` | "Items per page:" label |
353
+ | `sui-pagination-fully-range` | "X–Y of Z items" range text |
354
+ | `sui-pagination-fully-pages` | "of N pages" label |
355
+ | `sui-pagination-fully-page-input` | Page-number `<input>` (underline style) |
356
+
357
+ To add custom class to any element: use the `class` prop (type `PaginationClass`), e.g. `class={{ root: 'my-class', btn: 'rounded-full' }}`.
358
+
359
+ ---
360
+
361
+ ## ANIMATION
362
+
363
+ - Page button enter: slide-in from right (`translateX(100% → 0)`, `opacity 0→1`, 300ms ease-out).
364
+ - Page button exit: scale-out from left origin (`scale(1→0)`, 300ms ease-in).
365
+ - Implemented via `solid-transition-group` `<TransitionGroup>` using the Web Animations API.
366
+ - Animation only applies to the page-number buttons list, **not** prev/next/ellipsis.
367
+
368
+ ---
369
+
370
+ ## CONSTRAINTS & EDGE CASES
371
+
372
+ - `total=0` → `totalPages=1`; component renders with only page 1.
373
+ - `current` prop does NOT force-update `internalCurrent` reactively — always update via `onChange`.
374
+ - `mode="simple"` ignores `showSizeChanger`, `showQuickJumper`, `showTotal`, `itemRender`.
375
+ - `mode="fully"` ignores `showLessItems`, `showQuickJumper`, `showTotal`, `itemRender`, `align`.
376
+ - `hideOnSinglePage=true` + `total <= pageSize` → component returns `null` (nothing rendered).
377
+ - `pageSizeOptions` must be `number[]`; strings will fail `Number()` coercion in the select handler.
378
+ - `itemRender` receives `page - 1` for `type='prev'` and `page + 1` for `type='next'` (i.e., the target page number, not current).
379
+ - Ellipsis buttons are `<button>` elements (not `<span>`), so they receive keyboard focus naturally.
380
+ - `mode="fully"` always stretches full width — do not use `align` with it.
381
+
382
+ ---
383
+
384
+ ## DO / DON'T
385
+
386
+ **DO**
387
+ - Always provide `total` — without it the component renders a single page.
388
+ - Use `current` + `onChange` together for controlled usage.
389
+ - Use `class={{ root: 'custom', btn: '...' }}` (`PaginationClass` shape) for fine-grained style overrides.
390
+ - Import from the barrel: `import { Pagination } from 'solid-tom-ui'`.
391
+ - Use `mode="fully"` when you need a full-width table pagination bar with built-in size changer and range display.
392
+
393
+ **DON'T**
394
+ - Don't pass `current` without an `onChange` handler (read-only pagination — use `mode="simple"` instead).
395
+ - Don't mix `mode="simple"` with `showSizeChanger`/`showQuickJumper` — those props are silently ignored.
396
+ - Don't use `align` with `mode="fully"` — the layout always stretches to full width.
397
+ - Don't use `hideOnSinglePage` when you need pagination to always be visible (e.g., for layout consistency).
398
+ - Don't import `PaginationExample` in production — it's a demo component only.
399
+ ---
400
+
401
+ ## Component Conventions
402
+
403
+ > **CSS encoding**: internal CSS classes use short encoded names (e.g. `pg01`, `pg02`) per project convention.
404
+
405
+ > **Unique IDs**: if this component needs to generate HTML `id` attributes, always use `createUniqueId()` from `solid-js` — never `Math.random()` or `Date.now()`.