jsswift 1.0.45 → 1.0.47

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 (69) hide show
  1. package/dist/documentions/AI.md +85 -0
  2. package/dist/documentions/README.md +2 -0
  3. package/dist/documentions/ai-development.md +3 -1
  4. package/dist/documentions/components/alert.md +29 -493
  5. package/dist/documentions/components/app-shell.md +37 -524
  6. package/dist/documentions/components/avatar.md +47 -575
  7. package/dist/documentions/components/badge.md +27 -461
  8. package/dist/documentions/components/banner.md +35 -535
  9. package/dist/documentions/components/breadcrumbs.md +35 -518
  10. package/dist/documentions/components/btn.md +3 -21
  11. package/dist/documentions/components/button.md +3 -0
  12. package/dist/documentions/components/card-body.md +11 -328
  13. package/dist/documentions/components/card-footer.md +15 -367
  14. package/dist/documentions/components/card-header.md +15 -367
  15. package/dist/documentions/components/card.md +3 -19
  16. package/dist/documentions/components/checkbox.md +25 -456
  17. package/dist/documentions/components/chip.md +16 -393
  18. package/dist/documentions/components/col.md +57 -612
  19. package/dist/documentions/components/container.md +40 -535
  20. package/dist/documentions/components/context-menu.md +60 -696
  21. package/dist/documentions/components/date.md +56 -673
  22. package/dist/documentions/components/dialog.md +5 -21
  23. package/dist/documentions/components/drawer.md +48 -616
  24. package/dist/documentions/components/empty-state.md +28 -477
  25. package/dist/documentions/components/footer.md +42 -586
  26. package/dist/documentions/components/form-field.md +40 -568
  27. package/dist/documentions/components/form.md +7 -321
  28. package/dist/documentions/components/grid-col.md +42 -542
  29. package/dist/documentions/components/grid.md +40 -542
  30. package/dist/documentions/components/header.md +38 -547
  31. package/dist/documentions/components/icon.md +17 -370
  32. package/dist/documentions/components/input.md +4 -22
  33. package/dist/documentions/components/item.md +37 -533
  34. package/dist/documentions/components/kpi.md +34 -519
  35. package/dist/documentions/components/layout.md +81 -811
  36. package/dist/documentions/components/list.md +19 -405
  37. package/dist/documentions/components/loading-bar.md +58 -679
  38. package/dist/documentions/components/menu.md +62 -710
  39. package/dist/documentions/components/notify.md +34 -525
  40. package/dist/documentions/components/page.md +35 -526
  41. package/dist/documentions/components/pagination.md +3 -20
  42. package/dist/documentions/components/parallax.md +50 -633
  43. package/dist/documentions/components/popover.md +55 -661
  44. package/dist/documentions/components/progress.md +39 -554
  45. package/dist/documentions/components/radio.md +27 -470
  46. package/dist/documentions/components/rating.md +41 -574
  47. package/dist/documentions/components/route-tab.md +30 -491
  48. package/dist/documentions/components/row.md +35 -507
  49. package/dist/documentions/components/search.md +62 -723
  50. package/dist/documentions/components/select.md +17 -22
  51. package/dist/documentions/components/separator.md +7 -321
  52. package/dist/documentions/components/slider.md +49 -631
  53. package/dist/documentions/components/spacer.md +6 -314
  54. package/dist/documentions/components/spinner.md +25 -440
  55. package/dist/documentions/components/stat.md +32 -505
  56. package/dist/documentions/components/tab-panel.md +40 -563
  57. package/dist/documentions/components/table.md +3 -22
  58. package/dist/documentions/components/tabs.md +36 -538
  59. package/dist/documentions/components/time.md +29 -491
  60. package/dist/documentions/components/toggle.md +31 -498
  61. package/dist/documentions/components/toolbar.md +52 -640
  62. package/dist/documentions/components/tooltip.md +35 -535
  63. package/dist/documentions/knowledge-map.json +27 -2
  64. package/dist/documentions/reactivity.md +21 -7
  65. package/dist/documentions/ui/common-props.md +301 -0
  66. package/dist/jsswift.js +10544 -14103
  67. package/dist/jsswift.min.js +3 -3
  68. package/dist/min-jsswift.js +3 -3
  69. package/package.json +3 -2
@@ -1,824 +1,94 @@
1
1
  # Layout
2
2
 
3
- Exact JSswift UI metadata contract. Use only the props, slots, events, and methods documented below.
3
+ Exact JSswift UI contract. Shared definitions listed in `commonProps` are in [common props](../ui/common-props.md); all component-specific props, slots, events, and methods are below.
4
4
 
