solid-tom-ui 1.0.10 → 1.0.14
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 +246 -246
- package/dist/README.md +246 -246
- package/dist/components/avatar/avatar.js.map +1 -1
- package/dist/components/badge/badge.js.map +1 -1
- package/dist/components/breadcrumb/breadcrumb.js.map +1 -1
- package/dist/components/button/button.js.map +1 -1
- package/dist/components/carousel/carousel.js.map +1 -1
- package/dist/components/chat-bubble/chatBubble.js.map +1 -1
- package/dist/components/checkbox/checkbox.js.map +1 -1
- package/dist/components/collapse/collapse.js.map +1 -1
- package/dist/components/context-menu/context-menu.js.map +1 -1
- package/dist/components/context-menu/context-menu.store.js.map +1 -1
- package/dist/components/divider/divider.js.map +1 -1
- package/dist/components/dropdown/dropdown.js.map +1 -1
- package/dist/components/dropdown/dropdown.store.js.map +1 -1
- package/dist/components/float-button/float-button.js.map +1 -1
- package/dist/components/hover-3d-image/hover-3d-image.js.map +1 -1
- package/dist/components/image-preview/image-preview.js.map +1 -1
- package/dist/components/input/input.js.map +1 -1
- package/dist/components/input/input.utils.js.map +1 -1
- package/dist/components/input/variants/input-color.js.map +1 -1
- package/dist/components/input/variants/input-date.js.map +1 -1
- package/dist/components/input/variants/input-number.d.ts.map +1 -1
- package/dist/components/input/variants/input-number.js +1 -1
- package/dist/components/input/variants/input-number.js.map +1 -1
- package/dist/components/input/variants/input-otp.js.map +1 -1
- package/dist/components/input/variants/input-password.js.map +1 -1
- package/dist/components/input/variants/input-radio.js.map +1 -1
- package/dist/components/input/variants/input-range.js.map +1 -1
- package/dist/components/input/variants/input-text.d.ts.map +1 -1
- package/dist/components/input/variants/input-text.js +1 -1
- package/dist/components/input/variants/input-text.js.map +1 -1
- package/dist/components/input/variants/input-textarea.js.map +1 -1
- package/dist/components/loading/loading.js.map +1 -1
- package/dist/components/mansory/mansory.js.map +1 -1
- package/dist/components/menu/menu.js.map +1 -1
- package/dist/components/menu/menu.types.d.ts +2 -3
- package/dist/components/menu/menu.types.d.ts.map +1 -1
- package/dist/components/modal/modal.js.map +1 -1
- package/dist/components/modal/modalContext.js.map +1 -1
- package/dist/components/pagination/pagination.js.map +1 -1
- package/dist/components/progress-bar/progress-bar.js.map +1 -1
- package/dist/components/qr-code/qr-code.js.map +1 -1
- package/dist/components/select/select.js.map +1 -1
- package/dist/components/select-zone/select-zone.js.map +1 -1
- package/dist/components/skeleton/skeleton.js.map +1 -1
- package/dist/components/slider/slider.js.map +1 -1
- package/dist/components/splitter/splitter.js.map +1 -1
- package/dist/components/steps/steps.js.map +1 -1
- package/dist/components/swap/swap.js.map +1 -1
- package/dist/components/switch/switch.js.map +1 -1
- package/dist/components/tab/tab.js.map +1 -1
- package/dist/components/table/table.js.map +1 -1
- package/dist/components/timeline/timeline.js.map +1 -1
- package/dist/components/toast/icons/ErrorIcon.js.map +1 -1
- package/dist/components/toast/icons/IconCircle.js.map +1 -1
- package/dist/components/toast/icons/InfoIcon.js.map +1 -1
- package/dist/components/toast/icons/LoaderIcon.js.map +1 -1
- package/dist/components/toast/icons/SuccessIcon.js.map +1 -1
- package/dist/components/toast/icons/WarningIcon.js.map +1 -1
- package/dist/components/toast/toast.js.map +1 -1
- package/dist/components/toast/toast.store.js.map +1 -1
- package/dist/components/tooltip/tooltip.js.map +1 -1
- package/dist/components/tour/tour.js.map +1 -1
- package/dist/components/upload/upload.js.map +1 -1
- package/dist/components/z-index/z-index.context.js.map +1 -1
- package/dist/components/z-index/z-index.js.map +1 -1
- package/dist/components/z-index/z-index.store.js.map +1 -1
- package/dist/components/z-index/z-index.types.js.map +1 -1
- package/dist/package.json +1 -1
- package/dist/skill/avatar.skill.md.txt +255 -255
- package/dist/skill/badge.skill.md.txt +223 -223
- package/dist/skill/breadcrumb.skill.md.txt +177 -177
- package/dist/skill/button.skill.md.txt +198 -198
- package/dist/skill/carousel.skill.md.txt +406 -406
- package/dist/skill/chat-bubble.skill.md.txt +342 -342
- package/dist/skill/checkbox.skill.md.txt +326 -326
- package/dist/skill/code-preview.skill.md.txt +240 -240
- package/dist/skill/collapse.skill.md.txt +329 -329
- package/dist/skill/context-menu.skill.md.txt +233 -233
- package/dist/skill/diff.skill.md.txt +244 -244
- package/dist/skill/divider.skill.md.txt +151 -151
- package/dist/skill/doc.skill.md.txt +191 -191
- package/dist/skill/drawer.skill.md.txt +157 -157
- package/dist/skill/dropdown.skill.md.txt +198 -198
- package/dist/skill/float-button.skill.md.txt +315 -315
- package/dist/skill/hover-3d-image.skill.md.txt +120 -120
- package/dist/skill/iframe.skill.md.txt +114 -114
- package/dist/skill/image-preview.skill.md.txt +162 -162
- package/dist/skill/indicator.skill.md.txt +60 -60
- package/dist/skill/input.skill.md.txt +489 -489
- package/dist/skill/loading.skill.md.txt +127 -127
- package/dist/skill/menu.skill.md.txt +476 -476
- package/dist/skill/modal.skill.md.txt +359 -359
- package/dist/skill/pagination.skill.md.txt +405 -405
- package/dist/skill/progress-bar.skill.md.txt +207 -207
- package/dist/skill/qr-code.skill.md.txt +136 -136
- package/dist/skill/rating.skill.md.txt +167 -167
- package/dist/skill/select-zone.skill.md.txt +93 -93
- package/dist/skill/select.skill.md.txt +663 -663
- package/dist/skill/skeleton.skill.md.txt +192 -192
- package/dist/skill/slider.skill.md.txt +404 -404
- package/dist/skill/splitter.skill.md.txt +411 -411
- package/dist/skill/steps.skill.md.txt +264 -264
- package/dist/skill/swap.skill.md.txt +139 -139
- package/dist/skill/switch.skill.md.txt +191 -191
- package/dist/skill/tab.skill.md.txt +484 -484
- package/dist/skill/table.example.header.md.txt +666 -666
- package/dist/skill/table.skill.md.txt +1407 -1407
- package/dist/skill/text-rotate.skill.md.txt +186 -186
- package/dist/skill/timeline.skill.md.txt +247 -247
- package/dist/skill/toast.skill.md.txt +531 -531
- package/dist/skill/tooltip.skill.md.txt +222 -222
- package/dist/skill/tour.skill.md.txt +156 -156
- package/dist/skill/upload.skill.md.txt +358 -358
- package/dist/utils/cn.js.map +1 -1
- package/dist/utils/element-tracker.js.map +1 -1
- package/dist/utils/helper.js.map +1 -1
- package/dist/utils/hoc.js.map +1 -1
- package/package.json +132 -133
|
@@ -1,326 +1,326 @@
|
|
|
1
|
-
## COMPONENT IDENTITY
|
|
2
|
-
- **Import**: `import { Checkbox } from 'solid-tom-ui';`
|
|
3
|
-
- **Export**: `Checkbox` (named export)
|
|
4
|
-
- **Framework**: SolidJS
|
|
5
|
-
- **Purpose**: Single `<input type="checkbox">` — **uncontrolled**: initial state via `defaultChecked`, internal DOM state drives truth thereafter
|
|
6
|
-
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
## TYPE SIGNATURE
|
|
10
|
-
|
|
11
|
-
```ts
|
|
12
|
-
type CheckboxProps = {
|
|
13
|
-
defaultChecked: boolean; // REQUIRED — sets initial checked state via ref
|
|
14
|
-
id?: string; // auto-generated via createUniqueId() if omitted
|
|
15
|
-
name?: string; // for form submission grouping
|
|
16
|
-
value?: string; // form submission value (overridden when indeterminate)
|
|
17
|
-
indeterminate?: boolean; // renders dash/minus visual state; blocks toggling
|
|
18
|
-
disabled?: boolean; // prevents interaction
|
|
19
|
-
size?: 'xs' | 'sm' | 'md' | 'lg' | 'xl';
|
|
20
|
-
color?: 'default' | 'neutral' | 'primary' | 'secondary' | 'accent' | 'info' | 'success' | 'warning' | 'error';
|
|
21
|
-
class?: string; // extra classes on <input>
|
|
22
|
-
onChange?: (checked: boolean | null) => void;
|
|
23
|
-
};
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
---
|
|
27
|
-
|
|
28
|
-
## DEFAULT VALUES (via `mergeProps`)
|
|
29
|
-
|
|
30
|
-
| Prop | Default |
|
|
31
|
-
|----------------|--------------------------|
|
|
32
|
-
| `size` | `'xs'` |
|
|
33
|
-
| `color` | `'primary'` |
|
|
34
|
-
| `id` | `createUniqueId()` — auto-generated unique string |
|
|
35
|
-
| `defaultChecked` | `false` |
|
|
36
|
-
|
|
37
|
-
---
|
|
38
|
-
|
|
39
|
-
## PROP REFERENCE
|
|
40
|
-
|
|
41
|
-
| Prop | Type | Required | Description |
|
|
42
|
-
|------------------|-----------------------------------------------------------------------|----------|-------------------------------------------------------------------------------------------|
|
|
43
|
-
| `defaultChecked` | `boolean` | ✅ YES | Sets initial `checked` state via DOM ref on mount — does NOT reactively update after mount |
|
|
44
|
-
| `id` | `string` | ❌ NO | `id` on `<input>` — auto-generated if omitted; used with external `<label for="...">` |
|
|
45
|
-
| `name` | `string` | ❌ NO | `name` attribute for native form grouping/submission |
|
|
46
|
-
| `value` | `string` | ❌ NO | `value` submitted with form data. Overridden to `'inteterminate'` when `indeterminate` is true |
|
|
47
|
-
| `indeterminate` | `boolean` | ❌ NO | Shows dash/minus visual; blocks user toggling; sets `data-indeterminate="true"` on input |
|
|
48
|
-
| `disabled` | `boolean` | ❌ NO | Disables the input; prevents `onChange` from firing |
|
|
49
|
-
| `size` | `'xs' \| 'sm' \| 'md' \| 'lg' \| 'xl'` | ❌ NO | Visual size of the checkbox |
|
|
50
|
-
| `color` | `'default' \| 'neutral' \| 'primary' \| 'secondary' \| 'accent' \| 'info' \| 'success' \| 'warning' \| 'error'` | ❌ NO | Checkbox fill color when checked |
|
|
51
|
-
| `class` | `string` | ❌ NO | Extra Tailwind classes appended directly to `<input>` |
|
|
52
|
-
| `onChange` | `(checked: boolean \| null) => void` | ❌ NO | Fires on change with `e.target.checked` value. NOT fired when `indeterminate` or `disabled` |
|
|
53
|
-
|
|
54
|
-
---
|
|
55
|
-
|
|
56
|
-
## SIZE REFERENCE
|
|
57
|
-
|
|
58
|
-
| Value | CSS `--size` | Pixel size |
|
|
59
|
-
|-------|-------------|------------|
|
|
60
|
-
| `'xs'`| `14px` | 14 × 14px |
|
|
61
|
-
| `'sm'`| `16px` | 16 × 16px |
|
|
62
|
-
| `'md'`| `18px` | 18 × 18px |
|
|
63
|
-
| `'lg'`| `20px` | 20 × 20px |
|
|
64
|
-
| `'xl'`| `22px` | 22 × 22px |
|
|
65
|
-
|
|
66
|
-
---
|
|
67
|
-
|
|
68
|
-
## COLOR REFERENCE
|
|
69
|
-
|
|
70
|
-
| Value | DaisyUI class | Fill color when checked |
|
|
71
|
-
|---------------|----------------------|------------------------------|
|
|
72
|
-
| `'default'` | *(no class)* | Default DaisyUI checkbox color |
|
|
73
|
-
| `'neutral'` | `checkbox-neutral` | Neutral |
|
|
74
|
-
| `'primary'` | `checkbox-primary` | Primary (default) |
|
|
75
|
-
| `'secondary'` | `checkbox-secondary` | Secondary |
|
|
76
|
-
| `'accent'` | `checkbox-accent` | Accent |
|
|
77
|
-
| `'info'` | `checkbox-info` | Info |
|
|
78
|
-
| `'success'` | `checkbox-success` | Success |
|
|
79
|
-
| `'warning'` | `checkbox-warning` | Warning |
|
|
80
|
-
| `'error'` | `checkbox-error` | Error |
|
|
81
|
-
|
|
82
|
-
---
|
|
83
|
-
|
|
84
|
-
## UNCONTROLLED BEHAVIOR — Critical for agents
|
|
85
|
-
|
|
86
|
-
This component is **uncontrolled** by design:
|
|
87
|
-
|
|
88
|
-
- `defaultChecked` sets `ref.checked = value` once at mount via a `ref` callback
|
|
89
|
-
- After mount, the DOM input's `checked` state is **the source of truth**
|
|
90
|
-
- There is **no reactive signal** tracking checked state internally
|
|
91
|
-
- Changing `defaultChecked` after mount does **nothing** — the DOM state is not updated
|
|
92
|
-
- To read current checked state, use `onChange` callback or query the DOM via `ref`
|
|
93
|
-
|
|
94
|
-
```tsx
|
|
95
|
-
// ✅ Correct: read state through onChange
|
|
96
|
-
const [checked, setChecked] = createSignal(false);
|
|
97
|
-
|
|
98
|
-
<Checkbox
|
|
99
|
-
defaultChecked={false}
|
|
100
|
-
onChange={val => setChecked(val)}
|
|
101
|
-
/>
|
|
102
|
-
|
|
103
|
-
// ❌ Wrong: changing defaultChecked after mount has no effect
|
|
104
|
-
const [init, setInit] = createSignal(false);
|
|
105
|
-
<Checkbox defaultChecked={init()} /> // reactive update ignored after first render
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
---
|
|
109
|
-
|
|
110
|
-
## INDETERMINATE STATE
|
|
111
|
-
|
|
112
|
-
When `indeterminate={true}`:
|
|
113
|
-
- Renders a **dash/minus** visual (clip-path polygon in CSS)
|
|
114
|
-
- `data-indeterminate="true"` is set on the `<input>`
|
|
115
|
-
- `value` prop is overridden to `'inteterminate'` (note: typo in source — single 'r')
|
|
116
|
-
- `onClick` calls `e.preventDefault()` — **user cannot toggle** the checkbox
|
|
117
|
-
- `onChange` is **never fired** (click is blocked)
|
|
118
|
-
- Useful for "select all" parent checkboxes when only some children are selected
|
|
119
|
-
|
|
120
|
-
```tsx
|
|
121
|
-
// Indeterminate "select all" pattern
|
|
122
|
-
const allChecked = () => items().every(i => i.checked);
|
|
123
|
-
const someChecked = () => items().some(i => i.checked);
|
|
124
|
-
|
|
125
|
-
<Checkbox
|
|
126
|
-
defaultChecked={allChecked()}
|
|
127
|
-
indeterminate={someChecked() && !allChecked()}
|
|
128
|
-
onChange={val => items().forEach(i => i.setChecked(val))}
|
|
129
|
-
/>
|
|
130
|
-
```
|
|
131
|
-
|
|
132
|
-
> ⚠️ Because `indeterminate` blocks user toggling, the state change must be driven externally (e.g. by updating items and re-rendering).
|
|
133
|
-
|
|
134
|
-
---
|
|
135
|
-
|
|
136
|
-
## ADDING A LABEL
|
|
137
|
-
|
|
138
|
-
`Checkbox` renders only an `<input>` — no label wrapper is included. Use a native `<label>` element:
|
|
139
|
-
|
|
140
|
-
### Label to the right (most common)
|
|
141
|
-
```tsx
|
|
142
|
-
<label class="flex cursor-pointer items-center gap-2">
|
|
143
|
-
<Checkbox defaultChecked={false} color="primary" size="md" />
|
|
144
|
-
<span>Accept terms</span>
|
|
145
|
-
</label>
|
|
146
|
-
```
|
|
147
|
-
|
|
148
|
-
### Label to the left
|
|
149
|
-
```tsx
|
|
150
|
-
<label class="flex cursor-pointer items-center gap-2">
|
|
151
|
-
<span>Accept terms</span>
|
|
152
|
-
<Checkbox defaultChecked={false} color="primary" size="md" />
|
|
153
|
-
</label>
|
|
154
|
-
```
|
|
155
|
-
|
|
156
|
-
### Label below
|
|
157
|
-
```tsx
|
|
158
|
-
<label class="flex w-fit cursor-pointer flex-col items-center gap-1">
|
|
159
|
-
<Checkbox defaultChecked={false} color="primary" size="md" />
|
|
160
|
-
<span class="text-sm">Agree</span>
|
|
161
|
-
</label>
|
|
162
|
-
```
|
|
163
|
-
|
|
164
|
-
### External label via `id`
|
|
165
|
-
```tsx
|
|
166
|
-
<label for="terms-cb" class="cursor-pointer text-sm">Accept terms</label>
|
|
167
|
-
<Checkbox id="terms-cb" defaultChecked={false} color="primary" />
|
|
168
|
-
```
|
|
169
|
-
|
|
170
|
-
> ℹ️ Always add `cursor-pointer` to `<label>` for correct UX.
|
|
171
|
-
|
|
172
|
-
---
|
|
173
|
-
|
|
174
|
-
## FORM USAGE
|
|
175
|
-
|
|
176
|
-
Use `name` and `value` props for native HTML form submission:
|
|
177
|
-
|
|
178
|
-
```tsx
|
|
179
|
-
<form onSubmit={e => {
|
|
180
|
-
e.preventDefault();
|
|
181
|
-
const data = new FormData(e.currentTarget);
|
|
182
|
-
console.log(Object.fromEntries(data.entries()));
|
|
183
|
-
}}>
|
|
184
|
-
<label class="flex cursor-pointer items-center gap-2">
|
|
185
|
-
<Checkbox name="interests" value="technology" defaultChecked={false} />
|
|
186
|
-
<span>Technology</span>
|
|
187
|
-
</label>
|
|
188
|
-
<label class="flex cursor-pointer items-center gap-2">
|
|
189
|
-
<Checkbox name="interests" value="design" defaultChecked={false} />
|
|
190
|
-
<span>Design</span>
|
|
191
|
-
</label>
|
|
192
|
-
<button type="submit">Submit</button>
|
|
193
|
-
</form>
|
|
194
|
-
```
|
|
195
|
-
|
|
196
|
-
> ⚠️ When `indeterminate={true}`, `value` is automatically overridden to `'inteterminate'` regardless of what was passed.
|
|
197
|
-
|
|
198
|
-
---
|
|
199
|
-
|
|
200
|
-
## INTERNAL DOM STRUCTURE
|
|
201
|
-
|
|
202
|
-
```
|
|
203
|
-
<input
|
|
204
|
-
type="checkbox"
|
|
205
|
-
id="{id | auto}"
|
|
206
|
-
class="checkbox checkbox-{size} checkbox-{color} [class]"
|
|
207
|
-
disabled={disabled}
|
|
208
|
-
name="{name}" ← only if name prop provided
|
|
209
|
-
data-indeterminate="true" ← only if indeterminate={true}
|
|
210
|
-
value="{value | 'inteterminate'}"
|
|
211
|
-
onClick={...} ← preventDefault when indeterminate or disabled
|
|
212
|
-
onChange={...} ← fires p.onChange with e.target.checked
|
|
213
|
-
/>
|
|
214
|
-
```
|
|
215
|
-
|
|
216
|
-
---
|
|
217
|
-
|
|
218
|
-
## BEHAVIOR NOTES FOR AGENTS
|
|
219
|
-
|
|
220
|
-
1. **Uncontrolled — `defaultChecked` is mount-only** — do not pass a reactive signal to `defaultChecked` expecting it to control the checkbox. Use `onChange` to lift state up.
|
|
221
|
-
|
|
222
|
-
2. **`id` is auto-generated** — every `Checkbox` without an explicit `id` gets a unique ID from SolidJS `createUniqueId()`. No collision risk, but the value is not predictable. Pass explicit `id` when you need `<label for="...">` linkage.
|
|
223
|
-
|
|
224
|
-
3. **`indeterminate` blocks both click and `onChange`** — `onClick` calls `e.preventDefault()`, so `onChange` never fires. The indeterminate state must be managed entirely by the parent.
|
|
225
|
-
|
|
226
|
-
4. **`disabled` and `indeterminate` together** — both conditions independently call `e.preventDefault()` in the same `onClick` handler. Either alone is sufficient to block toggling.
|
|
227
|
-
|
|
228
|
-
5. **`name` is conditionally spread** — if `name` is `undefined`, the attribute is NOT rendered on the DOM (using `{...(p.name && { name: p.name })}`). This avoids empty `name=""` on the input.
|
|
229
|
-
|
|
230
|
-
6. **`class` appends to generated classes** — CVA generates `checkbox checkbox-{size} checkbox-{color}`, then `p.class` is appended via `cn()`. Use for shape overrides (`rounded-full`), border tweaks, shadows, etc.
|
|
231
|
-
|
|
232
|
-
7. **`onChange` receives `boolean | null`** — the signature accepts `null` for future indeterminate support, but current implementation always passes `e.target.checked` (boolean). Handle both types defensively.
|
|
233
|
-
|
|
234
|
-
---
|
|
235
|
-
|
|
236
|
-
## COMMON MISTAKES TO AVOID
|
|
237
|
-
|
|
238
|
-
| Mistake | Correct approach |
|
|
239
|
-
|---|---|
|
|
240
|
-
| Treating `defaultChecked` as reactive | It's mount-only — use `onChange` to track state in a signal |
|
|
241
|
-
| Expecting `onChange` to fire when `indeterminate={true}` | `onClick` is blocked — `onChange` never fires in indeterminate state |
|
|
242
|
-
| Omitting `cursor-pointer` on wrapping `<label>` | Always add `cursor-pointer` to `<label>` for correct UX |
|
|
243
|
-
| Passing `value="inteterminate"` manually | When `indeterminate={true}`, value is auto-set — no need to pass it |
|
|
244
|
-
| Using `color="default"` expecting a specific color | `'default'` applies no color class — checkbox uses browser/DaisyUI base style |
|
|
245
|
-
| Relying on `id` being stable without explicit prop | Auto-generated IDs are unique but unpredictable — pass explicit `id` when needed for `<label for>` |
|
|
246
|
-
|
|
247
|
-
---
|
|
248
|
-
|
|
249
|
-
## FULL EXAMPLE — All features
|
|
250
|
-
|
|
251
|
-
```tsx
|
|
252
|
-
import { Checkbox } from 'solid-tom-ui';
|
|
253
|
-
import { createSignal } from 'solid-js';
|
|
254
|
-
|
|
255
|
-
// 1. Basic with label
|
|
256
|
-
<label class="flex cursor-pointer items-center gap-2">
|
|
257
|
-
<Checkbox defaultChecked={false} color="primary" size="md" />
|
|
258
|
-
<span>Accept terms and conditions</span>
|
|
259
|
-
</label>
|
|
260
|
-
|
|
261
|
-
// 2. Controlled state via onChange
|
|
262
|
-
const [agreed, setAgreed] = createSignal(false);
|
|
263
|
-
|
|
264
|
-
<label class="flex cursor-pointer items-center gap-2">
|
|
265
|
-
<Checkbox
|
|
266
|
-
defaultChecked={false}
|
|
267
|
-
color="success"
|
|
268
|
-
size="sm"
|
|
269
|
-
onChange={val => setAgreed(val)}
|
|
270
|
-
/>
|
|
271
|
-
<span>I agree ({agreed() ? 'Yes' : 'No'})</span>
|
|
272
|
-
</label>
|
|
273
|
-
|
|
274
|
-
// 3. Indeterminate — select all pattern
|
|
275
|
-
const [items, setItems] = createSignal([
|
|
276
|
-
{ label: 'Item A', checked: true },
|
|
277
|
-
{ label: 'Item B', checked: false },
|
|
278
|
-
]);
|
|
279
|
-
const allChecked = () => items().every(i => i.checked);
|
|
280
|
-
const someChecked = () => items().some(i => i.checked);
|
|
281
|
-
|
|
282
|
-
<label class="flex cursor-pointer items-center gap-2">
|
|
283
|
-
<Checkbox
|
|
284
|
-
defaultChecked={allChecked()}
|
|
285
|
-
indeterminate={someChecked() && !allChecked()}
|
|
286
|
-
color="primary"
|
|
287
|
-
size="md"
|
|
288
|
-
/>
|
|
289
|
-
<span class="font-semibold">Select all</span>
|
|
290
|
-
</label>
|
|
291
|
-
|
|
292
|
-
// 4. Disabled
|
|
293
|
-
<label class="flex cursor-pointer items-center gap-2 opacity-50">
|
|
294
|
-
<Checkbox defaultChecked={true} color="neutral" size="md" disabled />
|
|
295
|
-
<span>Cannot change</span>
|
|
296
|
-
</label>
|
|
297
|
-
|
|
298
|
-
// 5. Form with name + value
|
|
299
|
-
<form onSubmit={e => { e.preventDefault(); console.log([...new FormData(e.currentTarget)]); }}>
|
|
300
|
-
<label class="flex cursor-pointer items-center gap-2">
|
|
301
|
-
<Checkbox name="lang" value="typescript" defaultChecked={true} size="sm" />
|
|
302
|
-
<span>TypeScript</span>
|
|
303
|
-
</label>
|
|
304
|
-
<label class="flex cursor-pointer items-center gap-2">
|
|
305
|
-
<Checkbox name="lang" value="rust" defaultChecked={false} size="sm" />
|
|
306
|
-
<span>Rust</span>
|
|
307
|
-
</label>
|
|
308
|
-
<button type="submit" class="btn btn-sm btn-primary mt-2">Submit</button>
|
|
309
|
-
</form>
|
|
310
|
-
|
|
311
|
-
// 6. Custom styling
|
|
312
|
-
<label class="flex cursor-pointer items-center gap-2">
|
|
313
|
-
<Checkbox
|
|
314
|
-
defaultChecked={true}
|
|
315
|
-
color="accent"
|
|
316
|
-
size="lg"
|
|
317
|
-
class="rounded-full shadow-lg"
|
|
318
|
-
/>
|
|
319
|
-
<span>Rounded pill checkbox</span>
|
|
320
|
-
</label>
|
|
321
|
-
```
|
|
322
|
-
---
|
|
323
|
-
|
|
324
|
-
## Component Conventions
|
|
325
|
-
|
|
326
|
-
> **CSS encoding**: internal CSS classes use short encoded names (e.g. `cx01`, `cx02`) per project convention.
|
|
1
|
+
## COMPONENT IDENTITY
|
|
2
|
+
- **Import**: `import { Checkbox } from 'solid-tom-ui';`
|
|
3
|
+
- **Export**: `Checkbox` (named export)
|
|
4
|
+
- **Framework**: SolidJS
|
|
5
|
+
- **Purpose**: Single `<input type="checkbox">` — **uncontrolled**: initial state via `defaultChecked`, internal DOM state drives truth thereafter
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## TYPE SIGNATURE
|
|
10
|
+
|
|
11
|
+
```ts
|
|
12
|
+
type CheckboxProps = {
|
|
13
|
+
defaultChecked: boolean; // REQUIRED — sets initial checked state via ref
|
|
14
|
+
id?: string; // auto-generated via createUniqueId() if omitted
|
|
15
|
+
name?: string; // for form submission grouping
|
|
16
|
+
value?: string; // form submission value (overridden when indeterminate)
|
|
17
|
+
indeterminate?: boolean; // renders dash/minus visual state; blocks toggling
|
|
18
|
+
disabled?: boolean; // prevents interaction
|
|
19
|
+
size?: 'xs' | 'sm' | 'md' | 'lg' | 'xl';
|
|
20
|
+
color?: 'default' | 'neutral' | 'primary' | 'secondary' | 'accent' | 'info' | 'success' | 'warning' | 'error';
|
|
21
|
+
class?: string; // extra classes on <input>
|
|
22
|
+
onChange?: (checked: boolean | null) => void;
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
## DEFAULT VALUES (via `mergeProps`)
|
|
29
|
+
|
|
30
|
+
| Prop | Default |
|
|
31
|
+
|----------------|--------------------------|
|
|
32
|
+
| `size` | `'xs'` |
|
|
33
|
+
| `color` | `'primary'` |
|
|
34
|
+
| `id` | `createUniqueId()` — auto-generated unique string |
|
|
35
|
+
| `defaultChecked` | `false` |
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## PROP REFERENCE
|
|
40
|
+
|
|
41
|
+
| Prop | Type | Required | Description |
|
|
42
|
+
|------------------|-----------------------------------------------------------------------|----------|-------------------------------------------------------------------------------------------|
|
|
43
|
+
| `defaultChecked` | `boolean` | ✅ YES | Sets initial `checked` state via DOM ref on mount — does NOT reactively update after mount |
|
|
44
|
+
| `id` | `string` | ❌ NO | `id` on `<input>` — auto-generated if omitted; used with external `<label for="...">` |
|
|
45
|
+
| `name` | `string` | ❌ NO | `name` attribute for native form grouping/submission |
|
|
46
|
+
| `value` | `string` | ❌ NO | `value` submitted with form data. Overridden to `'inteterminate'` when `indeterminate` is true |
|
|
47
|
+
| `indeterminate` | `boolean` | ❌ NO | Shows dash/minus visual; blocks user toggling; sets `data-indeterminate="true"` on input |
|
|
48
|
+
| `disabled` | `boolean` | ❌ NO | Disables the input; prevents `onChange` from firing |
|
|
49
|
+
| `size` | `'xs' \| 'sm' \| 'md' \| 'lg' \| 'xl'` | ❌ NO | Visual size of the checkbox |
|
|
50
|
+
| `color` | `'default' \| 'neutral' \| 'primary' \| 'secondary' \| 'accent' \| 'info' \| 'success' \| 'warning' \| 'error'` | ❌ NO | Checkbox fill color when checked |
|
|
51
|
+
| `class` | `string` | ❌ NO | Extra Tailwind classes appended directly to `<input>` |
|
|
52
|
+
| `onChange` | `(checked: boolean \| null) => void` | ❌ NO | Fires on change with `e.target.checked` value. NOT fired when `indeterminate` or `disabled` |
|
|
53
|
+
|
|
54
|
+
---
|
|
55
|
+
|
|
56
|
+
## SIZE REFERENCE
|
|
57
|
+
|
|
58
|
+
| Value | CSS `--size` | Pixel size |
|
|
59
|
+
|-------|-------------|------------|
|
|
60
|
+
| `'xs'`| `14px` | 14 × 14px |
|
|
61
|
+
| `'sm'`| `16px` | 16 × 16px |
|
|
62
|
+
| `'md'`| `18px` | 18 × 18px |
|
|
63
|
+
| `'lg'`| `20px` | 20 × 20px |
|
|
64
|
+
| `'xl'`| `22px` | 22 × 22px |
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
## COLOR REFERENCE
|
|
69
|
+
|
|
70
|
+
| Value | DaisyUI class | Fill color when checked |
|
|
71
|
+
|---------------|----------------------|------------------------------|
|
|
72
|
+
| `'default'` | *(no class)* | Default DaisyUI checkbox color |
|
|
73
|
+
| `'neutral'` | `checkbox-neutral` | Neutral |
|
|
74
|
+
| `'primary'` | `checkbox-primary` | Primary (default) |
|
|
75
|
+
| `'secondary'` | `checkbox-secondary` | Secondary |
|
|
76
|
+
| `'accent'` | `checkbox-accent` | Accent |
|
|
77
|
+
| `'info'` | `checkbox-info` | Info |
|
|
78
|
+
| `'success'` | `checkbox-success` | Success |
|
|
79
|
+
| `'warning'` | `checkbox-warning` | Warning |
|
|
80
|
+
| `'error'` | `checkbox-error` | Error |
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
|
|
84
|
+
## UNCONTROLLED BEHAVIOR — Critical for agents
|
|
85
|
+
|
|
86
|
+
This component is **uncontrolled** by design:
|
|
87
|
+
|
|
88
|
+
- `defaultChecked` sets `ref.checked = value` once at mount via a `ref` callback
|
|
89
|
+
- After mount, the DOM input's `checked` state is **the source of truth**
|
|
90
|
+
- There is **no reactive signal** tracking checked state internally
|
|
91
|
+
- Changing `defaultChecked` after mount does **nothing** — the DOM state is not updated
|
|
92
|
+
- To read current checked state, use `onChange` callback or query the DOM via `ref`
|
|
93
|
+
|
|
94
|
+
```tsx
|
|
95
|
+
// ✅ Correct: read state through onChange
|
|
96
|
+
const [checked, setChecked] = createSignal(false);
|
|
97
|
+
|
|
98
|
+
<Checkbox
|
|
99
|
+
defaultChecked={false}
|
|
100
|
+
onChange={val => setChecked(val)}
|
|
101
|
+
/>
|
|
102
|
+
|
|
103
|
+
// ❌ Wrong: changing defaultChecked after mount has no effect
|
|
104
|
+
const [init, setInit] = createSignal(false);
|
|
105
|
+
<Checkbox defaultChecked={init()} /> // reactive update ignored after first render
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
---
|
|
109
|
+
|
|
110
|
+
## INDETERMINATE STATE
|
|
111
|
+
|
|
112
|
+
When `indeterminate={true}`:
|
|
113
|
+
- Renders a **dash/minus** visual (clip-path polygon in CSS)
|
|
114
|
+
- `data-indeterminate="true"` is set on the `<input>`
|
|
115
|
+
- `value` prop is overridden to `'inteterminate'` (note: typo in source — single 'r')
|
|
116
|
+
- `onClick` calls `e.preventDefault()` — **user cannot toggle** the checkbox
|
|
117
|
+
- `onChange` is **never fired** (click is blocked)
|
|
118
|
+
- Useful for "select all" parent checkboxes when only some children are selected
|
|
119
|
+
|
|
120
|
+
```tsx
|
|
121
|
+
// Indeterminate "select all" pattern
|
|
122
|
+
const allChecked = () => items().every(i => i.checked);
|
|
123
|
+
const someChecked = () => items().some(i => i.checked);
|
|
124
|
+
|
|
125
|
+
<Checkbox
|
|
126
|
+
defaultChecked={allChecked()}
|
|
127
|
+
indeterminate={someChecked() && !allChecked()}
|
|
128
|
+
onChange={val => items().forEach(i => i.setChecked(val))}
|
|
129
|
+
/>
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
> ⚠️ Because `indeterminate` blocks user toggling, the state change must be driven externally (e.g. by updating items and re-rendering).
|
|
133
|
+
|
|
134
|
+
---
|
|
135
|
+
|
|
136
|
+
## ADDING A LABEL
|
|
137
|
+
|
|
138
|
+
`Checkbox` renders only an `<input>` — no label wrapper is included. Use a native `<label>` element:
|
|
139
|
+
|
|
140
|
+
### Label to the right (most common)
|
|
141
|
+
```tsx
|
|
142
|
+
<label class="flex cursor-pointer items-center gap-2">
|
|
143
|
+
<Checkbox defaultChecked={false} color="primary" size="md" />
|
|
144
|
+
<span>Accept terms</span>
|
|
145
|
+
</label>
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
### Label to the left
|
|
149
|
+
```tsx
|
|
150
|
+
<label class="flex cursor-pointer items-center gap-2">
|
|
151
|
+
<span>Accept terms</span>
|
|
152
|
+
<Checkbox defaultChecked={false} color="primary" size="md" />
|
|
153
|
+
</label>
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
### Label below
|
|
157
|
+
```tsx
|
|
158
|
+
<label class="flex w-fit cursor-pointer flex-col items-center gap-1">
|
|
159
|
+
<Checkbox defaultChecked={false} color="primary" size="md" />
|
|
160
|
+
<span class="text-sm">Agree</span>
|
|
161
|
+
</label>
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
### External label via `id`
|
|
165
|
+
```tsx
|
|
166
|
+
<label for="terms-cb" class="cursor-pointer text-sm">Accept terms</label>
|
|
167
|
+
<Checkbox id="terms-cb" defaultChecked={false} color="primary" />
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
> ℹ️ Always add `cursor-pointer` to `<label>` for correct UX.
|
|
171
|
+
|
|
172
|
+
---
|
|
173
|
+
|
|
174
|
+
## FORM USAGE
|
|
175
|
+
|
|
176
|
+
Use `name` and `value` props for native HTML form submission:
|
|
177
|
+
|
|
178
|
+
```tsx
|
|
179
|
+
<form onSubmit={e => {
|
|
180
|
+
e.preventDefault();
|
|
181
|
+
const data = new FormData(e.currentTarget);
|
|
182
|
+
console.log(Object.fromEntries(data.entries()));
|
|
183
|
+
}}>
|
|
184
|
+
<label class="flex cursor-pointer items-center gap-2">
|
|
185
|
+
<Checkbox name="interests" value="technology" defaultChecked={false} />
|
|
186
|
+
<span>Technology</span>
|
|
187
|
+
</label>
|
|
188
|
+
<label class="flex cursor-pointer items-center gap-2">
|
|
189
|
+
<Checkbox name="interests" value="design" defaultChecked={false} />
|
|
190
|
+
<span>Design</span>
|
|
191
|
+
</label>
|
|
192
|
+
<button type="submit">Submit</button>
|
|
193
|
+
</form>
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
> ⚠️ When `indeterminate={true}`, `value` is automatically overridden to `'inteterminate'` regardless of what was passed.
|
|
197
|
+
|
|
198
|
+
---
|
|
199
|
+
|
|
200
|
+
## INTERNAL DOM STRUCTURE
|
|
201
|
+
|
|
202
|
+
```
|
|
203
|
+
<input
|
|
204
|
+
type="checkbox"
|
|
205
|
+
id="{id | auto}"
|
|
206
|
+
class="checkbox checkbox-{size} checkbox-{color} [class]"
|
|
207
|
+
disabled={disabled}
|
|
208
|
+
name="{name}" ← only if name prop provided
|
|
209
|
+
data-indeterminate="true" ← only if indeterminate={true}
|
|
210
|
+
value="{value | 'inteterminate'}"
|
|
211
|
+
onClick={...} ← preventDefault when indeterminate or disabled
|
|
212
|
+
onChange={...} ← fires p.onChange with e.target.checked
|
|
213
|
+
/>
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
---
|
|
217
|
+
|
|
218
|
+
## BEHAVIOR NOTES FOR AGENTS
|
|
219
|
+
|
|
220
|
+
1. **Uncontrolled — `defaultChecked` is mount-only** — do not pass a reactive signal to `defaultChecked` expecting it to control the checkbox. Use `onChange` to lift state up.
|
|
221
|
+
|
|
222
|
+
2. **`id` is auto-generated** — every `Checkbox` without an explicit `id` gets a unique ID from SolidJS `createUniqueId()`. No collision risk, but the value is not predictable. Pass explicit `id` when you need `<label for="...">` linkage.
|
|
223
|
+
|
|
224
|
+
3. **`indeterminate` blocks both click and `onChange`** — `onClick` calls `e.preventDefault()`, so `onChange` never fires. The indeterminate state must be managed entirely by the parent.
|
|
225
|
+
|
|
226
|
+
4. **`disabled` and `indeterminate` together** — both conditions independently call `e.preventDefault()` in the same `onClick` handler. Either alone is sufficient to block toggling.
|
|
227
|
+
|
|
228
|
+
5. **`name` is conditionally spread** — if `name` is `undefined`, the attribute is NOT rendered on the DOM (using `{...(p.name && { name: p.name })}`). This avoids empty `name=""` on the input.
|
|
229
|
+
|
|
230
|
+
6. **`class` appends to generated classes** — CVA generates `checkbox checkbox-{size} checkbox-{color}`, then `p.class` is appended via `cn()`. Use for shape overrides (`rounded-full`), border tweaks, shadows, etc.
|
|
231
|
+
|
|
232
|
+
7. **`onChange` receives `boolean | null`** — the signature accepts `null` for future indeterminate support, but current implementation always passes `e.target.checked` (boolean). Handle both types defensively.
|
|
233
|
+
|
|
234
|
+
---
|
|
235
|
+
|
|
236
|
+
## COMMON MISTAKES TO AVOID
|
|
237
|
+
|
|
238
|
+
| Mistake | Correct approach |
|
|
239
|
+
|---|---|
|
|
240
|
+
| Treating `defaultChecked` as reactive | It's mount-only — use `onChange` to track state in a signal |
|
|
241
|
+
| Expecting `onChange` to fire when `indeterminate={true}` | `onClick` is blocked — `onChange` never fires in indeterminate state |
|
|
242
|
+
| Omitting `cursor-pointer` on wrapping `<label>` | Always add `cursor-pointer` to `<label>` for correct UX |
|
|
243
|
+
| Passing `value="inteterminate"` manually | When `indeterminate={true}`, value is auto-set — no need to pass it |
|
|
244
|
+
| Using `color="default"` expecting a specific color | `'default'` applies no color class — checkbox uses browser/DaisyUI base style |
|
|
245
|
+
| Relying on `id` being stable without explicit prop | Auto-generated IDs are unique but unpredictable — pass explicit `id` when needed for `<label for>` |
|
|
246
|
+
|
|
247
|
+
---
|
|
248
|
+
|
|
249
|
+
## FULL EXAMPLE — All features
|
|
250
|
+
|
|
251
|
+
```tsx
|
|
252
|
+
import { Checkbox } from 'solid-tom-ui';
|
|
253
|
+
import { createSignal } from 'solid-js';
|
|
254
|
+
|
|
255
|
+
// 1. Basic with label
|
|
256
|
+
<label class="flex cursor-pointer items-center gap-2">
|
|
257
|
+
<Checkbox defaultChecked={false} color="primary" size="md" />
|
|
258
|
+
<span>Accept terms and conditions</span>
|
|
259
|
+
</label>
|
|
260
|
+
|
|
261
|
+
// 2. Controlled state via onChange
|
|
262
|
+
const [agreed, setAgreed] = createSignal(false);
|
|
263
|
+
|
|
264
|
+
<label class="flex cursor-pointer items-center gap-2">
|
|
265
|
+
<Checkbox
|
|
266
|
+
defaultChecked={false}
|
|
267
|
+
color="success"
|
|
268
|
+
size="sm"
|
|
269
|
+
onChange={val => setAgreed(val)}
|
|
270
|
+
/>
|
|
271
|
+
<span>I agree ({agreed() ? 'Yes' : 'No'})</span>
|
|
272
|
+
</label>
|
|
273
|
+
|
|
274
|
+
// 3. Indeterminate — select all pattern
|
|
275
|
+
const [items, setItems] = createSignal([
|
|
276
|
+
{ label: 'Item A', checked: true },
|
|
277
|
+
{ label: 'Item B', checked: false },
|
|
278
|
+
]);
|
|
279
|
+
const allChecked = () => items().every(i => i.checked);
|
|
280
|
+
const someChecked = () => items().some(i => i.checked);
|
|
281
|
+
|
|
282
|
+
<label class="flex cursor-pointer items-center gap-2">
|
|
283
|
+
<Checkbox
|
|
284
|
+
defaultChecked={allChecked()}
|
|
285
|
+
indeterminate={someChecked() && !allChecked()}
|
|
286
|
+
color="primary"
|
|
287
|
+
size="md"
|
|
288
|
+
/>
|
|
289
|
+
<span class="font-semibold">Select all</span>
|
|
290
|
+
</label>
|
|
291
|
+
|
|
292
|
+
// 4. Disabled
|
|
293
|
+
<label class="flex cursor-pointer items-center gap-2 opacity-50">
|
|
294
|
+
<Checkbox defaultChecked={true} color="neutral" size="md" disabled />
|
|
295
|
+
<span>Cannot change</span>
|
|
296
|
+
</label>
|
|
297
|
+
|
|
298
|
+
// 5. Form with name + value
|
|
299
|
+
<form onSubmit={e => { e.preventDefault(); console.log([...new FormData(e.currentTarget)]); }}>
|
|
300
|
+
<label class="flex cursor-pointer items-center gap-2">
|
|
301
|
+
<Checkbox name="lang" value="typescript" defaultChecked={true} size="sm" />
|
|
302
|
+
<span>TypeScript</span>
|
|
303
|
+
</label>
|
|
304
|
+
<label class="flex cursor-pointer items-center gap-2">
|
|
305
|
+
<Checkbox name="lang" value="rust" defaultChecked={false} size="sm" />
|
|
306
|
+
<span>Rust</span>
|
|
307
|
+
</label>
|
|
308
|
+
<button type="submit" class="btn btn-sm btn-primary mt-2">Submit</button>
|
|
309
|
+
</form>
|
|
310
|
+
|
|
311
|
+
// 6. Custom styling
|
|
312
|
+
<label class="flex cursor-pointer items-center gap-2">
|
|
313
|
+
<Checkbox
|
|
314
|
+
defaultChecked={true}
|
|
315
|
+
color="accent"
|
|
316
|
+
size="lg"
|
|
317
|
+
class="rounded-full shadow-lg"
|
|
318
|
+
/>
|
|
319
|
+
<span>Rounded pill checkbox</span>
|
|
320
|
+
</label>
|
|
321
|
+
```
|
|
322
|
+
---
|
|
323
|
+
|
|
324
|
+
## Component Conventions
|
|
325
|
+
|
|
326
|
+
> **CSS encoding**: internal CSS classes use short encoded names (e.g. `cx01`, `cx02`) per project convention.
|