@primereact/mcp 11.0.0 → 11.2.0

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 (189) hide show
  1. package/data/llms/headless/components/accordion/api.json +9 -9
  2. package/data/llms/headless/components/animateonscroll/api.json +2 -2
  3. package/data/llms/headless/components/autocomplete/api.json +33 -33
  4. package/data/llms/headless/components/avatar/api.json +1 -1
  5. package/data/llms/headless/components/carousel/api.json +15 -15
  6. package/data/llms/headless/components/checkbox/api.json +18 -18
  7. package/data/llms/headless/components/collapsible/api.json +14 -14
  8. package/data/llms/headless/components/compare/api.json +3 -3
  9. package/data/llms/headless/components/contextmenu/api.json +2 -2
  10. package/data/llms/headless/components/datatable/api.json +19 -19
  11. package/data/llms/headless/components/dataview/api.json +3 -3
  12. package/data/llms/headless/components/datepicker/api.json +43 -43
  13. package/data/llms/headless/components/dialog/api.json +19 -19
  14. package/data/llms/headless/components/divider/api.json +3 -3
  15. package/data/llms/headless/components/drawer/api.json +13 -13
  16. package/data/llms/headless/components/fieldset/api.json +9 -9
  17. package/data/llms/headless/components/fileupload/api.json +5 -5
  18. package/data/llms/headless/components/focustrap/api.json +4 -4
  19. package/data/llms/headless/components/gallery/api.json +23 -23
  20. package/data/llms/headless/components/inplace/api.json +3 -3
  21. package/data/llms/headless/components/inputcolor/api.json +6 -6
  22. package/data/llms/headless/components/inputcolor.md +0 -1
  23. package/data/llms/headless/components/inputnumber/api.json +8 -8
  24. package/data/llms/headless/components/inputotp/api.json +7 -7
  25. package/data/llms/headless/components/inputpassword/api.json +4 -4
  26. package/data/llms/headless/components/inputpassword.md +3 -3
  27. package/data/llms/headless/components/inputtags/api.json +8 -8
  28. package/data/llms/headless/components/inputtext/api.json +1 -1
  29. package/data/llms/headless/components/knob/api.json +18 -18
  30. package/data/llms/headless/components/listbox/api.json +27 -27
  31. package/data/llms/headless/components/menu/api.json +10 -10
  32. package/data/llms/headless/components/message/api.json +1 -1
  33. package/data/llms/headless/components/metergroup/api.json +3 -3
  34. package/data/llms/headless/components/motion/api.json +1 -1
  35. package/data/llms/headless/components/navigationmenu/api.json +5 -5
  36. package/data/llms/headless/components/orderlist/api.json +5 -5
  37. package/data/llms/headless/components/organizationchart/api.json +6 -6
  38. package/data/llms/headless/components/paginator/api.json +5 -5
  39. package/data/llms/headless/components/panel/api.json +9 -9
  40. package/data/llms/headless/components/picklist/api.json +5 -5
  41. package/data/llms/headless/components/popover/api.json +16 -16
  42. package/data/llms/headless/components/positioner/api.json +7 -7
  43. package/data/llms/headless/components/progressbar/api.json +3 -3
  44. package/data/llms/headless/components/progressspinner/api.json +3 -3
  45. package/data/llms/headless/components/radiobutton/api.json +16 -16
  46. package/data/llms/headless/components/rating/api.json +5 -5
  47. package/data/llms/headless/components/scrollarea/api.json +6 -6
  48. package/data/llms/headless/components/select/api.json +34 -34
  49. package/data/llms/headless/components/sidebar/api.json +1116 -141
  50. package/data/llms/headless/components/sidebar.md +4 -2
  51. package/data/llms/headless/components/slider/api.json +3 -3
  52. package/data/llms/headless/components/speeddial/api.json +4 -4
  53. package/data/llms/headless/components/splitter/api.json +5 -5
  54. package/data/llms/headless/components/stepper/api.json +13 -13
  55. package/data/llms/headless/components/styleclass/api.json +1 -1
  56. package/data/llms/headless/components/tabs/api.json +17 -17
  57. package/data/llms/headless/components/terminal/api.json +1 -1
  58. package/data/llms/headless/components/toast/api.json +4 -4
  59. package/data/llms/headless/components/togglebutton/api.json +27 -3
  60. package/data/llms/headless/components/toggleswitch/api.json +3 -3
  61. package/data/llms/headless/components/tooltip/api.json +17 -17
  62. package/data/llms/headless/components/tree/api.json +20 -20
  63. package/data/llms/headless/components/tree.md +1 -0
  64. package/data/llms/headless/components/treetable/api.json +19 -19
  65. package/data/llms/headless/guides/misc/internationalization.md +282 -0
  66. package/data/llms/hooks/use-filter.md +2 -2
  67. package/data/llms/hooks/use-tree-filter.md +3 -1
  68. package/data/llms/llms-full.txt +10444 -1743
  69. package/data/llms/llms.txt +15 -0
  70. package/data/llms/primitive/components/accordion/api.json +39 -39
  71. package/data/llms/primitive/components/animateonscroll/api.json +5 -5
  72. package/data/llms/primitive/components/autocomplete/api.json +105 -105
  73. package/data/llms/primitive/components/avatar/api.json +14 -14
  74. package/data/llms/primitive/components/badge/api.json +6 -6
  75. package/data/llms/primitive/components/breadcrumb/api.json +27 -27
  76. package/data/llms/primitive/components/button/api.json +8 -8
  77. package/data/llms/primitive/components/buttongroup/api.json +3 -3
  78. package/data/llms/primitive/components/card/api.json +24 -24
  79. package/data/llms/primitive/components/carousel/api.json +28 -28
  80. package/data/llms/primitive/components/checkbox/api.json +14 -14
  81. package/data/llms/primitive/components/checkboxgroup/api.json +5 -5
  82. package/data/llms/primitive/components/chip/api.json +19 -19
  83. package/data/llms/primitive/components/collapsible/api.json +18 -18
  84. package/data/llms/primitive/components/compare/api.json +18 -18
  85. package/data/llms/primitive/components/contextmenu/api.json +150 -1141
  86. package/data/llms/primitive/components/datatable/api.json +215 -164
  87. package/data/llms/primitive/components/dataview/api.json +17 -17
  88. package/data/llms/primitive/components/datepicker/api.json +230 -230
  89. package/data/llms/primitive/components/dialog/api.json +63 -63
  90. package/data/llms/primitive/components/divider/api.json +3 -3
  91. package/data/llms/primitive/components/drawer/api.json +47 -47
  92. package/data/llms/primitive/components/fieldset/api.json +31 -31
  93. package/data/llms/primitive/components/fileupload/api.json +53 -53
  94. package/data/llms/primitive/components/floatlabel/api.json +3 -3
  95. package/data/llms/primitive/components/focustrap/api.json +7 -7
  96. package/data/llms/primitive/components/gallery/api.json +91 -91
  97. package/data/llms/primitive/components/iconfield/api.json +7 -7
  98. package/data/llms/primitive/components/iftalabel/api.json +3 -3
  99. package/data/llms/primitive/components/inplace/api.json +18 -18
  100. package/data/llms/primitive/components/inputcolor/api.json +51 -51
  101. package/data/llms/primitive/components/inputnumber/api.json +10 -10
  102. package/data/llms/primitive/components/inputotp/api.json +12 -12
  103. package/data/llms/primitive/components/inputpassword/api.json +7 -7
  104. package/data/llms/primitive/components/inputtags/api.json +6 -6
  105. package/data/llms/primitive/components/inputtext/api.json +4 -4
  106. package/data/llms/primitive/components/knob/api.json +19 -19
  107. package/data/llms/primitive/components/label/api.json +3 -3
  108. package/data/llms/primitive/components/listbox/api.json +57 -57
  109. package/data/llms/primitive/components/menu/api.json +87 -279
  110. package/data/llms/primitive/components/message/api.json +22 -22
  111. package/data/llms/primitive/components/metergroup/api.json +27 -27
  112. package/data/llms/primitive/components/navigationmenu/api.json +8 -8
  113. package/data/llms/primitive/components/paginator/api.json +43 -43
  114. package/data/llms/primitive/components/panel/api.json +34 -34
  115. package/data/llms/primitive/components/popover/api.json +67 -67
  116. package/data/llms/primitive/components/portal/api.json +4 -4
  117. package/data/llms/primitive/components/progressbar/api.json +22 -22
  118. package/data/llms/primitive/components/progressspinner/api.json +18 -18
  119. package/data/llms/primitive/components/radiobutton/api.json +16 -16
  120. package/data/llms/primitive/components/rating/api.json +20 -20
  121. package/data/llms/primitive/components/scrollarea/api.json +23 -23
  122. package/data/llms/primitive/components/select/api.json +95 -95
  123. package/data/llms/primitive/components/sidebar/api.json +215 -121
  124. package/data/llms/primitive/components/sidebar.md +2 -1
  125. package/data/llms/primitive/components/skeleton/api.json +3 -3
  126. package/data/llms/primitive/components/slider/api.json +22 -22
  127. package/data/llms/primitive/components/speeddial/api.json +22 -22
  128. package/data/llms/primitive/components/splitter/api.json +18 -18
  129. package/data/llms/primitive/components/stepper/api.json +64 -64
  130. package/data/llms/primitive/components/tabs/api.json +51 -51
  131. package/data/llms/primitive/components/tag/api.json +3 -3
  132. package/data/llms/primitive/components/terminal/api.json +44 -44
  133. package/data/llms/primitive/components/textarea/api.json +4 -4
  134. package/data/llms/primitive/components/timeline/api.json +27 -27
  135. package/data/llms/primitive/components/toast/api.json +48 -48
  136. package/data/llms/primitive/components/togglebutton/api.json +10 -10
  137. package/data/llms/primitive/components/togglebuttongroup/api.json +5 -5
  138. package/data/llms/primitive/components/toggleswitch/api.json +12 -12
  139. package/data/llms/primitive/components/toolbar/api.json +15 -15
  140. package/data/llms/primitive/components/tooltip/api.json +52 -52
  141. package/data/llms/primitive/components/tree/api.json +73 -73
  142. package/data/llms/primitive/components/visuallyhidden/api.json +3 -3
  143. package/data/llms/primitive/guides/migration/updating-to-v11.md +2219 -0
  144. package/data/llms/primitive/guides/misc/internationalization.md +287 -0
  145. package/data/llms/styled/add-ons/designer/ci.md +273 -0
  146. package/data/llms/styled/add-ons/designer/guide.md +99 -0
  147. package/data/llms/styled/add-ons/designer/overview.md +194 -0
  148. package/data/llms/styled/add-ons/uikit/guide/v3.md +182 -0
  149. package/data/llms/styled/add-ons/uikit/guide/v4.md +163 -0
  150. package/data/llms/styled/add-ons/uikit/overview.md +204 -0
  151. package/data/llms/styled/components/button/api.json +8 -8
  152. package/data/llms/styled/components/carousel.md +65 -0
  153. package/data/llms/styled/components/datatable.md +101 -88
  154. package/data/llms/styled/components/floatlabel/api.json +3 -3
  155. package/data/llms/styled/components/fluid/api.json +3 -3
  156. package/data/llms/styled/components/iconfield/api.json +7 -7
  157. package/data/llms/styled/components/iftalabel/api.json +3 -3
  158. package/data/llms/styled/components/inputcolor.md +3 -0
  159. package/data/llms/styled/components/inputgroup/api.json +7 -7
  160. package/data/llms/styled/components/label/api.json +3 -3
  161. package/data/llms/styled/components/menu.md +39 -41
  162. package/data/llms/styled/components/organizationchart/api.json +33 -33
  163. package/data/llms/styled/components/rating/api.json +11 -11
  164. package/data/llms/styled/components/select.md +6 -0
  165. package/data/llms/styled/components/sidebar.md +12 -8
  166. package/data/llms/styled/components/tree.md +5 -0
  167. package/data/llms/styled/components/treetable.md +171 -62
  168. package/data/llms/styled/guides/configuration.md +223 -0
  169. package/data/llms/styled/guides/form/formik.md +448 -0
  170. package/data/llms/styled/guides/form/react-hook-form.md +503 -0
  171. package/data/llms/styled/guides/form/tanstack.md +502 -0
  172. package/data/llms/styled/guides/migration/updating-to-v11.md +2219 -0
  173. package/data/llms/styled/guides/misc/internationalization.md +379 -0
  174. package/data/llms/styled/guides/theming/tailwind.md +25 -0
  175. package/data/llms/tailwind/components/button/api.json +8 -8
  176. package/data/llms/tailwind/components/datatable.md +33 -42
  177. package/data/llms/tailwind/components/inputgroup.md +0 -1
  178. package/data/llms/tailwind/components/menu.md +5 -5
  179. package/data/llms/tailwind/components/select.md +3 -0
  180. package/data/llms/tailwind/components/sidebar.md +16 -11
  181. package/data/llms/tailwind/components/tooltip.md +4 -13
  182. package/data/llms/tailwind/guides/misc/internationalization.md +287 -0
  183. package/data/manifest.json +1089 -779
  184. package/data/mcp-data.json +263 -32
  185. package/dist/index.d.ts +7 -2
  186. package/dist/index.js +1 -1
  187. package/package.json +9 -8
  188. package/data/llms/styled/guides/installation/configuration.md +0 -135
  189. package/data/llms/tailwind/guides/theming/guide.md +0 -179