5
5
  ```json
6
6
  {
7
7
  "signature": "_.Layout(...children) | _.Layout(props, ...children)",
8
8
  "props": {
9
- "size": {
10
- "type": "string|number",
11
- "description": "Size token, number, or CSS length for sizing.",
12
- "default": null,
13
- "values": [
14
- "number",
15
- "CSS units",
16
- "xxs",
17
- "xs",
18
- "sm",
19
- "md",
20
- "lg",
21
- "xl",
22
- "xxl",
23
- "xxxl"
24
- ],
25
- "category": "style"
26
- },
27
- "color": {
28
- "type": "string",
29
- "description": "Semantic color name used to style the component.",
30
- "default": null,
31
- "values": [
32
- "primary",
33
- "secondary",
34
- "success",
35
- "warning",
36
- "danger",
37
- "info",
38
- "light",
39
- "dark"
40
- ],
41
- "category": "style"
42
- },
43
- "outline": {
44
- "type": "boolean",
45
- "description": "Uses outlined visual style.",
46
- "default": false,
47
- "values": [
48
- "number",
49
- "CSS units",
50
- "xxs",
51
- "xs",
52
- "sm",
53
- "md",
54
- "lg",
55
- "xl",
56
- "xxl",
57
- "xxxl"
58
- ],
59
- "category": "style"
60
- },
61
- "clickable": {
62
- "type": "boolean",
63
- "description": "Enables pointer/hover styles and click handling on the component.",
64
- "default": false,
65
- "values": null,
66
- "category": "behavior"
67
- },
68
- "padding": {
69
- "type": "string|number",
70
- "description": "Padding applied to the component root element.",
71
- "default": null,
72
- "values": [
73
- "number",
74
- "CSS units",
75
- "xxs",
76
- "xs",
77
- "sm",
78
- "md",
79
- "lg",
80
- "xl",
81
- "xxl",
82
- "xxxl"
83
- ],
84
- "category": "layout"
85
- },
86
- "margin": {
87
- "type": "string|number",
88
- "description": "Margin applied to the component root element.",
89
- "default": null,
90
- "values": [
91
- "number",
92
- "CSS units",
93
- "xxs",
94
- "xs",
95
- "sm",
96
- "md",
97
- "lg",
98
- "xl",
99
- "xxl",
100
- "xxxl"
101
- ],
102
- "category": "layout"
103
- },
104
- "width": {
105
- "type": "string|number",
106
- "description": "Explicit width (number interpreted as px or CSS length).",
107
- "default": null,
108
- "values": [
109
- "number",
110
- "CSS units",
111
- "xxs",
112
- "xs",
113
- "sm",
114
- "md",
115
- "lg",
116
- "xl",
117
- "xxl",
118
- "xxxl"
119
- ],
120
- "category": "layout"
121
- },
122
- "minWidth": {
123
- "type": "string|number",
124
- "description": "Minimum width constraint (number interpreted as px or CSS length).",
125
- "default": null,
126
- "values": [
127
- "number",
128
- "CSS units",
129
- "xxs",
130
- "xs",
131
- "sm",
132
- "md",
133
- "lg",
134
- "xl",
135
- "xxl",
136
- "xxxl"
137
- ],
138
- "category": "layout"
139
- },
140
- "maxWidth": {
141
- "type": "string|number",
142
- "description": "Maximum width constraint (number interpreted as px or CSS length).",
143
- "default": null,
144
- "values": [
145
- "number",
146
- "CSS units",
147
- "xxs",
148
- "xs",
149
- "sm",
150
- "md",
151
- "lg",
152
- "xl",
153
- "xxl",
154
- "xxxl"
155
- ],
156
- "category": "layout"
157
- },
158
- "height": {
159
- "type": "string|number",
160
- "description": "Explicit height (number interpreted as px or CSS length).",
161
- "default": null,
162
- "values": [
163
- "number",
164
- "CSS units",
165
- "xxs",
166
- "xs",
167
- "sm",
168
- "md",
169
- "lg",
170
- "xl",
171
- "xxl",
172
- "xxxl"
173
- ],
174
- "category": "layout"
175
- },
176
- "minHeight": {
177
- "type": "number|string",
178
- "description": "Minimum height constraint (number interpreted as px or CSS length).",
179
- "default": null,
180
- "values": [
181
- "number",
182
- "CSS units",
183
- "xxs",
184
- "xs",
185
- "sm",
186
- "md",
187
- "lg",
188
- "xl",
189
- "xxl",
190
- "xxxl"
191
- ],
192
- "category": "layout"
193
- },
194
- "maxHeight": {
195
- "type": "string|number",
196
- "description": "Maximum height constraint (number interpreted as px or CSS length).",
197
- "default": null,
198
- "values": [
199
- "number",
200
- "CSS units",
201
- "xxs",
202
- "xs",
203
- "sm",
204
- "md",
205
- "lg",
206
- "xl",
207
- "xxl",
208
- "xxxl"
209
- ],
210
- "category": "layout"
211
- },
212
- "radius": {
213
- "type": "string|number",
214
- "description": "Border radius token or CSS length applied to the component.",
215
- "default": null,
216
- "values": [
217
- "number",
218
- "CSS units",
219
- "xxs",
220
- "xs",
221
- "sm",
222
- "md",
223
- "lg",
224
- "xl",
225
- "xxl",
226
- "xxxl"
227
- ],
228
- "category": "style"
229
- },
230
- "borderRadius": {
231
- "type": "string|number",
232
- "description": "Border radius token or CSS length applied to the component.",
233
- "default": null,
234
- "values": [
235
- "number",
236
- "CSS units",
237
- "xxs",
238
- "xs",
239
- "sm",
240
- "md",
241
- "lg",
242
- "xl",
243
- "xxl",
244
- "xxxl"
245
- ],
246
- "category": "style"
247
- },
248
- "shadow": {
249
- "type": "string|boolean",
250
- "description": "Shadow token or CSS box-shadow string applied to the component.",
251
- "default": null,
252
- "values": [
253
- "none",
254
- "xxs",
255
- "xs",
256
- "sm",
257
- "md",
258
- "lg",
259
- "xl",
260
- "xxl",
261
- "xxxl"
262
- ],
263
- "category": "style"
264
- },
265
- "mobile": {
266
- "type": "{ disposition?, mode?, gap?, minHeight?, areas?, gridTemplateAreas?, drawerWidth?, navWidth?, drawerFloating?, navFloating?, noDrawer?, noNav? }",
267
- "description": "Responsive overrides applied at the base/mobile viewport.",
268
- "default": null,
269
- "values": null,
270
- "category": "layout"
271
- },
272
- "tablet": {
273
- "type": "{ disposition?, mode?, gap?, minHeight?, areas?, gridTemplateAreas?, drawerWidth?, navWidth?, drawerFloating?, navFloating?, noDrawer?, noNav? }",
274
- "description": "Responsive overrides applied from the tablet breakpoint upward.",
275
- "default": null,
276
- "values": null,
277
- "category": "layout"
278
- },
279
- "pc": {
280
- "type": "{ disposition?, mode?, gap?, minHeight?, areas?, gridTemplateAreas?, drawerWidth?, navWidth?, drawerFloating?, navFloating?, noDrawer?, noNav? }",
281
- "description": "Responsive overrides applied from the desktop breakpoint upward.",
282
- "default": null,
283
- "values": null,
284
- "category": "layout"
285
- },
286
- "class": {
287
- "type": "string",
288
- "description": "Additional CSS classes applied to the component root element.",
289
- "default": null,
290
- "values": null,
291
- "category": "style"
292
- },
293
- "style": {
294
- "type": "object",
295
- "description": "Inline styles applied to the component root element.",
296
- "default": null,
297
- "values": null,
298
- "category": "style"
299
- },
300
- "header": {
301
- "type": "Node|Function|Array",
302
- "description": "Header content node(s) or render function.",
303
- "default": null,
304
- "values": null,
305
- "category": "general"
306
- },
307
- "headerContent": {
308
- "type": "Node|Function|Array",
309
- "description": "Component configuration for \"headerContent\". When not handled internally, it is forwarded to the root element.",
310
- "default": null,
311
- "values": null,
312
- "category": "general"
313
- },
314
- "aside": {
315
- "type": "Node|Function|Array|false",
316
- "description": "Content or configuration for the aside/secondary region.",
317
- "default": null,
318
- "values": null,
319
- "category": "general"
320
- },
321
- "drawer": {
322
- "type": "Node|Function|Array|false",
323
- "description": "Content or configuration for the drawer region.",
324
- "default": null,
325
- "values": null,
326
- "category": "general"
327
- },
328
- "nav": {
329
- "type": "Node|Function|Array|false",
330
- "description": "Component configuration for \"nav\". When not handled internally, it is forwarded to the root element.",
331
- "default": null,
332
- "values": null,
333
- "category": "general"
334
- },
335
- "asideRight": {
336
- "type": "Node|Function|Array|false",
337
- "description": "Component configuration for \"asideRight\". When not handled internally, it is forwarded to the root element.",
338
- "default": null,
339
- "values": null,
340
- "category": "general"
341
- },
342
- "drawerRight": {
343
- "type": "Node|Function|Array|false",
344
- "description": "Component configuration for \"drawerRight\". When not handled internally, it is forwarded to the root element.",
345
- "default": null,
346
- "values": null,
347
- "category": "general"
348
- },
349
- "page": {
350
- "type": "Node|Function|Array",
351
- "description": "Current page index (1-based unless documented otherwise).",
352
- "default": null,
353
- "values": null,
354
- "category": "general"
355
- },
356
- "main": {
357
- "type": "Node|Function|Array",
358
- "description": "Component configuration for \"main\". When not handled internally, it is forwarded to the root element.",
359
- "default": null,
360
- "values": null,
361
- "category": "general"
362
- },
363
- "content": {
364
- "type": "Node|Function|Array",
365
- "description": "Main content node(s) or render function for the component body.",
366
- "default": null,
367
- "values": null,
368
- "category": "general"
369
- },
370
- "body": {
371
- "type": "Node|Function|Array",
372
- "description": "Component configuration for \"body\". When not handled internally, it is forwarded to the root element.",
373
- "default": null,
374
- "values": null,
375
- "category": "general"
376
- },
377
- "footer": {
378
- "type": "Node|Function|Array",
379
- "description": "Footer content node(s) or render function.",
380
- "default": null,
381
- "values": null,
382
- "category": "general"
383
- },
384
- "footerContent": {
385
- "type": "Node|Function|Array",
386
- "description": "Component configuration for \"footerContent\". When not handled internally, it is forwarded to the root element.",
387
- "default": null,
388
- "values": null,
389
- "category": "general"
390
- },
391
- "noDrawer": {
392
- "type": "boolean",
393
- "description": "Disables rendering of the drawer region.",
394
- "default": null,
395
- "values": null,
396
- "category": "general"
397
- },
398
- "drawerEnabled": {
399
- "type": "boolean",
400
- "description": "Component configuration for \"drawerEnabled\". When not handled internally, it is forwarded to the root element.",
401
- "default": null,
402
- "values": null,
403
- "category": "general"
404
- },
405
- "asideEnabled": {
406
- "type": "boolean",
407
- "description": "Component configuration for \"asideEnabled\". When not handled internally, it is forwarded to the root element.",
408
- "default": null,
409
- "values": null,
410
- "category": "general"
411
- },
412
- "noNav": {
413
- "type": "boolean",
414
- "description": "Component configuration for \"noNav\". When not handled internally, it is forwarded to the root element.",
415
- "default": null,
416
- "values": null,
417
- "category": "general"
418
- },
419
- "navEnabled": {
420
- "type": "boolean",
421
- "description": "Component configuration for \"navEnabled\". When not handled internally, it is forwarded to the root element.",
422
- "default": null,
423
- "values": null,
424
- "category": "general"
425
- },
426
- "asideRightEnabled": {
427
- "type": "boolean",
428
- "description": "Component configuration for \"asideRightEnabled\". When not handled internally, it is forwarded to the root element.",
429
- "default": null,
430
- "values": null,
431
- "category": "general"
432
- },
433
- "drawerOpen": {
434
- "type": "rod | [get,set] signal | boolean",
435
- "description": "Controls whether the drawer is open (controlled).",
436
- "default": null,
437
- "values": null,
438
- "category": "general"
439
- },
440
- "navOpen": {
441
- "type": "rod | [get,set] signal | boolean",
442
- "description": "Component configuration for \"navOpen\". When not handled internally, it is forwarded to the root element.",
443
- "default": null,
444
- "values": null,
445
- "category": "general"
446
- },
447
- "layoutBreakpoint": {
448
- "type": "number(px)",
449
- "description": "Component configuration for \"layoutBreakpoint\". When not handled internally, it is forwarded to the root element.",
450
- "default": null,
451
- "values": null,
452
- "category": "general"
453
- },
454
- "drawerBreakpoint": {
455
- "type": "number(px)",
456
- "description": "Viewport width where the drawer switches behavior (overlay vs persistent).",
457
- "default": null,
458
- "values": null,
459
- "category": "general"
460
- },
461
- "navBreakpoint": {
462
- "type": "number(px)",
463
- "description": "Component configuration for \"navBreakpoint\". When not handled internally, it is forwarded to the root element.",
464
- "default": null,
465
- "values": null,
466
- "category": "general"
467
- },
468
- "drawerWidth": {
469
- "type": "number|string",
470
- "description": "Drawer width (number interpreted as px or CSS length).",
471
- "default": null,
472
- "values": null,
473
- "category": "general"
474
- },
475
- "drawerResizable": {
476
- "type": "boolean",
477
- "description": "Component configuration for \"drawerResizable\". When not handled internally, it is forwarded to the root element.",
478
- "default": null,
479
- "values": null,
480
- "category": "general"
481
- },
482
- "drawerMinWidth": {
483
- "type": "number|string",
484
- "description": "Component configuration for \"drawerMinWidth\". When not handled internally, it is forwarded to the root element.",
485
- "default": null,
486
- "values": null,
487
- "category": "general"
488
- },
489
- "drawerMaxWidth": {
490
- "type": "number|string",
491
- "description": "Component configuration for \"drawerMaxWidth\". When not handled internally, it is forwarded to the root element.",
492
- "default": null,
493
- "values": null,
494
- "category": "general"
495
- },
496
- "navWidth": {
497
- "type": "number|string",
498
- "description": "Component configuration for \"navWidth\". When not handled internally, it is forwarded to the root element.",
499
- "default": null,
500
- "values": null,
501
- "category": "general"
502
- },
503
- "navResizable": {
504
- "type": "boolean",
505
- "description": "Component configuration for \"navResizable\". When not handled internally, it is forwarded to the root element.",
506
- "default": null,
507
- "values": null,
508
- "category": "general"
509
- },
510
- "navMinWidth": {
511
- "type": "number|string",
512
- "description": "Component configuration for \"navMinWidth\". When not handled internally, it is forwarded to the root element.",
513
- "default": null,
514
- "values": null,
515
- "category": "general"
516
- },
517
- "navMaxWidth": {
518
- "type": "number|string",
519
- "description": "Component configuration for \"navMaxWidth\". When not handled internally, it is forwarded to the root element.",
520
- "default": null,
521
- "values": null,
522
- "category": "general"
523
- },
524
- "asideRightWidth": {
525
- "type": "number|string",
526
- "description": "Component configuration for \"asideRightWidth\". When not handled internally, it is forwarded to the root element.",
527
- "default": null,
528
- "values": null,
529
- "category": "general"
530
- },
531
- "drawerPeek": {
532
- "type": "number|string",
533
- "description": "Component configuration for \"drawerPeek\". When not handled internally, it is forwarded to the root element.",
534
- "default": null,
535
- "values": null,
536
- "category": "general"
537
- },
538
- "navPeek": {
539
- "type": "number|string",
540
- "description": "Component configuration for \"navPeek\". When not handled internally, it is forwarded to the root element.",
541
- "default": null,
542
- "values": null,
543
- "category": "general"
544
- },
545
- "asideRightPeek": {
546
- "type": "number|string",
547
- "description": "Component configuration for \"asideRightPeek\". When not handled internally, it is forwarded to the root element.",
548
- "default": null,
549
- "values": null,
550
- "category": "general"
551
- },
552
- "drawerFloating": {
553
- "type": "boolean",
554
- "description": "Component configuration for \"drawerFloating\". When not handled internally, it is forwarded to the root element.",
555
- "default": null,
556
- "values": null,
557
- "category": "general"
558
- },
559
- "navFloating": {
560
- "type": "boolean",
561
- "description": "Component configuration for \"navFloating\". When not handled internally, it is forwarded to the root element.",
562
- "default": null,
563
- "values": null,
564
- "category": "general"
565
- },
566
- "overlayClose": {
567
- "type": "boolean",
568
- "description": "Closes the overlay when the backdrop is clicked.",
569
- "default": null,
570
- "values": null,
571
- "category": "general"
572
- },
573
- "escClose": {
574
- "type": "boolean",
575
- "description": "Alias for close-on-escape behavior.",
576
- "default": null,
577
- "values": null,
578
- "category": "general"
579
- },
580
- "stickyHeader": {
581
- "type": "boolean",
582
- "description": "Keeps the header region sticky during scroll.",
583
- "default": null,
584
- "values": null,
585
- "category": "general"
586
- },
587
- "stickyFooter": {
588
- "type": "boolean",
589
- "description": "Keeps the footer region sticky during scroll.",
590
- "default": null,
591
- "values": null,
592
- "category": "general"
593
- },
594
- "stickyAside": {
595
- "type": "boolean",
596
- "description": "Keeps the aside region sticky during scroll.",
597
- "default": null,
598
- "values": null,
599
- "category": "general"
600
- },
601
- "stickyNav": {
602
- "type": "boolean",
603
- "description": "Component configuration for \"stickyNav\". When not handled internally, it is forwarded to the root element.",
604
- "default": null,
605
- "values": null,
606
- "category": "general"
607
- },
608
- "tagPage": {
609
- "type": "boolean",
610
- "description": "Query parameter name used to read/write the current page.",
611
- "default": null,
612
- "values": null,
613
- "category": "general"
614
- },
615
- "mode": {
616
- "type": "local|global",
617
- "description": "Component configuration for \"mode\". When not handled internally, it is forwarded to the root element.",
618
- "default": null,
619
- "values": null,
620
- "category": "general"
621
- },
622
- "layoutMode": {
623
- "type": "alias di mode",
624
- "description": "Component configuration for \"layoutMode\". When not handled internally, it is forwarded to the root element.",
625
- "default": null,
626
- "values": null,
627
- "category": "general"
628
- },
629
- "disposition": {
630
- "type": "classic|classicRight|sidebarFullLeft|sidebarFullRight|appShell|dashboard|website|documentation|landing",
631
- "description": "Component configuration for \"disposition\". When not handled internally, it is forwarded to the root element.",
632
- "default": null,
633
- "values": null,
634
- "category": "general"
635
- },
636
- "layoutDisposition": {
637
- "type": "alias di disposition",
638
- "description": "Component configuration for \"layoutDisposition\". When not handled internally, it is forwarded to the root element.",
639
- "default": null,
640
- "values": null,
641
- "category": "general"
642
- },
643
- "layout": {
644
- "type": "alias di disposition",
645
- "description": "Component configuration for \"layout\". When not handled internally, it is forwarded to the root element.",
646
- "default": null,
647
- "values": null,
648
- "category": "general"
649
- },
650
- "gap": {
651
- "type": "number|string",
652
- "description": "Gap/spacing between child elements.",
653
- "default": null,
654
- "values": null,
655
- "category": "general"
656
- },
657
- "headerOffset": {
658
- "type": "number|string",
659
- "description": "Component configuration for \"headerOffset\". When not handled internally, it is forwarded to the root element.",
660
- "default": null,
661
- "values": null,
662
- "category": "general"
663
- },
664
- "areas": {
665
- "type": "string|array",
666
- "description": "Component configuration for \"areas\". When not handled internally, it is forwarded to the root element.",
667
- "default": null,
668
- "values": null,
669
- "category": "general"
670
- },
671
- "gridTemplateAreas": {
672
- "type": "string|array",
673
- "description": "Component configuration for \"gridTemplateAreas\". When not handled internally, it is forwarded to the root element.",
674
- "default": null,
675
- "values": null,
676
- "category": "general"
677
- },
678
- "templateAreas": {
679
- "type": "string|array",
680
- "description": "Component configuration for \"templateAreas\". When not handled internally, it is forwarded to the root element.",
681
- "default": null,
682
- "values": null,
683
- "category": "general"
684
- },
685
- "shellClass": {
686
- "type": "string",
687
- "description": "Component configuration for \"shellClass\". When not handled internally, it is forwarded to the root element.",
688
- "default": null,
689
- "values": null,
690
- "category": "general"
691
- },
692
- "headerClass": {
693
- "type": "string",
694
- "description": "Component configuration for \"headerClass\". When not handled internally, it is forwarded to the root element.",
695
- "default": null,
696
- "values": null,
697
- "category": "general"
698
- },
699
- "asideClass": {
700
- "type": "string",
701
- "description": "Component configuration for \"asideClass\". When not handled internally, it is forwarded to the root element.",
702
- "default": null,
703
- "values": null,
704
- "category": "general"
705
- },
706
- "navClass": {
707
- "type": "string",
708
- "description": "Component configuration for \"navClass\". When not handled internally, it is forwarded to the root element.",
709
- "default": null,
710
- "values": null,
711
- "category": "general"
712
- },
713
- "pageClass": {
714
- "type": "string",
715
- "description": "Component configuration for \"pageClass\". When not handled internally, it is forwarded to the root element.",
716
- "default": null,
717
- "values": null,
718
- "category": "general"
719
- },
720
- "footerClass": {
721
- "type": "string",
722
- "description": "Component configuration for \"footerClass\". When not handled internally, it is forwarded to the root element.",
723
- "default": null,
724
- "values": null,
725
- "category": "general"
726
- },
727
- "overlayClass": {
728
- "type": "string",
729
- "description": "Component configuration for \"overlayClass\". When not handled internally, it is forwarded to the root element.",
730
- "default": null,
731
- "values": null,
732
- "category": "general"
733
- },
734
- "slots": {
735
- "type": "{ header?, aside?, drawer?, nav?, asideRight?, drawerRight?, page?, main?, footer?, default? }",
736
- "description": "Named slots map for render overrides.",
737
- "default": null,
738
- "values": null,
739
- "category": "general"
740
- },
741
- "children": {
742
- "type": "Node|Array|Function",
743
- "description": "Default child content (nodes, arrays, or render function).",
744
- "default": null,
745
- "values": null,
746
- "category": "general"
747
- }
9
+ "minHeight": {"type": "number|string", "description": "Minimum height constraint (number interpreted as px or CSS length).", "default": null, "values": ["number", "CSS units", "xxs", "xs", "sm", "md", "lg", "xl", "xxl", "xxxl"], "category": "layout"},
10
+ "mobile": {"type": "{ disposition?, mode?, gap?, minHeight?, areas?, gridTemplateAreas?, drawerWidth?, navWidth?, drawerFloating?, navFloating?, noDrawer?, noNav? }", "description": "Responsive overrides applied at the base/mobile viewport.", "default": null, "values": null, "category": "layout"},
11
+ "tablet": {"type": "{ disposition?, mode?, gap?, minHeight?, areas?, gridTemplateAreas?, drawerWidth?, navWidth?, drawerFloating?, navFloating?, noDrawer?, noNav? }", "description": "Responsive overrides applied from the tablet breakpoint upward.", "default": null, "values": null, "category": "layout"},
12
+ "pc": {"type": "{ disposition?, mode?, gap?, minHeight?, areas?, gridTemplateAreas?, drawerWidth?, navWidth?, drawerFloating?, navFloating?, noDrawer?, noNav? }", "description": "Responsive overrides applied from the desktop breakpoint upward.", "default": null, "values": null, "category": "layout"},
13
+ "header": {"type": "Node|Function|Array", "description": "Header content node(s) or render function.", "default": null, "values": null, "category": "general"},
14
+ "headerContent": {"type": "Node|Function|Array", "description": "Component configuration for \"headerContent\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
15
+ "aside": {"type": "Node|Function|Array|false", "description": "Content or configuration for the aside/secondary region.", "default": null, "values": null, "category": "general"},
16
+ "drawer": {"type": "Node|Function|Array|false", "description": "Content or configuration for the drawer region.", "default": null, "values": null, "category": "general"},
17
+ "nav": {"type": "Node|Function|Array|false", "description": "Component configuration for \"nav\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
18
+ "asideRight": {"type": "Node|Function|Array|false", "description": "Component configuration for \"asideRight\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
19
+ "drawerRight": {"type": "Node|Function|Array|false", "description": "Component configuration for \"drawerRight\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
20
+ "page": {"type": "Node|Function|Array", "description": "Current page index (1-based unless documented otherwise).", "default": null, "values": null, "category": "general"},
21
+ "main": {"type": "Node|Function|Array", "description": "Component configuration for \"main\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
22
+ "content": {"type": "Node|Function|Array", "description": "Main content node(s) or render function for the component body.", "default": null, "values": null, "category": "general"},
23
+ "body": {"type": "Node|Function|Array", "description": "Component configuration for \"body\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
24
+ "footer": {"type": "Node|Function|Array", "description": "Footer content node(s) or render function.", "default": null, "values": null, "category": "general"},
25
+ "footerContent": {"type": "Node|Function|Array", "description": "Component configuration for \"footerContent\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
26
+ "noDrawer": {"type": "boolean", "description": "Disables rendering of the drawer region.", "default": null, "values": null, "category": "general"},
27
+ "drawerEnabled": {"type": "boolean", "description": "Component configuration for \"drawerEnabled\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
28
+ "asideEnabled": {"type": "boolean", "description": "Component configuration for \"asideEnabled\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
29
+ "noNav": {"type": "boolean", "description": "Component configuration for \"noNav\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
30
+ "navEnabled": {"type": "boolean", "description": "Component configuration for \"navEnabled\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
31
+ "asideRightEnabled": {"type": "boolean", "description": "Component configuration for \"asideRightEnabled\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
32
+ "drawerOpen": {"type": "rod | [get,set] signal | boolean", "description": "Controls whether the drawer is open (controlled).", "default": null, "values": null, "category": "general"},
33
+ "navOpen": {"type": "rod | [get,set] signal | boolean", "description": "Component configuration for \"navOpen\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
34
+ "layoutBreakpoint": {"type": "number(px)", "description": "Component configuration for \"layoutBreakpoint\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
35
+ "drawerBreakpoint": {"type": "number(px)", "description": "Viewport width where the drawer switches behavior (overlay vs persistent).", "default": null, "values": null, "category": "general"},
36
+ "navBreakpoint": {"type": "number(px)", "description": "Component configuration for \"navBreakpoint\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
37
+ "drawerWidth": {"type": "number|string", "description": "Drawer width (number interpreted as px or CSS length).", "default": null, "values": null, "category": "general"},
38
+ "drawerResizable": {"type": "boolean", "description": "Component configuration for \"drawerResizable\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
39
+ "drawerMinWidth": {"type": "number|string", "description": "Component configuration for \"drawerMinWidth\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
40
+ "drawerMaxWidth": {"type": "number|string", "description": "Component configuration for \"drawerMaxWidth\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
41
+ "navWidth": {"type": "number|string", "description": "Component configuration for \"navWidth\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
42
+ "navResizable": {"type": "boolean", "description": "Component configuration for \"navResizable\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
43
+ "navMinWidth": {"type": "number|string", "description": "Component configuration for \"navMinWidth\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
44
+ "navMaxWidth": {"type": "number|string", "description": "Component configuration for \"navMaxWidth\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
45
+ "asideRightWidth": {"type": "number|string", "description": "Component configuration for \"asideRightWidth\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
46
+ "drawerPeek": {"type": "number|string", "description": "Component configuration for \"drawerPeek\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
47
+ "navPeek": {"type": "number|string", "description": "Component configuration for \"navPeek\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
48
+ "asideRightPeek": {"type": "number|string", "description": "Component configuration for \"asideRightPeek\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
49
+ "drawerFloating": {"type": "boolean", "description": "Component configuration for \"drawerFloating\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
50
+ "navFloating": {"type": "boolean", "description": "Component configuration for \"navFloating\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
51
+ "overlayClose": {"type": "boolean", "description": "Closes the overlay when the backdrop is clicked.", "default": null, "values": null, "category": "general"},
52
+ "escClose": {"type": "boolean", "description": "Alias for close-on-escape behavior.", "default": null, "values": null, "category": "general"},
53
+ "stickyHeader": {"type": "boolean", "description": "Keeps the header region sticky during scroll.", "default": null, "values": null, "category": "general"},
54
+ "stickyFooter": {"type": "boolean", "description": "Keeps the footer region sticky during scroll.", "default": null, "values": null, "category": "general"},
55
+ "stickyAside": {"type": "boolean", "description": "Keeps the aside region sticky during scroll.", "default": null, "values": null, "category": "general"},
56
+ "stickyNav": {"type": "boolean", "description": "Component configuration for \"stickyNav\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
57
+ "tagPage": {"type": "boolean", "description": "Query parameter name used to read/write the current page.", "default": null, "values": null, "category": "general"},
58
+ "mode": {"type": "local|global", "description": "Component configuration for \"mode\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
59
+ "layoutMode": {"type": "alias di mode", "description": "Component configuration for \"layoutMode\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
60
+ "disposition": {"type": "classic|classicRight|sidebarFullLeft|sidebarFullRight|appShell|dashboard|website|documentation|landing", "description": "Component configuration for \"disposition\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
61
+ "layoutDisposition": {"type": "alias di disposition", "description": "Component configuration for \"layoutDisposition\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
62
+ "layout": {"type": "alias di disposition", "description": "Component configuration for \"layout\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
63
+ "gap": {"type": "number|string", "description": "Gap/spacing between child elements.", "default": null, "values": null, "category": "general"},
64
+ "headerOffset": {"type": "number|string", "description": "Component configuration for \"headerOffset\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
65
+ "areas": {"type": "string|array", "description": "Component configuration for \"areas\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
66
+ "gridTemplateAreas": {"type": "string|array", "description": "Component configuration for \"gridTemplateAreas\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
67
+ "templateAreas": {"type": "string|array", "description": "Component configuration for \"templateAreas\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
68
+ "shellClass": {"type": "string", "description": "Component configuration for \"shellClass\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
69
+ "headerClass": {"type": "string", "description": "Component configuration for \"headerClass\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
70
+ "asideClass": {"type": "string", "description": "Component configuration for \"asideClass\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
71
+ "navClass": {"type": "string", "description": "Component configuration for \"navClass\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
72
+ "pageClass": {"type": "string", "description": "Component configuration for \"pageClass\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
73
+ "footerClass": {"type": "string", "description": "Component configuration for \"footerClass\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
74
+ "overlayClass": {"type": "string", "description": "Component configuration for \"overlayClass\". When not handled internally, it is forwarded to the root element.", "default": null, "values": null, "category": "general"},
75
+ "slots": {"type": "{ header?, aside?, drawer?, nav?, asideRight?, drawerRight?, page?, main?, footer?, default? }", "description": "Named slots map for render overrides.", "default": null, "values": null, "category": "general"},
76
+ "children": {"type": "Node|Array|Function", "description": "Default child content (nodes, arrays, or render function).", "default": null, "values": null, "category": "general"}
748
77
  },
749
78
  "slots": {
750
- "header": {
751
- "type": "Header content",
752
- "description": "Slot for header content.",
753
- "default": null,
754
- "values": null,
755
- "category": "slot"
756
- },
757
- "aside": {
758
- "type": "Aside / drawer content",
759
- "description": "Slot for aside/secondary content.",
760
- "default": null,
761
- "values": null,
762
- "category": "slot"
763
- },
764
- "drawer": {
765
- "type": "Alias of aside",
766
- "description": "Slot for drawer content.",
767
- "default": null,
768
- "values": null,
769
- "category": "slot"
770
- },
771
- "nav": {
772
- "type": "Right-side panel content",
773
- "description": "Slot content for \"nav\". Accepts nodes, arrays, or render functions.",
774
- "default": null,
775
- "values": null,
776
- "category": "slot"
777
- },
778
- "asideRight": {
779
- "type": "Alias of nav",
780
- "description": "Slot content for \"asideRight\". Accepts nodes, arrays, or render functions.",
781
- "default": null,
782
- "values": null,
783
- "category": "slot"
784
- },
785
- "drawerRight": {
786
- "type": "Alias of nav",
787
- "description": "Slot content for \"drawerRight\". Accepts nodes, arrays, or render functions.",
788
- "default": null,
789
- "values": null,
790
- "category": "slot"
791
- },
792
- "page": {
793
- "type": "Page content",
794
- "description": "Slot for page indicator/content.",
795
- "default": null,
796
- "values": null,
797
- "category": "slot"
798
- },
799
- "main": {
800
- "type": "Alias of page",
801
- "description": "Slot content for \"main\". Accepts nodes, arrays, or render functions.",
802
- "default": null,
803
- "values": null,
804
- "category": "slot"
805
- },
806
- "footer": {
807
- "type": "Footer content",
808
- "description": "Slot for footer content.",
809
- "default": null,
810
- "values": null,
811
- "category": "slot"
812
- },
813
- "default": {
814
- "type": "Fallback page content",
815
- "description": "Primary content for the component.",
816
- "default": null,
817
- "values": null,
818
- "category": "slot"
819
- }
79
+ "header": {"type": "Header content", "description": "Slot for header content.", "default": null, "values": null, "category": "slot"},
80
+ "aside": {"type": "Aside / drawer content", "description": "Slot for aside/secondary content.", "default": null, "values": null, "category": "slot"},
81
+ "drawer": {"type": "Alias of aside", "description": "Slot for drawer content.", "default": null, "values": null, "category": "slot"},
82
+ "nav": {"type": "Right-side panel content", "description": "Slot content for \"nav\". Accepts nodes, arrays, or render functions.", "default": null, "values": null, "category": "slot"},
83
+ "asideRight": {"type": "Alias of nav", "description": "Slot content for \"asideRight\". Accepts nodes, arrays, or render functions.", "default": null, "values": null, "category": "slot"},
84
+ "drawerRight": {"type": "Alias of nav", "description": "Slot content for \"drawerRight\". Accepts nodes, arrays, or render functions.", "default": null, "values": null, "category": "slot"},
85
+ "page": {"type": "Page content", "description": "Slot for page indicator/content.", "default": null, "values": null, "category": "slot"},
86
+ "main": {"type": "Alias of page", "description": "Slot content for \"main\". Accepts nodes, arrays, or render functions.", "default": null, "values": null, "category": "slot"},
87
+ "footer": {"type": "Footer content", "description": "Slot for footer content.", "default": null, "values": null, "category": "slot"},
88
+ "default": {"type": "Fallback page content", "description": "Primary content for the component.", "default": null, "values": null, "category": "slot"}
820
89
  },
821
90
  "returns": "HTMLDivElement with openAside/closeAside/toggleAside/openNav/closeNav/toggleNav methods, isDrawerOpen/isNavOpen/isMobile/reflow, header()/aside()/nav()/page()/footer(), headerUpdate/asideUpdate/navUpdate/pageUpdate/mainUpdate/footerUpdate and _dispose()",
822
- "description": "Composable shell layout with independent left drawer and right nav, configurable widths, optional resize with min/max, optional floating mode, and runtime section updates."
91
+ "description": "Composable shell layout with independent left drawer and right nav, configurable widths, optional resize with min/max, optional floating mode, and runtime section updates.",
92
+ "commonProps": {"path": "ui/common-props.md", "keys": ["size", "color", "outline", "clickable", "padding", "margin", "width", "minWidth", "maxWidth", "height", "maxHeight", "radius", "borderRadius", "shadow", "class", "style"]}
823
93
  }
824
94
  ```