@@ -17,135 +17,1006 @@
17
17
  },
18
18
  {
19
19
  "name": "value",
20
+ "type": "undefined | boolean",
21
+ "default": "",
22
+ "description": "The value of the sidebar open state."
23
+ }
24
+ ],
25
+ "methods": []
26
+ },
27
+ "UseSidebarProps": {
28
+ "description": "Defines valid properties in useSidebar.",
29
+ "relatedProp": "",
30
+ "props": [
31
+ {
32
+ "name": "layout",
33
+ "type": "null | UseSidebarLayoutExposes",
34
+ "default": "",
35
+ "description": "Layout context for registering/notifying within a Sidebar.Layout."
36
+ },
37
+ {
38
+ "name": "id",
39
+ "type": "string",
40
+ "default": "",
41
+ "description": "Unique identifier for the sidebar, used by Trigger target."
42
+ },
43
+ {
44
+ "name": "side",
45
+ "type": "SidebarSide",
46
+ "default": "'left'",
47
+ "description": "Sidebar position."
48
+ },
49
+ {
50
+ "name": "variant",
51
+ "type": "SidebarVariant",
52
+ "default": "'sidebar'",
53
+ "description": "Visual variant of the sidebar."
54
+ },
55
+ {
56
+ "name": "collapsible",
57
+ "type": "SidebarCollapsible",
58
+ "default": "'icon'",
59
+ "description": "Collapse behavior."
60
+ },
61
+ {
62
+ "name": "overlay",
63
+ "type": "boolean",
64
+ "default": "false",
65
+ "description": "Whether the sidebar overlays content instead of pushing it."
66
+ },
67
+ {
68
+ "name": "open",
69
+ "type": "boolean",
70
+ "default": "",
71
+ "description": "Controls the open state of the sidebar."
72
+ },
73
+ {
74
+ "name": "defaultOpen",
75
+ "type": "boolean",
76
+ "default": "true",
77
+ "description": "Initial open state."
78
+ },
79
+ {
80
+ "name": "onOpenChange",
81
+ "type": "(event: UseSidebarOpenChangeEvent) => void",
82
+ "default": "",
83
+ "description": "Callback when the open state changes."
84
+ },
85
+ {
86
+ "name": "openOnHover",
87
+ "type": "boolean",
88
+ "default": "false",
89
+ "description": "Whether the sidebar opens on hover."
90
+ },
91
+ {
92
+ "name": "hoverOpenDelay",
93
+ "type": "number",
94
+ "default": "50",
95
+ "description": "Delay before opening on hover (ms)."
96
+ },
97
+ {
98
+ "name": "hoverCloseDelay",
99
+ "type": "number",
100
+ "default": "100",
101
+ "description": "Delay before closing on hover leave (ms)."
102
+ },
103
+ {
104
+ "name": "dismissable",
105
+ "type": "boolean",
106
+ "default": "true",
107
+ "description": "Whether clicking the backdrop closes the sidebar."
108
+ },
109
+ {
110
+ "name": "hideOnOutsideClick",
111
+ "type": "boolean",
112
+ "default": "true",
113
+ "description": "When `overlay` is true, clicking inside the `Sidebar.Main` area collapses the sidebar.\nClicks on a `Sidebar.Trigger` are excluded so opening via the trigger is not immediately undone."
114
+ },
115
+ {
116
+ "name": "closeOnEscape",
117
+ "type": "boolean",
118
+ "default": "true",
119
+ "description": "When `overlay` is true, pressing Escape collapses the sidebar."
120
+ },
121
+ {
122
+ "name": "width",
123
+ "type": "string",
124
+ "default": "'16rem'",
125
+ "description": "Sidebar width when expanded."
126
+ },
127
+ {
128
+ "name": "iconWidth",
129
+ "type": "string",
130
+ "default": "'3rem'",
131
+ "description": "Sidebar width when collapsed to icon mode."
132
+ }
133
+ ],
134
+ "methods": []
135
+ },
136
+ "UseSidebarState": {
137
+ "description": "Defines valid state in useSidebar.",
138
+ "relatedProp": "",
139
+ "props": [
140
+ {
141
+ "name": "open",
142
+ "type": "boolean",
143
+ "default": "",
144
+ "description": "Whether the sidebar is open."
145
+ },
146
+ {
147
+ "name": "displayState",
148
+ "type": "\"expanded\" | \"collapsed\"",
149
+ "default": "",
150
+ "description": "The current display state."
151
+ }
152
+ ],
153
+ "methods": []
154
+ },
155
+ "UseSidebarRootProps": {
156
+ "description": "Pre-built props for the sidebar root element.",
157
+ "relatedProp": "",
158
+ "props": [
159
+ {
160
+ "name": "ref",
161
+ "type": "(node: null | HTMLElement) => void",
162
+ "default": "",
163
+ "description": "Ref callback for the root element."
164
+ },
165
+ {
166
+ "name": "id",
167
+ "type": "string",
168
+ "default": "",
169
+ "description": "The sidebar id, when provided."
170
+ },
171
+ {
172
+ "name": "data-scope",
173
+ "type": "string",
174
+ "default": "",
175
+ "description": "Component scope identifier."
176
+ },
177
+ {
178
+ "name": "data-part",
179
+ "type": "string",
180
+ "default": "",
181
+ "description": "Component part identifier."
182
+ },
183
+ {
184
+ "name": "data-state",
185
+ "type": "string",
186
+ "default": "",
187
+ "description": "Reflects the expanded/collapsed display state."
188
+ },
189
+ {
190
+ "name": "data-collapsible",
191
+ "type": "undefined | string",
192
+ "default": "",
193
+ "description": "Active collapsible mode while collapsed, otherwise empty."
194
+ },
195
+ {
196
+ "name": "data-collapsible-mode",
197
+ "type": "undefined | string",
198
+ "default": "",
199
+ "description": "The configured collapsible mode."
200
+ },
201
+ {
202
+ "name": "data-variant",
203
+ "type": "undefined | string",
204
+ "default": "",
205
+ "description": "The sidebar variant."
206
+ },
207
+ {
208
+ "name": "data-side",
209
+ "type": "undefined | string",
210
+ "default": "",
211
+ "description": "The sidebar side."
212
+ },
213
+ {
214
+ "name": "data-overlay",
215
+ "type": "string",
216
+ "default": "",
217
+ "description": "Present while the sidebar is an overlay."
218
+ },
219
+ {
220
+ "name": "role",
221
+ "type": "\"dialog\"",
222
+ "default": "",
223
+ "description": "Dialog role while the sidebar is a modal overlay."
224
+ },
225
+ {
226
+ "name": "aria-modal",
227
+ "type": "boolean",
228
+ "default": "",
229
+ "description": "Modal flag while the overlay is open."
230
+ },
231
+ {
232
+ "name": "style",
233
+ "type": "CSSProperties",
234
+ "default": "",
235
+ "description": "Inline CSS custom properties for the sidebar sizing."
236
+ },
237
+ {
238
+ "name": "onKeyDown",
239
+ "type": "(event: KeyboardEvent<HTMLElement>) => void",
240
+ "default": "",
241
+ "description": "Keydown handler (escape close + menu tree navigation)."
242
+ },
243
+ {
244
+ "name": "onPointerEnter",
245
+ "type": "(event?: SyntheticEvent<Element, Event>) => void",
246
+ "default": "",
247
+ "description": "Pointer-enter handler, present when openOnHover is enabled."
248
+ },
249
+ {
250
+ "name": "onPointerLeave",
251
+ "type": "(event?: SyntheticEvent<Element, Event>) => void",
252
+ "default": "",
253
+ "description": "Pointer-leave handler, present when openOnHover is enabled."
254
+ }
255
+ ],
256
+ "methods": []
257
+ },
258
+ "UseSidebarSpacerProps": {
259
+ "description": "Pre-built props for the sidebar spacer element.",
260
+ "relatedProp": "",
261
+ "props": [
262
+ {
263
+ "name": "data-scope",
264
+ "type": "string",
265
+ "default": "",
266
+ "description": "Component scope identifier."
267
+ },
268
+ {
269
+ "name": "data-part",
270
+ "type": "string",
271
+ "default": "",
272
+ "description": "Component part identifier."
273
+ },
274
+ {
275
+ "name": "data-state",
276
+ "type": "string",
277
+ "default": "",
278
+ "description": "Reflects the expanded/collapsed display state."
279
+ },
280
+ {
281
+ "name": "data-collapsible",
282
+ "type": "undefined | string",
283
+ "default": "",
284
+ "description": "Active collapsible mode while collapsed, otherwise empty."
285
+ },
286
+ {
287
+ "name": "data-variant",
288
+ "type": "undefined | string",
289
+ "default": "",
290
+ "description": "The sidebar variant."
291
+ },
292
+ {
293
+ "name": "data-side",
294
+ "type": "undefined | string",
295
+ "default": "",
296
+ "description": "The sidebar side."
297
+ },
298
+ {
299
+ "name": "data-overlay",
300
+ "type": "string",
301
+ "default": "",
302
+ "description": "Present while the sidebar is an overlay."
303
+ }
304
+ ],
305
+ "methods": []
306
+ },
307
+ "UseSidebarAsideProps": {
308
+ "description": "Pre-built props for the sidebar aside element.",
309
+ "relatedProp": "",
310
+ "props": [
311
+ {
312
+ "name": "data-scope",
313
+ "type": "string",
314
+ "default": "",
315
+ "description": "Component scope identifier."
316
+ },
317
+ {
318
+ "name": "data-part",
319
+ "type": "string",
320
+ "default": "",
321
+ "description": "Component part identifier."
322
+ },
323
+ {
324
+ "name": "data-state",
325
+ "type": "string",
326
+ "default": "",
327
+ "description": "Reflects the expanded/collapsed display state."
328
+ },
329
+ {
330
+ "name": "data-collapsible",
331
+ "type": "undefined | string",
332
+ "default": "",
333
+ "description": "Active collapsible mode while collapsed, otherwise empty."
334
+ },
335
+ {
336
+ "name": "data-variant",
337
+ "type": "undefined | string",
338
+ "default": "",
339
+ "description": "The sidebar variant."
340
+ },
341
+ {
342
+ "name": "data-side",
343
+ "type": "undefined | string",
344
+ "default": "",
345
+ "description": "The sidebar side."
346
+ },
347
+ {
348
+ "name": "data-overlay",
349
+ "type": "string",
350
+ "default": "",
351
+ "description": "Present while the sidebar is an overlay."
352
+ }
353
+ ],
354
+ "methods": []
355
+ },
356
+ "UseSidebarPanelProps": {
357
+ "description": "Pre-built props for the sidebar panel element.",
358
+ "relatedProp": "",
359
+ "props": [
360
+ {
361
+ "name": "data-scope",
362
+ "type": "string",
363
+ "default": "",
364
+ "description": "Component scope identifier."
365
+ },
366
+ {
367
+ "name": "data-part",
368
+ "type": "string",
369
+ "default": "",
370
+ "description": "Component part identifier."
371
+ },
372
+ {
373
+ "name": "data-state",
374
+ "type": "string",
375
+ "default": "",
376
+ "description": "Reflects the expanded/collapsed display state."
377
+ },
378
+ {
379
+ "name": "data-collapsible",
380
+ "type": "undefined | string",
381
+ "default": "",
382
+ "description": "Active collapsible mode while collapsed, otherwise empty."
383
+ },
384
+ {
385
+ "name": "data-variant",
386
+ "type": "undefined | string",
387
+ "default": "",
388
+ "description": "The sidebar variant."
389
+ },
390
+ {
391
+ "name": "data-side",
392
+ "type": "undefined | string",
393
+ "default": "",
394
+ "description": "The sidebar side."
395
+ },
396
+ {
397
+ "name": "data-overlay",
398
+ "type": "string",
399
+ "default": "",
400
+ "description": "Present while the sidebar is an overlay."
401
+ }
402
+ ],
403
+ "methods": []
404
+ },
405
+ "UseSidebarContentProps": {
406
+ "description": "Pre-built props for the sidebar content element.",
407
+ "relatedProp": "",
408
+ "props": [
409
+ {
410
+ "name": "data-scope",
411
+ "type": "string",
412
+ "default": "",
413
+ "description": "Component scope identifier."
414
+ },
415
+ {
416
+ "name": "data-part",
417
+ "type": "string",
418
+ "default": "",
419
+ "description": "Component part identifier."
420
+ },
421
+ {
422
+ "name": "data-state",
423
+ "type": "string",
424
+ "default": "",
425
+ "description": "Reflects the expanded/collapsed display state."
426
+ },
427
+ {
428
+ "name": "data-collapsible",
429
+ "type": "undefined | string",
430
+ "default": "",
431
+ "description": "Active collapsible mode while collapsed, otherwise empty."
432
+ },
433
+ {
434
+ "name": "data-variant",
435
+ "type": "undefined | string",
436
+ "default": "",
437
+ "description": "The sidebar variant."
438
+ },
439
+ {
440
+ "name": "data-side",
441
+ "type": "undefined | string",
442
+ "default": "",
443
+ "description": "The sidebar side."
444
+ },
445
+ {
446
+ "name": "data-overlay",
447
+ "type": "string",
448
+ "default": "",
449
+ "description": "Present while the sidebar is an overlay."
450
+ }
451
+ ],
452
+ "methods": []
453
+ },
454
+ "UseSidebarHeaderProps": {
455
+ "description": "Pre-built props for the sidebar header element.",
456
+ "relatedProp": "",
457
+ "props": [
458
+ {
459
+ "name": "data-scope",
460
+ "type": "string",
461
+ "default": "",
462
+ "description": "Component scope identifier."
463
+ },
464
+ {
465
+ "name": "data-part",
466
+ "type": "string",
467
+ "default": "",
468
+ "description": "Component part identifier."
469
+ },
470
+ {
471
+ "name": "data-state",
472
+ "type": "string",
473
+ "default": "",
474
+ "description": "Reflects the expanded/collapsed display state."
475
+ },
476
+ {
477
+ "name": "data-collapsible",
478
+ "type": "undefined | string",
479
+ "default": "",
480
+ "description": "Active collapsible mode while collapsed, otherwise empty."
481
+ },
482
+ {
483
+ "name": "data-variant",
484
+ "type": "undefined | string",
485
+ "default": "",
486
+ "description": "The sidebar variant."
487
+ },
488
+ {
489
+ "name": "data-side",
490
+ "type": "undefined | string",
491
+ "default": "",
492
+ "description": "The sidebar side."
493
+ },
494
+ {
495
+ "name": "data-overlay",
496
+ "type": "string",
497
+ "default": "",
498
+ "description": "Present while the sidebar is an overlay."
499
+ }
500
+ ],
501
+ "methods": []
502
+ },
503
+ "UseSidebarFooterProps": {
504
+ "description": "Pre-built props for the sidebar footer element.",
505
+ "relatedProp": "",
506
+ "props": [
507
+ {
508
+ "name": "data-scope",
509
+ "type": "string",
510
+ "default": "",
511
+ "description": "Component scope identifier."
512
+ },
513
+ {
514
+ "name": "data-part",
515
+ "type": "string",
516
+ "default": "",
517
+ "description": "Component part identifier."
518
+ },
519
+ {
520
+ "name": "data-state",
521
+ "type": "string",
522
+ "default": "",
523
+ "description": "Reflects the expanded/collapsed display state."
524
+ },
525
+ {
526
+ "name": "data-collapsible",
527
+ "type": "undefined | string",
528
+ "default": "",
529
+ "description": "Active collapsible mode while collapsed, otherwise empty."
530
+ },
531
+ {
532
+ "name": "data-variant",
533
+ "type": "undefined | string",
534
+ "default": "",
535
+ "description": "The sidebar variant."
536
+ },
537
+ {
538
+ "name": "data-side",
539
+ "type": "undefined | string",
540
+ "default": "",
541
+ "description": "The sidebar side."
542
+ },
543
+ {
544
+ "name": "data-overlay",
545
+ "type": "string",
546
+ "default": "",
547
+ "description": "Present while the sidebar is an overlay."
548
+ }
549
+ ],
550
+ "methods": []
551
+ },
552
+ "UseSidebarTriggerProps": {
553
+ "description": "Pre-built props for the sidebar trigger element.",
554
+ "relatedProp": "",
555
+ "props": [
556
+ {
557
+ "name": "data-scope",
558
+ "type": "string",
559
+ "default": "",
560
+ "description": "Component scope identifier."
561
+ },
562
+ {
563
+ "name": "data-part",
564
+ "type": "string",
565
+ "default": "",
566
+ "description": "Component part identifier."
567
+ },
568
+ {
569
+ "name": "data-state",
570
+ "type": "string",
571
+ "default": "",
572
+ "description": "Reflects the expanded/collapsed display state."
573
+ },
574
+ {
575
+ "name": "data-collapsible",
576
+ "type": "undefined | string",
577
+ "default": "",
578
+ "description": "Active collapsible mode while collapsed, otherwise empty."
579
+ },
580
+ {
581
+ "name": "data-variant",
582
+ "type": "undefined | string",
583
+ "default": "",
584
+ "description": "The sidebar variant."
585
+ },
586
+ {
587
+ "name": "data-side",
588
+ "type": "undefined | string",
589
+ "default": "",
590
+ "description": "The sidebar side."
591
+ },
592
+ {
593
+ "name": "data-overlay",
594
+ "type": "string",
595
+ "default": "",
596
+ "description": "Present while the sidebar is an overlay."
597
+ },
598
+ {
599
+ "name": "aria-expanded",
600
+ "type": "boolean",
601
+ "default": "",
602
+ "description": "Whether the sidebar is currently open."
603
+ },
604
+ {
605
+ "name": "aria-controls",
606
+ "type": "string",
607
+ "default": "",
608
+ "description": "Id of the controlled sidebar, when set."
609
+ },
610
+ {
611
+ "name": "onClick",
612
+ "type": "(event?: SyntheticEvent<Element, Event>) => void",
613
+ "default": "",
614
+ "description": "Toggles the sidebar open state."
615
+ }
616
+ ],
617
+ "methods": []
618
+ },
619
+ "UseSidebarRailProps": {
620
+ "description": "Pre-built props for the sidebar rail element.",
621
+ "relatedProp": "",
622
+ "props": [
623
+ {
624
+ "name": "data-scope",
625
+ "type": "string",
626
+ "default": "",
627
+ "description": "Component scope identifier."
628
+ },
629
+ {
630
+ "name": "data-part",
631
+ "type": "string",
632
+ "default": "",
633
+ "description": "Component part identifier."
634
+ },
635
+ {
636
+ "name": "aria-label",
637
+ "type": "string",
638
+ "default": "",
639
+ "description": "Accessible label for the rail toggle."
640
+ },
641
+ {
642
+ "name": "title",
643
+ "type": "string",
644
+ "default": "",
645
+ "description": "Tooltip title for the rail toggle."
646
+ },
647
+ {
648
+ "name": "data-state",
649
+ "type": "string",
650
+ "default": "",
651
+ "description": "Reflects the expanded/collapsed display state."
652
+ },
653
+ {
654
+ "name": "data-collapsible",
655
+ "type": "undefined | string",
656
+ "default": "",
657
+ "description": "Active collapsible mode while collapsed, otherwise empty."
658
+ },
659
+ {
660
+ "name": "data-variant",
661
+ "type": "undefined | string",
662
+ "default": "",
663
+ "description": "The sidebar variant."
664
+ },
665
+ {
666
+ "name": "data-side",
667
+ "type": "undefined | string",
668
+ "default": "",
669
+ "description": "The sidebar side."
670
+ },
671
+ {
672
+ "name": "data-overlay",
673
+ "type": "string",
674
+ "default": "",
675
+ "description": "Present while the sidebar is an overlay."
676
+ },
677
+ {
678
+ "name": "onClick",
679
+ "type": "(event?: SyntheticEvent<Element, Event>) => void",
680
+ "default": "",
681
+ "description": "Toggles the sidebar open state."
682
+ }
683
+ ],
684
+ "methods": []
685
+ },
686
+ "UseSidebarMainProps": {
687
+ "description": "Pre-built props for the sidebar main element.",
688
+ "relatedProp": "",
689
+ "props": [
690
+ {
691
+ "name": "data-scope",
692
+ "type": "string",
693
+ "default": "",
694
+ "description": "Component scope identifier."
695
+ },
696
+ {
697
+ "name": "data-part",
698
+ "type": "string",
699
+ "default": "",
700
+ "description": "Component part identifier."
701
+ },
702
+ {
703
+ "name": "data-state",
704
+ "type": "string",
705
+ "default": "",
706
+ "description": "Reflects the expanded/collapsed display state."
707
+ },
708
+ {
709
+ "name": "data-collapsible",
710
+ "type": "undefined | string",
711
+ "default": "",
712
+ "description": "Active collapsible mode while collapsed, otherwise empty."
713
+ },
714
+ {
715
+ "name": "data-variant",
716
+ "type": "undefined | string",
717
+ "default": "",
718
+ "description": "The sidebar variant."
719
+ },
720
+ {
721
+ "name": "data-side",
722
+ "type": "undefined | string",
723
+ "default": "",
724
+ "description": "The sidebar side."
725
+ },
726
+ {
727
+ "name": "data-overlay",
728
+ "type": "string",
729
+ "default": "",
730
+ "description": "Present while the sidebar is an overlay."
731
+ }
732
+ ],
733
+ "methods": []
734
+ },
735
+ "UseSidebarBackdropProps": {
736
+ "description": "Pre-built props for the sidebar backdrop element.",
737
+ "relatedProp": "",
738
+ "props": [
739
+ {
740
+ "name": "data-scope",
741
+ "type": "string",
742
+ "default": "",
743
+ "description": "Component scope identifier."
744
+ },
745
+ {
746
+ "name": "data-part",
747
+ "type": "string",
748
+ "default": "",
749
+ "description": "Component part identifier."
750
+ },
751
+ {
752
+ "name": "onClick",
753
+ "type": "(event?: SyntheticEvent<Element, Event>) => void",
754
+ "default": "",
755
+ "description": "Collapses the sidebar when dismissable."
756
+ }
757
+ ],
758
+ "methods": []
759
+ },
760
+ "UseSidebarMenuProps": {
761
+ "description": "Pre-built props for the sidebar menu element.",
762
+ "relatedProp": "",
763
+ "props": [
764
+ {
765
+ "name": "data-scope",
766
+ "type": "string",
767
+ "default": "",
768
+ "description": "Component scope identifier."
769
+ },
770
+ {
771
+ "name": "data-part",
772
+ "type": "string",
773
+ "default": "",
774
+ "description": "Component part identifier."
775
+ }
776
+ ],
777
+ "methods": []
778
+ },
779
+ "UseSidebarMenuItemElementProps": {
780
+ "description": "Pre-built props for the sidebar menu item element.",
781
+ "relatedProp": "",
782
+ "props": [
783
+ {
784
+ "name": "data-scope",
785
+ "type": "string",
786
+ "default": "",
787
+ "description": "Component scope identifier."
788
+ },
789
+ {
790
+ "name": "data-part",
791
+ "type": "string",
792
+ "default": "",
793
+ "description": "Component part identifier."
794
+ }
795
+ ],
796
+ "methods": []
797
+ },
798
+ "UseSidebarMenuButtonProps": {
799
+ "description": "Pre-built props for the sidebar menu button element.",
800
+ "relatedProp": "",
801
+ "props": [
802
+ {
803
+ "name": "data-scope",
804
+ "type": "string",
805
+ "default": "",
806
+ "description": "Component scope identifier."
807
+ },
808
+ {
809
+ "name": "data-part",
810
+ "type": "string",
811
+ "default": "",
812
+ "description": "Component part identifier."
813
+ },
814
+ {
815
+ "name": "data-menu-item",
816
+ "type": "string",
817
+ "default": "",
818
+ "description": "Marks the button as a keyboard-navigable tree item."
819
+ },
820
+ {
821
+ "name": "data-active",
20
822
  "type": "boolean",
21
823
  "default": "",
22
- "description": "The value of the sidebar open state."
824
+ "description": "Present when the button represents the active item."
825
+ }
826
+ ],
827
+ "methods": []
828
+ },
829
+ "UseSidebarMenuActionProps": {
830
+ "description": "Pre-built props for the sidebar menu action element.",
831
+ "relatedProp": "",
832
+ "props": [
833
+ {
834
+ "name": "data-scope",
835
+ "type": "string",
836
+ "default": "",
837
+ "description": "Component scope identifier."
838
+ },
839
+ {
840
+ "name": "data-part",
841
+ "type": "string",
842
+ "default": "",
843
+ "description": "Component part identifier."
844
+ },
845
+ {
846
+ "name": "data-show-on-hover",
847
+ "type": "string",
848
+ "default": "",
849
+ "description": "Present when the action is only shown on hover/focus."
23
850
  }
24
851
  ],
25
852
  "methods": []
26
853
  },
27
- "UseSidebarProps": {
28
- "description": "Defines valid properties in useSidebar.",
854
+ "UseSidebarMenuBadgeProps": {
855
+ "description": "Pre-built props for the sidebar menu badge element.",
29
856
  "relatedProp": "",
30
857
  "props": [
31
858
  {
32
- "name": "layout",
33
- "type": "UseSidebarLayoutExposes",
859
+ "name": "data-scope",
860
+ "type": "string",
34
861
  "default": "",
35
- "description": "Layout context for registering/notifying within a Sidebar.Layout."
862
+ "description": "Component scope identifier."
36
863
  },
37
864
  {
38
- "name": "id",
865
+ "name": "data-part",
39
866
  "type": "string",
40
867
  "default": "",
41
- "description": "Unique identifier for the sidebar, used by Trigger target."
42
- },
868
+ "description": "Component part identifier."
869
+ }
870
+ ],
871
+ "methods": []
872
+ },
873
+ "UseSidebarMenuSubProps": {
874
+ "description": "Pre-built props for the sidebar menu sub element.",
875
+ "relatedProp": "",
876
+ "props": [
43
877
  {
44
- "name": "side",
45
- "type": "\"left\" | \"right\"",
46
- "default": "'left'",
47
- "description": "Sidebar position."
878
+ "name": "data-scope",
879
+ "type": "string",
880
+ "default": "",
881
+ "description": "Component scope identifier."
48
882
  },
49
883
  {
50
- "name": "variant",
51
- "type": "\"sidebar\" | \"floating\" | \"inset\"",
52
- "default": "'sidebar'",
53
- "description": "Visual variant of the sidebar."
54
- },
884
+ "name": "data-part",
885
+ "type": "string",
886
+ "default": "",
887
+ "description": "Component part identifier."
888
+ }
889
+ ],
890
+ "methods": []
891
+ },
892
+ "UseSidebarMenuSubItemProps": {
893
+ "description": "Pre-built props for the sidebar menu sub item element.",
894
+ "relatedProp": "",
895
+ "props": [
55
896
  {
56
- "name": "collapsible",
57
- "type": "\"icon\" | \"none\" | \"offcanvas\"",
58
- "default": "'icon'",
59
- "description": "Collapse behavior."
897
+ "name": "data-scope",
898
+ "type": "string",
899
+ "default": "",
900
+ "description": "Component scope identifier."
60
901
  },
61
902
  {
62
- "name": "overlay",
63
- "type": "boolean",
64
- "default": "false",
65
- "description": "Whether the sidebar overlays content instead of pushing it."
66
- },
903
+ "name": "data-part",
904
+ "type": "string",
905
+ "default": "",
906
+ "description": "Component part identifier."
907
+ }
908
+ ],
909
+ "methods": []
910
+ },
911
+ "UseSidebarMenuSubButtonProps": {
912
+ "description": "Pre-built props for the sidebar menu sub button element.",
913
+ "relatedProp": "",
914
+ "props": [
67
915
  {
68
- "name": "open",
69
- "type": "boolean",
916
+ "name": "data-scope",
917
+ "type": "string",
70
918
  "default": "",
71
- "description": "Controls the open state of the sidebar."
919
+ "description": "Component scope identifier."
72
920
  },
73
921
  {
74
- "name": "defaultOpen",
75
- "type": "boolean",
76
- "default": "true",
77
- "description": "Initial open state."
922
+ "name": "data-part",
923
+ "type": "string",
924
+ "default": "",
925
+ "description": "Component part identifier."
78
926
  },
79
927
  {
80
- "name": "onOpenChange",
81
- "type": "(event: UseSidebarOpenChangeEvent) => void",
928
+ "name": "data-menu-item",
929
+ "type": "string",
82
930
  "default": "",
83
- "description": "Callback when the open state changes."
931
+ "description": "Marks the button as a keyboard-navigable tree item."
84
932
  },
85
933
  {
86
- "name": "openOnHover",
934
+ "name": "data-active",
87
935
  "type": "boolean",
88
- "default": "false",
89
- "description": "Whether the sidebar opens on hover."
936
+ "default": "",
937
+ "description": "Present when the button represents the active item."
90
938
  },
91
939
  {
92
- "name": "hoverOpenDelay",
93
- "type": "number",
94
- "default": "50",
95
- "description": "Delay before opening on hover (ms)."
96
- },
940
+ "name": "data-size",
941
+ "type": "undefined | string",
942
+ "default": "",
943
+ "description": "The sub button size."
944
+ }
945
+ ],
946
+ "methods": []
947
+ },
948
+ "UseSidebarGroupProps": {
949
+ "description": "Pre-built props for the sidebar group element.",
950
+ "relatedProp": "",
951
+ "props": [
97
952
  {
98
- "name": "hoverCloseDelay",
99
- "type": "number",
100
- "default": "100",
101
- "description": "Delay before closing on hover leave (ms)."
953
+ "name": "data-scope",
954
+ "type": "string",
955
+ "default": "",
956
+ "description": "Component scope identifier."
102
957
  },
103
958
  {
104
- "name": "dismissable",
105
- "type": "boolean",
106
- "default": "true",
107
- "description": "Whether clicking the backdrop closes the sidebar."
108
- },
959
+ "name": "data-part",
960
+ "type": "string",
961
+ "default": "",
962
+ "description": "Component part identifier."
963
+ }
964
+ ],
965
+ "methods": []
966
+ },
967
+ "UseSidebarGroupLabelProps": {
968
+ "description": "Pre-built props for the sidebar group label element.",
969
+ "relatedProp": "",
970
+ "props": [
109
971
  {
110
- "name": "hideOnOutsideClick",
111
- "type": "boolean",
112
- "default": "true",
113
- "description": "When `overlay` is true, clicking inside the `Sidebar.Main` area collapses the sidebar.\nClicks on a `Sidebar.Trigger` are excluded so opening via the trigger is not immediately undone."
972
+ "name": "data-scope",
973
+ "type": "string",
974
+ "default": "",
975
+ "description": "Component scope identifier."
114
976
  },
115
977
  {
116
- "name": "closeOnEscape",
117
- "type": "boolean",
118
- "default": "true",
119
- "description": "When `overlay` is true, pressing Escape collapses the sidebar."
120
- },
978
+ "name": "data-part",
979
+ "type": "string",
980
+ "default": "",
981
+ "description": "Component part identifier."
982
+ }
983
+ ],
984
+ "methods": []
985
+ },
986
+ "UseSidebarGroupContentProps": {
987
+ "description": "Pre-built props for the sidebar group content element.",
988
+ "relatedProp": "",
989
+ "props": [
121
990
  {
122
- "name": "width",
991
+ "name": "data-scope",
123
992
  "type": "string",
124
- "default": "'16rem'",
125
- "description": "Sidebar width when expanded."
993
+ "default": "",
994
+ "description": "Component scope identifier."
126
995
  },
127
996
  {
128
- "name": "iconWidth",
997
+ "name": "data-part",
129
998
  "type": "string",
130
- "default": "'3rem'",
131
- "description": "Sidebar width when collapsed to icon mode."
999
+ "default": "",
1000
+ "description": "Component part identifier."
132
1001
  }
133
1002
  ],
134
1003
  "methods": []
135
1004
  },
136
- "UseSidebarState": {
137
- "description": "Defines valid state in useSidebar.",
1005
+ "UseSidebarGroupActionProps": {
1006
+ "description": "Pre-built props for the sidebar group action element.",
138
1007
  "relatedProp": "",
139
1008
  "props": [
140
1009
  {
141
- "name": "open",
142
- "type": "boolean",
143
- "default": ""
1010
+ "name": "data-scope",
1011
+ "type": "string",
1012
+ "default": "",
1013
+ "description": "Component scope identifier."
144
1014
  },
145
1015
  {
146
- "name": "displayState",
147
- "type": "\"expanded\" | \"collapsed\"",
148
- "default": ""
1016
+ "name": "data-part",
1017
+ "type": "string",
1018
+ "default": "",
1019
+ "description": "Component part identifier."
149
1020
  }
150
1021
  ],
151
1022
  "methods": []
@@ -157,102 +1028,194 @@
157
1028
  {
158
1029
  "name": "state",
159
1030
  "type": "UseSidebarState",
160
- "default": ""
1031
+ "default": "",
1032
+ "description": "The state of the useSidebar."
161
1033
  },
162
1034
  {
163
1035
  "name": "toggle",
164
- "type": "(event?: SyntheticEvent) => void",
165
- "default": ""
1036
+ "type": "(event?: SyntheticEvent<Element, Event>) => void",
1037
+ "default": "",
1038
+ "description": "Toggles the sidebar open state."
166
1039
  },
167
1040
  {
168
1041
  "name": "expand",
169
- "type": "(event?: SyntheticEvent) => void",
170
- "default": ""
1042
+ "type": "(event?: SyntheticEvent<Element, Event>) => void",
1043
+ "default": "",
1044
+ "description": "Opens the sidebar."
171
1045
  },
172
1046
  {
173
1047
  "name": "collapse",
174
- "type": "(event?: SyntheticEvent) => void",
175
- "default": ""
1048
+ "type": "(event?: SyntheticEvent<Element, Event>) => void",
1049
+ "default": "",
1050
+ "description": "Collapses the sidebar."
176
1051
  },
177
1052
  {
178
1053
  "name": "rootProps",
179
- "type": "Record<string, unknown>",
180
- "default": ""
1054
+ "type": "UseSidebarRootProps",
1055
+ "default": "",
1056
+ "description": "Pre-built props for the root element."
181
1057
  },
182
1058
  {
183
1059
  "name": "spacerProps",
184
- "type": "Record<string, unknown>",
185
- "default": ""
1060
+ "type": "UseSidebarSpacerProps",
1061
+ "default": "",
1062
+ "description": "Pre-built props for the spacer element."
186
1063
  },
187
1064
  {
188
1065
  "name": "asideProps",
189
- "type": "Record<string, unknown>",
190
- "default": ""
1066
+ "type": "UseSidebarAsideProps",
1067
+ "default": "",
1068
+ "description": "Pre-built props for the aside element."
191
1069
  },
192
1070
  {
193
1071
  "name": "panelProps",
194
- "type": "Record<string, unknown>",
195
- "default": ""
1072
+ "type": "UseSidebarPanelProps",
1073
+ "default": "",
1074
+ "description": "Pre-built props for the panel element."
196
1075
  },
197
1076
  {
198
1077
  "name": "contentProps",
199
- "type": "Record<string, unknown>",
200
- "default": ""
1078
+ "type": "UseSidebarContentProps",
1079
+ "default": "",
1080
+ "description": "Pre-built props for the content element."
201
1081
  },
202
1082
  {
203
1083
  "name": "headerProps",
204
- "type": "Record<string, unknown>",
205
- "default": ""
1084
+ "type": "UseSidebarHeaderProps",
1085
+ "default": "",
1086
+ "description": "Pre-built props for the header element."
206
1087
  },
207
1088
  {
208
1089
  "name": "footerProps",
209
- "type": "Record<string, unknown>",
210
- "default": ""
1090
+ "type": "UseSidebarFooterProps",
1091
+ "default": "",
1092
+ "description": "Pre-built props for the footer element."
211
1093
  },
212
1094
  {
213
1095
  "name": "triggerProps",
214
- "type": "Record<string, unknown>",
215
- "default": ""
1096
+ "type": "UseSidebarTriggerProps",
1097
+ "default": "",
1098
+ "description": "Pre-built props for the trigger element."
216
1099
  },
217
1100
  {
218
1101
  "name": "railProps",
219
- "type": "Record<string, unknown>",
220
- "default": ""
1102
+ "type": "UseSidebarRailProps",
1103
+ "default": "",
1104
+ "description": "Pre-built props for the rail element."
221
1105
  },
222
1106
  {
223
1107
  "name": "mainProps",
224
- "type": "Record<string, unknown>",
225
- "default": ""
1108
+ "type": "UseSidebarMainProps",
1109
+ "default": "",
1110
+ "description": "Pre-built props for the main element."
226
1111
  },
227
1112
  {
228
1113
  "name": "backdropProps",
229
- "type": "Record<string, unknown>",
230
- "default": ""
1114
+ "type": "UseSidebarBackdropProps",
1115
+ "default": "",
1116
+ "description": "Pre-built props for the backdrop element."
1117
+ },
1118
+ {
1119
+ "name": "menuProps",
1120
+ "type": "UseSidebarMenuProps",
1121
+ "default": "",
1122
+ "description": "Pre-built props for the menu element."
1123
+ },
1124
+ {
1125
+ "name": "menuItemProps",
1126
+ "type": "UseSidebarMenuItemElementProps",
1127
+ "default": "",
1128
+ "description": "Pre-built props for the menu item element."
1129
+ },
1130
+ {
1131
+ "name": "getMenuButtonProps",
1132
+ "type": "(isActive?: boolean) => UseSidebarMenuButtonProps",
1133
+ "default": "",
1134
+ "description": "Gets the pre-built props for a menu button element."
1135
+ },
1136
+ {
1137
+ "name": "getMenuActionProps",
1138
+ "type": "(showOnHover?: boolean) => UseSidebarMenuActionProps",
1139
+ "default": "",
1140
+ "description": "Gets the pre-built props for a menu action element."
1141
+ },
1142
+ {
1143
+ "name": "menuBadgeProps",
1144
+ "type": "UseSidebarMenuBadgeProps",
1145
+ "default": "",
1146
+ "description": "Pre-built props for the menu badge element."
1147
+ },
1148
+ {
1149
+ "name": "menuSubProps",
1150
+ "type": "UseSidebarMenuSubProps",
1151
+ "default": "",
1152
+ "description": "Pre-built props for the menu sub element."
1153
+ },
1154
+ {
1155
+ "name": "menuSubItemProps",
1156
+ "type": "UseSidebarMenuSubItemProps",
1157
+ "default": "",
1158
+ "description": "Pre-built props for the menu sub item element."
1159
+ },
1160
+ {
1161
+ "name": "getMenuSubButtonProps",
1162
+ "type": "(isActive?: boolean, size?: string) => UseSidebarMenuSubButtonProps",
1163
+ "default": "",
1164
+ "description": "Gets the pre-built props for a menu sub button element."
1165
+ },
1166
+ {
1167
+ "name": "groupProps",
1168
+ "type": "UseSidebarGroupProps",
1169
+ "default": "",
1170
+ "description": "Pre-built props for the group element."
1171
+ },
1172
+ {
1173
+ "name": "groupLabelProps",
1174
+ "type": "UseSidebarGroupLabelProps",
1175
+ "default": "",
1176
+ "description": "Pre-built props for the group label element."
1177
+ },
1178
+ {
1179
+ "name": "groupContentProps",
1180
+ "type": "UseSidebarGroupContentProps",
1181
+ "default": "",
1182
+ "description": "Pre-built props for the group content element."
1183
+ },
1184
+ {
1185
+ "name": "groupActionProps",
1186
+ "type": "UseSidebarGroupActionProps",
1187
+ "default": "",
1188
+ "description": "Pre-built props for the group action element."
231
1189
  },
232
1190
  {
233
1191
  "name": "variant",
234
- "type": "\"sidebar\" | \"floating\" | \"inset\"",
235
- "default": ""
1192
+ "type": "undefined | \"sidebar\" | \"floating\" | \"inset\"",
1193
+ "default": "",
1194
+ "description": "The sidebar variant."
236
1195
  },
237
1196
  {
238
1197
  "name": "collapsible",
239
- "type": "\"icon\" | \"none\" | \"offcanvas\"",
240
- "default": ""
1198
+ "type": "undefined | \"icon\" | \"none\" | \"offcanvas\"",
1199
+ "default": "",
1200
+ "description": "The collapse behavior."
241
1201
  },
242
1202
  {
243
1203
  "name": "side",
244
- "type": "\"left\" | \"right\"",
245
- "default": ""
1204
+ "type": "undefined | \"left\" | \"right\"",
1205
+ "default": "",
1206
+ "description": "The sidebar side."
246
1207
  },
247
1208
  {
248
1209
  "name": "overlay",
249
- "type": "boolean",
250
- "default": ""
1210
+ "type": "undefined | boolean",
1211
+ "default": "",
1212
+ "description": "Whether the sidebar overlays the content."
251
1213
  },
252
1214
  {
253
1215
  "name": "openOnHover",
254
- "type": "boolean",
255
- "default": ""
1216
+ "type": "undefined | boolean",
1217
+ "default": "",
1218
+ "description": "Whether the sidebar opens on hover."
256
1219
  }
257
1220
  ],
258
1221
  "methods": []
@@ -291,18 +1254,18 @@
291
1254
  "props": [
292
1255
  {
293
1256
  "name": "setSidebar",
294
- "type": "(id: string, entry: SidebarRegistryEntry) => void",
1257
+ "type": "(id: string, entry: null | SidebarRegistryEntry) => void",
295
1258
  "default": "",
296
1259
  "description": "Publish a sidebar entry to the layout. Pass `null` to remove the sidebar\n(called from the cleanup of the publishing effect on unmount)."
297
1260
  },
298
1261
  {
299
1262
  "name": "toggle",
300
- "type": "(target?: string, event?: SyntheticEvent) => void",
1263
+ "type": "(target?: string, event?: SyntheticEvent<Element, Event>) => void",
301
1264
  "default": ""
302
1265
  },
303
1266
  {
304
1267
  "name": "collapse",
305
- "type": "(target?: string, event?: SyntheticEvent) => void",
1268
+ "type": "(target?: string, event?: SyntheticEvent<Element, Event>) => void",
306
1269
  "default": ""
307
1270
  },
308
1271
  {
@@ -340,82 +1303,94 @@
340
1303
  "description": "",
341
1304
  "interfaces": {
342
1305
  "UseSidebarMenuItemProps": {
343
- "description": "",
1306
+ "description": "Defines valid properties in useSidebarMenuItem.",
344
1307
  "relatedProp": "",
345
1308
  "props": [
346
1309
  {
347
1310
  "name": "collapsible",
348
1311
  "type": "boolean",
349
- "default": ""
1312
+ "default": "false",
1313
+ "description": "Whether the menu item is collapsible."
350
1314
  },
351
1315
  {
352
1316
  "name": "open",
353
1317
  "type": "boolean",
354
- "default": ""
1318
+ "default": "",
1319
+ "description": "Whether the collapsible menu item is open (controlled)."
355
1320
  },
356
1321
  {
357
1322
  "name": "defaultOpen",
358
1323
  "type": "boolean",
359
- "default": ""
1324
+ "default": "true",
1325
+ "description": "Whether the collapsible menu item is open by default (uncontrolled)."
360
1326
  },
361
1327
  {
362
1328
  "name": "disabled",
363
1329
  "type": "boolean",
364
- "default": ""
1330
+ "default": "false",
1331
+ "description": "Whether the menu item is disabled."
365
1332
  },
366
1333
  {
367
1334
  "name": "onOpenChange",
368
- "type": "(event: { originalEvent: SyntheticEvent; value: boolean }) => void",
369
- "default": ""
1335
+ "type": "(event: { originalEvent: SyntheticEvent; value: undefined | boolean }) => void",
1336
+ "default": "",
1337
+ "description": "Callback invoked when the open state changes."
370
1338
  }
371
1339
  ],
372
1340
  "methods": []
373
1341
  },
374
1342
  "UseSidebarMenuItemState": {
375
- "description": "",
1343
+ "description": "Defines valid state in useSidebarMenuItem.",
376
1344
  "relatedProp": "",
377
1345
  "props": [
378
1346
  {
379
1347
  "name": "isCollapsible",
380
1348
  "type": "boolean",
381
- "default": ""
1349
+ "default": "",
1350
+ "description": "Whether the menu item is collapsible."
382
1351
  },
383
1352
  {
384
1353
  "name": "open",
385
- "type": "boolean",
386
- "default": ""
1354
+ "type": "undefined | boolean",
1355
+ "default": "",
1356
+ "description": "Whether the collapsible menu item is open."
387
1357
  }
388
1358
  ],
389
1359
  "methods": []
390
1360
  },
391
1361
  "UseSidebarMenuItemExposes": {
392
- "description": "",
1362
+ "description": "Defines the methods and properties exposed by useSidebarMenuItem.",
393
1363
  "relatedProp": "",
394
1364
  "props": [
395
1365
  {
396
1366
  "name": "state",
397
1367
  "type": "UseSidebarMenuItemState",
398
- "default": ""
1368
+ "default": "",
1369
+ "description": "The state of the useSidebarMenuItem."
399
1370
  },
400
1371
  {
401
1372
  "name": "toggle",
402
- "type": "(event?: SyntheticEvent) => void",
403
- "default": ""
1373
+ "type": "(event?: SyntheticEvent<Element, Event>) => void",
1374
+ "default": "",
1375
+ "description": "Toggles the collapsible menu item."
404
1376
  },
405
1377
  {
406
1378
  "name": "triggerProps",
407
- "type": "Record<string, unknown>",
408
- "default": ""
1379
+ "type": "Partial<UseCollapsibleTriggerProps>",
1380
+ "default": "",
1381
+ "description": "Pre-built props for the collapsible trigger, empty unless the item is collapsible."
409
1382
  },
410
1383
  {
411
1384
  "name": "contentProps",
412
- "type": "Record<string, unknown>",
413
- "default": ""
1385
+ "type": "Partial<UseCollapsibleContentProps>",
1386
+ "default": "",
1387
+ "description": "Pre-built props for the collapsible content, empty unless the item is collapsible."
414
1388
  },
415
1389
  {
416
1390
  "name": "rootProps",
417
- "type": "Record<string, unknown>",
418
- "default": ""
1391
+ "type": "Partial<UseCollapsibleRootProps> & { data-collapsible?: boolean }",
1392
+ "default": "",
1393
+ "description": "Pre-built props for the collapsible root, empty unless the item is collapsible."
419
1394
  }
420
1395
  ],
421
1396
  "methods": []
@@ -423,7 +1398,7 @@
423
1398
  },
424
1399
  "types": {
425
1400
  "UseSidebarMenuItemInstance": {
426
- "description": "",
1401
+ "description": "Instance of useSidebarMenuItem headless.",
427
1402
  "values": "HeadlessInstance<UseSidebarMenuItemProps, UseSidebarMenuItemState, UseSidebarMenuItemExposes>"
428
1403
  }
429
1404
  },