@vizejs/ui 0.714.0 → 0.716.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 (257) hide show
  1. package/dist/{accordion-B8xySJ9Z.mjs → accordion-DCZpHYPr.mjs} +1 -1
  2. package/dist/accordion.d.mts +1 -1
  3. package/dist/accordion.mjs +1 -1
  4. package/dist/{action-sheet-CTfduiVj.mjs → action-sheet-BUUgo0WP.mjs} +1 -1
  5. package/dist/action-sheet.d.mts +1 -1
  6. package/dist/action-sheet.mjs +3 -3
  7. package/dist/{alert-dialog-DGbpHYVc.mjs → alert-dialog-BI00j7h7.mjs} +1 -1
  8. package/dist/alert-dialog.d.mts +1 -1
  9. package/dist/alert-dialog.mjs +2 -2
  10. package/dist/{announcer-CV09roPJ.d.mts → announcer-BbaoRW6K.d.mts} +39 -29
  11. package/dist/announcer.d.mts +1 -1
  12. package/dist/autocomplete.d.mts +1 -1
  13. package/dist/avatar.d.mts +1 -1
  14. package/dist/badge.d.mts +1 -1
  15. package/dist/banner.d.mts +1 -1
  16. package/dist/block-ui.d.mts +1 -1
  17. package/dist/blockquote.d.mts +1 -1
  18. package/dist/{calendar-year-select.vue-BohqVCaU.d.mts → calendar-year-select.vue-BQcKQTQK.d.mts} +3 -1
  19. package/dist/calendar.d.mts +2 -2
  20. package/dist/callout.d.mts +1 -1
  21. package/dist/card.d.mts +1 -1
  22. package/dist/{cascader-Cjq1lBSV.d.mts → cascader-CpuiN9gN.d.mts} +1 -1
  23. package/dist/cascader.d.mts +1 -1
  24. package/dist/catalog.d.mts +4 -0
  25. package/dist/catalog.mjs +7 -0
  26. package/dist/chart.d.mts +1 -1
  27. package/dist/checkbox.d.mts +1 -1
  28. package/dist/code.d.mts +1 -1
  29. package/dist/{collapsible-773Rn_1a.mjs → collapsible-Bu1EaVPo.mjs} +1 -0
  30. package/dist/collapsible.d.mts +1 -1
  31. package/dist/collapsible.mjs +1 -1
  32. package/dist/{collection-BaPf8lgw.d.mts → collection-uZxHxJXO.d.mts} +3 -3
  33. package/dist/collection.d.mts +1 -1
  34. package/dist/color-picker.d.mts +1 -1
  35. package/dist/combobox.d.mts +1 -1
  36. package/dist/{command-CAH0yrMT.d.mts → command-DNIK2Qo6.d.mts} +1 -1
  37. package/dist/{command-palette-CUiAda3h.mjs → command-palette-CFM0cW96.mjs} +2 -2
  38. package/dist/command-palette.d.mts +1 -1
  39. package/dist/command-palette.mjs +1 -1
  40. package/dist/command.d.mts +1 -1
  41. package/dist/{composite-navigation-i7ocwmio.d.mts → composite-navigation-DZZ5cAZL.d.mts} +11 -9
  42. package/dist/composite-navigation.d.mts +1 -1
  43. package/dist/{confirm-5iLHxupT.mjs → confirm-CocH5VBh.mjs} +2 -2
  44. package/dist/confirm.d.mts +1 -1
  45. package/dist/confirm.mjs +1 -1
  46. package/dist/{context-menu-D2ZLeqYu.mjs → context-menu-CRDvogFb.mjs} +1 -1
  47. package/dist/context-menu.d.mts +1 -1
  48. package/dist/context-menu.mjs +2 -2
  49. package/dist/copy-button.d.mts +1 -1
  50. package/dist/{data-grid-CM7Aerqz.d.mts → data-grid-C9kLgc3P.d.mts} +9 -9
  51. package/dist/data-grid.d.mts +1 -1
  52. package/dist/{date-picker-LEtopwTI.d.mts → date-picker-M__fXGCG.d.mts} +2 -2
  53. package/dist/date-picker.d.mts +2 -2
  54. package/dist/date-range-picker.d.mts +3 -3
  55. package/dist/{dialog-trigger-B7JM7Ay9.mjs → dialog-trigger-DZKuwAL4.mjs} +1 -0
  56. package/dist/dialog.d.mts +1 -1
  57. package/dist/dialog.mjs +1 -1
  58. package/dist/direction.d.mts +1 -1
  59. package/dist/{dismissable-layer-CTWSFZwj.d.mts → dismissable-layer-CmHNmp14.d.mts} +5 -5
  60. package/dist/dismissable-layer.d.mts +1 -1
  61. package/dist/{drag-and-drop-yh1y-FD_.d.mts → drag-and-drop-BEX1UhUa.d.mts} +1 -1
  62. package/dist/{drag-and-drop-controller-types-oM5xTtD2.d.mts → drag-and-drop-controller-types-D35h2Y8Q.d.mts} +8 -8
  63. package/dist/drag-and-drop.d.mts +2 -2
  64. package/dist/{drawer-Dxl5hMPT.mjs → drawer-DNHxUgXG.mjs} +1 -1
  65. package/dist/drawer.d.mts +1 -1
  66. package/dist/drawer.mjs +2 -2
  67. package/dist/{dropdown-menu-DddzcuXj.mjs → dropdown-menu-Dz5rgVcY.mjs} +1 -1
  68. package/dist/dropdown-menu.d.mts +1 -1
  69. package/dist/dropdown-menu.mjs +2 -2
  70. package/dist/duration-field.d.mts +1 -1
  71. package/dist/{emoji-picker-DNPPdAXl.d.mts → emoji-picker-BVj6pvRu.d.mts} +2 -0
  72. package/dist/emoji-picker.d.mts +1 -1
  73. package/dist/empty-state.d.mts +1 -1
  74. package/dist/fieldset.d.mts +1 -1
  75. package/dist/file-upload.d.mts +1 -1
  76. package/dist/floating-action-button.d.mts +1 -1
  77. package/dist/{focus-eObxGOtP.d.mts → focus-GaPcm0qz.d.mts} +3 -3
  78. package/dist/{focus-guards-BZa7vm6O.d.mts → focus-guards-Bu_N_Vb9.d.mts} +5 -3
  79. package/dist/focus-guards.d.mts +1 -1
  80. package/dist/{focus-scope-CsnioDR4.d.mts → focus-scope-BEIV6tFj.d.mts} +8 -8
  81. package/dist/focus-scope.d.mts +1 -1
  82. package/dist/focus-visible.d.mts +1 -1
  83. package/dist/focus.d.mts +1 -1
  84. package/dist/{form-wizard-mErOrBg3.d.mts → form-wizard-D_B-Cydo.d.mts} +2 -2
  85. package/dist/form-wizard.d.mts +1 -1
  86. package/dist/fullscreen-button.d.mts +1 -1
  87. package/dist/{grid-list-BBlRg22H.d.mts → grid-list-kQwU09ec.d.mts} +1 -1
  88. package/dist/grid-list.d.mts +1 -1
  89. package/dist/heading.d.mts +1 -1
  90. package/dist/{history-BkcOSOWb.d.mts → history-CU1beAvx.d.mts} +7 -5
  91. package/dist/history.d.mts +1 -1
  92. package/dist/{hotspot-QUJJ382M.d.mts → hotspot-Cc89VVie.d.mts} +1 -1
  93. package/dist/hotspot.d.mts +1 -1
  94. package/dist/{hover-ZiPRiZkb.d.mts → hover-CQGn1F67.d.mts} +3 -3
  95. package/dist/hover-card.d.mts +1 -1
  96. package/dist/hover.d.mts +1 -1
  97. package/dist/icon-button.d.mts +1 -1
  98. package/dist/icon.d.mts +1 -1
  99. package/dist/index.d.mts +49 -49
  100. package/dist/index.mjs +17 -17
  101. package/dist/{inert-outside-B6KdwAHY.d.mts → inert-outside-C8Hfd6HF.d.mts} +1 -1
  102. package/dist/inert-outside.d.mts +1 -1
  103. package/dist/{infinite-scroll-BotnfjUx.d.mts → infinite-scroll-Dd-_uQFI.d.mts} +2 -2
  104. package/dist/infinite-scroll.d.mts +1 -1
  105. package/dist/{input-D4Zvmf67.d.mts → input-C0fgeRnS.d.mts} +2 -2
  106. package/dist/input.d.mts +1 -1
  107. package/dist/{interaction-hooks-sD63_AhA.d.mts → interaction-hooks-B1b-CbUb.d.mts} +16 -4
  108. package/dist/interaction-hooks.d.mts +5 -5
  109. package/dist/interaction-hooks.mjs +2 -0
  110. package/dist/{interaction-modality-BTiZ7j98.d.mts → interaction-modality-Bz6QN_p7.d.mts} +1 -1
  111. package/dist/interaction-modality.d.mts +1 -1
  112. package/dist/kbd.d.mts +1 -1
  113. package/dist/landmark.d.mts +1 -1
  114. package/dist/{lightbox-BC5VnUsG.mjs → lightbox-CDqJQ7QF.mjs} +1 -1
  115. package/dist/lightbox.mjs +1 -1
  116. package/dist/list.d.mts +1 -1
  117. package/dist/{listbox-grid-BifoC9TP.d.mts → listbox-grid-BPMnoDF2.d.mts} +1 -1
  118. package/dist/listbox-grid.d.mts +1 -1
  119. package/dist/listbox.d.mts +1 -1
  120. package/dist/locale.d.mts +1 -1
  121. package/dist/{long-press-DyYxp191.d.mts → long-press-r7IluMf6.d.mts} +10 -4
  122. package/dist/long-press.d.mts +1 -1
  123. package/dist/{marquee-DJLOGKYQ.d.mts → marquee-BXVz0Oyy.d.mts} +2 -2
  124. package/dist/marquee.d.mts +1 -1
  125. package/dist/media-preferences.d.mts +1 -1
  126. package/dist/{mention-RayImxP_.d.mts → mention-Cz_qL9-F.d.mts} +1 -1
  127. package/dist/mention.d.mts +1 -1
  128. package/dist/{menu-zVLPQ3qq.mjs → menu-D0jsX5ex.mjs} +6 -0
  129. package/dist/menu.d.mts +1 -1
  130. package/dist/menu.mjs +1 -1
  131. package/dist/{menubar-D0qmUnA8.mjs → menubar-FFAqwU2g.mjs} +1 -1
  132. package/dist/menubar.d.mts +1 -1
  133. package/dist/menubar.mjs +2 -2
  134. package/dist/month-picker.d.mts +1 -1
  135. package/dist/{move-BJGaV7Y9.d.mts → move-Pkfnke5x.d.mts} +3 -3
  136. package/dist/move.d.mts +1 -1
  137. package/dist/native-select.d.mts +1 -1
  138. package/dist/navigation-rail.d.mts +1 -1
  139. package/dist/{notification-center-CNfcvQ0r.mjs → notification-center-BFgDx8Os.mjs} +1 -0
  140. package/dist/notification-center.d.mts +1 -1
  141. package/dist/notification-center.mjs +1 -1
  142. package/dist/pager.d.mts +1 -1
  143. package/dist/pagination.d.mts +1 -1
  144. package/dist/{pointer-grace-CAFcO4om.d.mts → pointer-grace-Dw_EQOrW.d.mts} +1 -1
  145. package/dist/pointer-grace.d.mts +1 -1
  146. package/dist/popconfirm.d.mts +1 -1
  147. package/dist/{popover-types-DCcody_B.d.mts → popover-types-C1qIeZbC.d.mts} +2 -2
  148. package/dist/popover.d.mts +3 -3
  149. package/dist/{presence-Bhv1qtvn.d.mts → presence-BSRPHC4s.d.mts} +1 -1
  150. package/dist/{presence-types-CRB4HbML.d.mts → presence-types-B9oh0msp.d.mts} +2 -2
  151. package/dist/presence.d.mts +2 -2
  152. package/dist/{press-types-DfTNpqby.d.mts → press-types-VAT8E1Qh.d.mts} +5 -5
  153. package/dist/{press-R0_juZq2.d.mts → press-vCzBqNpZ.d.mts} +1 -1
  154. package/dist/press.d.mts +2 -2
  155. package/dist/print-button.d.mts +1 -1
  156. package/dist/progress-bar.d.mts +1 -1
  157. package/dist/radio-group.d.mts +1 -1
  158. package/dist/{range-calendar-Ck_L_GjZ.d.mts → range-calendar-DKSgY7LF.d.mts} +3 -3
  159. package/dist/range-calendar.d.mts +2 -2
  160. package/dist/scroll-area.d.mts +1 -1
  161. package/dist/{scroll-spy-UzNvEzBk.d.mts → scroll-spy-CpVd2rt1.d.mts} +1 -1
  162. package/dist/scroll-spy.d.mts +1 -1
  163. package/dist/{search-field-DzW31UHM.d.mts → search-field-Biw9vApG.d.mts} +2 -2
  164. package/dist/search-field.d.mts +1 -1
  165. package/dist/select.d.mts +1 -1
  166. package/dist/share-button.d.mts +1 -1
  167. package/dist/{shortcut-DAZJ9LEd.d.mts → shortcut-BYDNeoht.d.mts} +1 -1
  168. package/dist/{shortcut-CvA_o0_F.mjs → shortcut-Bke2M083.mjs} +1 -0
  169. package/dist/shortcut.d.mts +1 -1
  170. package/dist/shortcut.mjs +1 -1
  171. package/dist/{sidebar-YNcuialf.mjs → sidebar-997KLhQT.mjs} +4 -2
  172. package/dist/sidebar.d.mts +1 -1
  173. package/dist/sidebar.mjs +1 -1
  174. package/dist/{sortable-CmSh0mgo.d.mts → sortable-CLTG4F2W.d.mts} +5 -5
  175. package/dist/sortable.d.mts +1 -1
  176. package/dist/{spatial-navigation-BPVJGSiJ.d.mts → spatial-navigation-DbKs6xex.d.mts} +12 -5
  177. package/dist/spatial-navigation.d.mts +1 -1
  178. package/dist/{split-button-B7xnT9vz.mjs → split-button-DOop3cSq.mjs} +1 -1
  179. package/dist/split-button.d.mts +1 -1
  180. package/dist/split-button.mjs +2 -2
  181. package/dist/splitter.d.mts +1 -1
  182. package/dist/status-light.d.mts +1 -1
  183. package/dist/stepper.d.mts +1 -1
  184. package/dist/surface.d.mts +1 -1
  185. package/dist/switch.d.mts +1 -1
  186. package/dist/tabs.d.mts +1 -1
  187. package/dist/tags-input.d.mts +1 -1
  188. package/dist/text.d.mts +1 -1
  189. package/dist/{textarea-D7V5lLPX.d.mts → textarea-4eIDNcvv.d.mts} +2 -2
  190. package/dist/textarea.d.mts +1 -1
  191. package/dist/{theme-CNK06Pja.d.mts → theme-BxObVL1d.d.mts} +1 -1
  192. package/dist/theme-scope.d.mts +1 -1
  193. package/dist/{theme-types-CkIa4Sa3.d.mts → theme-types-DhXLFvar.d.mts} +1 -1
  194. package/dist/theme.d.mts +2 -2
  195. package/dist/toggle.d.mts +1 -1
  196. package/dist/tooltip.d.mts +1 -1
  197. package/dist/tour.d.mts +1 -1
  198. package/dist/{transition-BtIWNEFU.d.mts → transition-BKw2vyI9.d.mts} +1 -1
  199. package/dist/transition.d.mts +1 -1
  200. package/dist/tree.d.mts +1 -1
  201. package/dist/{typeahead-Dl6w5PAN.d.mts → typeahead-C1RHCOuj.d.mts} +3 -3
  202. package/dist/typeahead.d.mts +1 -1
  203. package/dist/{virtualizer-D9qfT4wS.d.mts → virtualizer-CZLyY4kq.d.mts} +4 -4
  204. package/dist/virtualizer.d.mts +1 -1
  205. package/dist/{webcam-capture-D5JRu3ab.d.mts → webcam-capture-DWdP7sr4.d.mts} +3 -3
  206. package/dist/webcam-capture.d.mts +1 -1
  207. package/dist/week-picker.d.mts +2 -2
  208. package/package.json +2 -2
  209. package/registry/files/families/accessibility/focus/focus-types.ts +3 -3
  210. package/registry/files/families/accessibility/focus-guards/focus-guards-types.ts +5 -3
  211. package/registry/files/families/accessibility/focus-scope/focus-scope-types.ts +8 -8
  212. package/registry/files/families/accessibility/inert-outside/inert-outside-types.ts +1 -1
  213. package/registry/files/families/accessibility/interaction-modality/interaction-modality-types.ts +1 -1
  214. package/registry/files/families/accessibility/landmark/landmark-types.ts +1 -1
  215. package/registry/files/families/data/data-grid/data-grid-model.ts +4 -4
  216. package/registry/files/families/data/data-grid/data-grid-types.ts +5 -5
  217. package/registry/files/families/date-time/calendar/calendar-locale.ts +3 -1
  218. package/registry/files/families/date-time/calendar/calendar-selection.ts +2 -2
  219. package/registry/files/families/date-time/week-picker/week-picker-selection.ts +1 -0
  220. package/registry/files/families/disclosure/collapsible/collapsible-context.ts +1 -0
  221. package/registry/files/families/feedback/notification-center/notification-center-context.ts +1 -0
  222. package/registry/files/families/form/tags-input/tags-input-value.ts +1 -1
  223. package/registry/files/families/foundations/collection/collection-types.ts +3 -3
  224. package/registry/files/families/foundations/command/command-types.ts +1 -1
  225. package/registry/files/families/foundations/composite-navigation/composite-navigation-types.ts +9 -7
  226. package/registry/files/families/foundations/theme/theme-types.ts +1 -1
  227. package/registry/files/families/interaction/drag-and-drop/drag-and-drop-controller-types.ts +8 -8
  228. package/registry/files/families/interaction/history/history-types.ts +7 -5
  229. package/registry/files/families/interaction/hover/hover-types.ts +3 -3
  230. package/registry/files/families/interaction/interaction-hooks/interaction-hooks-types.ts +10 -0
  231. package/registry/files/families/interaction/interaction-hooks/interaction-hooks.ts +2 -0
  232. package/registry/files/families/interaction/long-press/long-press-types.ts +9 -3
  233. package/registry/files/families/interaction/move/move-types.ts +3 -3
  234. package/registry/files/families/interaction/pointer-grace/pointer-grace-types.ts +1 -1
  235. package/registry/files/families/interaction/press/press-types.ts +5 -5
  236. package/registry/files/families/interaction/scroll-spy/scroll-spy-types.ts +1 -1
  237. package/registry/files/families/interaction/shortcut/shortcut-parse.ts +1 -0
  238. package/registry/files/families/interaction/shortcut/shortcut-types.ts +1 -1
  239. package/registry/files/families/interaction/sortable/sortable-types.ts +4 -4
  240. package/registry/files/families/interaction/spatial-navigation/spatial-navigation-types.ts +11 -4
  241. package/registry/files/families/interaction/typeahead/typeahead-types.ts +2 -2
  242. package/registry/files/families/interaction/virtualizer/virtualizer-infinite.ts +3 -3
  243. package/registry/files/families/interaction/virtualizer/virtualizer-types.ts +1 -1
  244. package/registry/files/families/layout/icon/icon-types.ts +2 -0
  245. package/registry/files/families/layout/sidebar/sidebar-context.ts +2 -0
  246. package/registry/files/families/media/webcam-capture/webcam-capture-media.ts +3 -3
  247. package/registry/files/families/menus/menu/menu-context.ts +6 -0
  248. package/registry/files/families/menus/menu/menu-item-runtime.ts +4 -3
  249. package/registry/files/families/menus/menu/menu-root-runtime.ts +6 -0
  250. package/registry/files/families/navigation/pagination/pagination-range.ts +3 -2
  251. package/registry/files/families/overlays/dialog/dialog-context.ts +1 -0
  252. package/registry/files/families/overlays/dismissable-layer/dismissable-layer-types.ts +5 -5
  253. package/registry/files/families/overlays/presence/presence-types.ts +2 -2
  254. package/registry/files/families/selection/emoji-picker/emoji-picker-model.ts +2 -0
  255. package/registry/files/families/selection/listbox-grid/listbox-grid-model.ts +1 -1
  256. package/registry/files/families/selection/select/select-collection.ts +1 -1
  257. package/registry/registry.json +138 -138
@@ -39,7 +39,7 @@ export interface ScrollSpyOptions {
39
39
  */
40
40
  readonly isDisabled?: MaybeRefOrGetter<boolean | undefined>;
41
41
 
42
- /** Called after a distinct active-id change. */
42
+ /** Called after a distinct active-id change. @default undefined */
43
43
  readonly onActiveChange?: (
44
44
  id: string | null,
45
45
  previous: string | null,
@@ -74,6 +74,7 @@ export function detectShortcutPlatform(): ShortcutPlatform {
74
74
  return applePlatformPattern.test(surface) ? "apple" : "standard";
75
75
  }
76
76
 
77
+ /** Resolve an explicit shortcut platform or detect the current environment. */
77
78
  export function readPlatform(platform: ShortcutPlatform | undefined): ShortcutPlatform {
78
79
  if (platform === undefined) return detectShortcutPlatform();
79
80
  if (!platforms.has(platform)) {
@@ -130,7 +130,7 @@ export interface ShortcutBindingOptions {
130
130
  */
131
131
  readonly allowInEditable?: boolean;
132
132
 
133
- /** Help description surfaced through binding and conflict metadata. */
133
+ /** Help description surfaced through binding and conflict metadata. @default undefined */
134
134
  readonly description?: string;
135
135
  }
136
136
 
@@ -162,16 +162,16 @@ export interface SortableOptions {
162
162
  */
163
163
  readonly announcements?: SortableAnnouncements;
164
164
 
165
- /** Called exactly once when an item is picked up. */
165
+ /** Called exactly once when an item is picked up. @default undefined */
166
166
  readonly onSortStart?: (event: SortStartEvent) => void;
167
167
 
168
- /** Called when the projected destination changes before a drop. */
168
+ /** Called when the projected destination changes before a drop. @default undefined */
169
169
  readonly onSortPreview?: (event: SortPreviewEvent) => void;
170
170
 
171
- /** Called exactly once when a completed drop commits the move. */
171
+ /** Called exactly once when a completed drop commits the move. @default undefined */
172
172
  readonly onSortCommit?: (event: SortCommitEvent) => void;
173
173
 
174
- /** Called exactly once when a sort is canceled; the item must return. */
174
+ /** Called exactly once when a sort is canceled; the item must return. @default undefined */
175
175
  readonly onSortCancel?: (event: SortCancelEvent) => void;
176
176
  }
177
177
 
@@ -64,7 +64,7 @@ export interface SpatialNavigationOptions<Key extends CollectionKey, Value> {
64
64
  */
65
65
  readonly boundaryBehavior?: MaybeRefOrGetter<SpatialNavigationBoundaryBehavior | undefined>;
66
66
 
67
- /** Suppress keyboard and imperative navigation without discarding active state. */
67
+ /** Suppress keyboard and imperative navigation without discarding active state. @default false */
68
68
  readonly isDisabled?: MaybeRefOrGetter<boolean | undefined>;
69
69
 
70
70
  /**
@@ -91,18 +91,25 @@ export interface SpatialNavigationOptions<Key extends CollectionKey, Value> {
91
91
  /**
92
92
  * Resolve transformed viewport geometry for DOM or virtual items.
93
93
  * The default reads `element.getBoundingClientRect()` and skips unmounted candidates.
94
+ *
95
+ * @default element.getBoundingClientRect
94
96
  */
95
97
  readonly getRect?: (
96
98
  item: CollectionItem<Key, Value>,
97
99
  ) => SpatialNavigationRect | DOMRectReadOnly | null | undefined;
98
100
 
99
- /** Custom visibility policy for virtualized or scroll-managed collections. */
101
+ /**
102
+ * Custom visibility policy for virtualized or scroll-managed collections.
103
+ *
104
+ * @default browser focus scrolling, or nearest-block and nearest-inline scrolling when focus
105
+ * does not scroll
106
+ */
100
107
  readonly scrollIntoView?: (item: CollectionItem<Key, Value>, originalEvent: Event | null) => void;
101
108
 
102
- /** Called after logical state, DOM focus, and reveal behavior commit. */
109
+ /** Called after logical state, DOM focus, and reveal behavior commit. @default undefined */
103
110
  readonly onNavigate?: (change: SpatialNavigationChange<Key>) => void;
104
111
 
105
- /** Called when a valid origin has no candidate in the requested direction. */
112
+ /** Called when a valid origin has no candidate in the requested direction. @default undefined */
106
113
  readonly onBoundary?: (boundary: SpatialNavigationBoundary<Key>) => void;
107
114
  }
108
115
 
@@ -44,10 +44,10 @@ export interface TypeaheadOptions<Key extends CollectionKey, Value> {
44
44
  */
45
45
  readonly allowSpace?: boolean;
46
46
 
47
- /** Comparator used to detect repeated graphemes before cycling matches. */
47
+ /** Comparator used to detect repeated graphemes before cycling matches. @default an accent-insensitive search collator for the host locale */
48
48
  readonly collator?: Intl.Collator;
49
49
 
50
- /** Called after active collection state moves to a text match. */
50
+ /** Called after active collection state moves to a text match. @default undefined */
51
51
  readonly onMatch?: (match: TypeaheadMatch<Key>) => void;
52
52
  }
53
53
 
@@ -54,13 +54,13 @@ export interface InfiniteLoaderOptions {
54
54
  */
55
55
  readonly canLoadForward?: MaybeRefOrGetter<boolean | undefined>;
56
56
 
57
- /** Load earlier items. Resolve after the collection is updated. */
57
+ /** Load earlier items. Resolve after the collection is updated. @default undefined */
58
58
  readonly onLoadBackward?: (context: InfiniteLoadContext) => Promise<void> | void;
59
59
 
60
- /** Load later items. Resolve after the collection is updated. */
60
+ /** Load later items. Resolve after the collection is updated. @default undefined */
61
61
  readonly onLoadForward?: (context: InfiniteLoadContext) => Promise<void> | void;
62
62
 
63
- /** Called when a non-stale load rejects. Without it, the rejection is rethrown. */
63
+ /** Called when a non-stale load rejects. Without it, the rejection is rethrown. @default undefined */
64
64
  readonly onLoadError?: (direction: InfiniteLoadDirection, error: unknown) => void;
65
65
  }
66
66
 
@@ -163,7 +163,7 @@ export interface VirtualizerOptions {
163
163
  */
164
164
  readonly initialScrollOffset?: number;
165
165
 
166
- /** Called after the visible range changes, including to `null`. */
166
+ /** Called after the visible range changes, including to `null`. @default undefined */
167
167
  readonly onRangeChange?: (range: VirtualRange | null) => void;
168
168
  }
169
169
 
@@ -34,6 +34,7 @@ export type IconStrokeWidth =
34
34
  | "3"
35
35
  | "4";
36
36
 
37
+ /** Rendered element exposed by Icon. */
37
38
  export type IconElement = PrimitiveElement;
38
39
 
39
40
  /** Shared structural props for Icon. */
@@ -247,6 +248,7 @@ export type IconButtonVariant = "outline" | "plain" | "soft" | "solid";
247
248
  /** Availability state mirrored to `data-state`. */
248
249
  export type IconButtonState = "disabled" | "idle" | "loading";
249
250
 
251
+ /** Rendered element exposed by IconButton. */
250
252
  export type IconButtonElement = PrimitiveElement;
251
253
 
252
254
  /** Shared structural props for IconButton. */
@@ -23,6 +23,7 @@ export interface SidebarContextValue {
23
23
  readonly toggle: (event?: Event | null) => boolean;
24
24
  }
25
25
 
26
+ /** Required context shared by one Sidebar compound component tree. */
26
27
  export const sidebarContext = createContext<SidebarContextValue>("Sidebar");
27
28
 
28
29
  /** Per-group label wiring shared by SidebarGroup and SidebarGroupLabel. */
@@ -30,4 +31,5 @@ export interface SidebarGroupContextValue {
30
31
  readonly labelId: ComputedRef<string>;
31
32
  }
32
33
 
34
+ /** Required context shared by one Sidebar group and its label. */
33
35
  export const sidebarGroupContext = createContext<SidebarGroupContextValue>("SidebarGroup");
@@ -81,13 +81,13 @@ export function stopWebcamStream(stream: WebcamMediaStreamLike): void {
81
81
 
82
82
  /** Options for {@link createWebcamConstraints}. */
83
83
  export interface CreateWebcamConstraintsOptions {
84
- /** Extra video constraints, merged under the facing mode or device. */
84
+ /** Extra video constraints, merged under the facing mode or device. @default undefined */
85
85
  readonly video?: MediaTrackConstraints | undefined;
86
86
  /** Requested facing direction when no device is selected. */
87
87
  readonly facingMode: WebcamFacingMode;
88
- /** Exact device to open; wins over `facingMode`. */
88
+ /** Exact device to open; wins over `facingMode`. @default undefined */
89
89
  readonly deviceId?: string | undefined;
90
- /** Also request the microphone. */
90
+ /** Also request the microphone. @default false */
91
91
  readonly audio?: boolean | undefined;
92
92
  }
93
93
 
@@ -122,10 +122,16 @@ export interface MenuGroupContextValue {
122
122
  readonly labelId: ShallowRef<string | null>;
123
123
  }
124
124
 
125
+ /** Required context shared by every level of one menu tree. */
125
126
  export const menuTreeContext = createContext<MenuTreeContextValue>("MenuTree");
127
+ /** Required context for the nearest root menu or submenu level. */
126
128
  export const menuLevelContext = createContext<MenuLevelContextValue>("MenuLevel");
129
+ /** Required context for the nearest rendered menu content. */
127
130
  export const menuContentContext = createContext<MenuContentContextValue>("MenuContent");
131
+ /** Optional checked-state context consumed by menu item indicators. */
128
132
  export const menuItemIndicatorContext =
129
133
  createContext<MenuItemIndicatorContextValue>("MenuItemIndicator");
134
+ /** Required selection context shared by one menu radio group. */
130
135
  export const menuRadioGroupContext = createContext<MenuRadioGroupContextValue>("MenuRadioGroup");
136
+ /** Required labelling context shared by one menu group and label. */
131
137
  export const menuGroupContext = createContext<MenuGroupContextValue>("MenuGroup");
@@ -35,14 +35,15 @@ export interface MenuItemOptions {
35
35
  readonly hint: string;
36
36
  readonly disabled: () => boolean;
37
37
  readonly textValue: () => string | undefined;
38
+ /** Submenu level opened by this item. @default undefined */
38
39
  readonly subLevel?: MenuLevelContextValue;
39
40
  /** Activate the item; return whether an activation happened. */
40
41
  readonly activate: (event: Event | null, source: MenuActivationSource) => boolean;
41
- /** Item-specific keydown hook that runs before Enter/Space activation. */
42
+ /** Item-specific keydown hook that runs before Enter/Space activation. @default undefined */
42
43
  readonly keydown?: (event: KeyboardEvent) => void;
43
- /** Item-specific pointer-leave hook; return `true` to skip clearing the highlight. */
44
+ /** Item-specific pointer-leave hook; return `true` to skip clearing the highlight. @default undefined */
44
45
  readonly pointerleave?: (event: PointerEvent) => boolean;
45
- /** Item-specific pointer-move hook run after the highlight moved to this item. */
46
+ /** Item-specific pointer-move hook run after the highlight moved to this item. @default undefined */
46
47
  readonly pointermove?: (event: PointerEvent) => void;
47
48
  }
48
49
 
@@ -29,7 +29,9 @@ export interface MenuLevelOptions {
29
29
  readonly requestedOpen: ComputedRef<boolean>;
30
30
  readonly commitOpen: (value: boolean) => boolean;
31
31
  readonly disabled: () => boolean;
32
+ /** Positioning reference override. @default the trigger element */
32
33
  readonly reference?: (() => PositionerElement | null) | undefined;
34
+ /** Focus restoration override. @default the trigger element */
33
35
  readonly restoreTarget?: (() => HTMLElement | null) | undefined;
34
36
  readonly onOpenChange: (value: boolean, previous: boolean, event: Event | null) => void;
35
37
  }
@@ -112,9 +114,13 @@ export interface MenuRootOptions {
112
114
  readonly modal: () => boolean;
113
115
  readonly dir: () => MenuDirection;
114
116
  readonly loop: () => boolean;
117
+ /** Whether this root refuses interaction and open requests. @default false */
115
118
  readonly disabled?: () => boolean;
119
+ /** Positioning reference override. @default the trigger element */
116
120
  readonly reference?: () => PositionerElement | null;
121
+ /** Focus restoration override. @default the trigger element */
117
122
  readonly restoreTarget?: () => HTMLElement | null;
123
+ /** Horizontal hand-off used by menubars. @default no hand-off */
118
124
  readonly edgeNavigate?: (direction: MenuEdgeDirection, event: KeyboardEvent) => boolean;
119
125
  readonly onOpenChange: (value: boolean, previous: boolean, event: Event | null) => void;
120
126
  }
@@ -15,6 +15,7 @@ export interface PaginationRangeEllipsis {
15
15
  /** Item emitted by the Pagination range helper. */
16
16
  export type PaginationRangeItem = PaginationRangePage | PaginationRangeEllipsis;
17
17
 
18
+ /** Inputs controlling the compact sequence produced by {@link createPaginationRange}. */
18
19
  export interface PaginationRangeOptions {
19
20
  /** Current page, clamped into `1...pageCount`. */
20
21
  readonly page: number;
@@ -22,10 +23,10 @@ export interface PaginationRangeOptions {
22
23
  /** Total page count. Values below one resolve to one page. */
23
24
  readonly pageCount: number;
24
25
 
25
- /** Number of pages kept on each side of the current page. */
26
+ /** Number of pages kept on each side of the current page. @default 1 */
26
27
  readonly siblingCount?: number;
27
28
 
28
- /** Number of pages always kept at each boundary. */
29
+ /** Number of pages always kept at each boundary. @default 1 */
29
30
  readonly boundaryCount?: number;
30
31
  }
31
32
 
@@ -23,4 +23,5 @@ export interface DialogContextValue {
23
23
  readonly toggle: (event?: Event | null) => boolean;
24
24
  }
25
25
 
26
+ /** Required context shared by one Dialog compound component tree. */
26
27
  export const dialogContext = createContext<DialogContextValue>("Dialog");
@@ -94,19 +94,19 @@ export interface DismissableLayerOptions {
94
94
  /** Whether non-composing Escape keydown can request dismissal. @default true */
95
95
  readonly escapeKey?: MaybeRefOrGetter<boolean | undefined>;
96
96
 
97
- /** Called before an outside pointer-down dismissal is committed. */
97
+ /** Called before an outside pointer-down dismissal is committed. @default undefined */
98
98
  readonly onPointerDownOutside?: (event: DismissableLayerPointerDownOutsideEvent) => void;
99
99
 
100
- /** Called before an outside focus dismissal is committed. */
100
+ /** Called before an outside focus dismissal is committed. @default undefined */
101
101
  readonly onFocusOutside?: (event: DismissableLayerFocusOutsideEvent) => void;
102
102
 
103
- /** Called for every outside pointer or focus interaction before dismissal is committed. */
103
+ /** Called for every outside pointer or focus interaction before dismissal is committed. @default undefined */
104
104
  readonly onInteractOutside?: (event: DismissableLayerInteractOutsideEvent) => void;
105
105
 
106
- /** Called before an Escape dismissal is committed. */
106
+ /** Called before an Escape dismissal is committed. @default undefined */
107
107
  readonly onEscapeKeyDown?: (event: DismissableLayerEscapeKeyDownEvent) => void;
108
108
 
109
- /** Called after a top-layer dismissal request has not been prevented. */
109
+ /** Called after a top-layer dismissal request has not been prevented. @default undefined */
110
110
  readonly onDismiss?: (event: DismissableLayerDismissEvent) => void;
111
111
  }
112
112
 
@@ -20,10 +20,10 @@ export interface PresenceOptions {
20
20
  */
21
21
  readonly respectReducedMotion?: MaybeRefOrGetter<boolean | undefined>;
22
22
 
23
- /** Called after enter animation completes or is skipped. */
23
+ /** Called after enter animation completes or is skipped. @default undefined */
24
24
  readonly onEnterComplete?: () => void;
25
25
 
26
- /** Called after exit animation completes or is skipped. */
26
+ /** Called after exit animation completes or is skipped. @default undefined */
27
27
  readonly onExitComplete?: () => void;
28
28
  }
29
29
 
@@ -63,7 +63,9 @@ export interface EmojiSectionOptions<T> {
63
63
  readonly columns: number;
64
64
  readonly search: string;
65
65
  readonly filter: EmojiPickerFilter<T>;
66
+ /** Category partitions to render after recent and search sections. @default [] */
66
67
  readonly categories?: readonly EmojiPickerCategory[] | undefined;
68
+ /** Recently selected items rendered before categories. @default [] */
67
69
  readonly recent?: readonly T[] | undefined;
68
70
  readonly recentLabel: string;
69
71
  readonly searchLabel: string;
@@ -37,7 +37,7 @@ export interface GridMoveOptions {
37
37
  readonly count: number;
38
38
  /** Cells per row (at least 1). */
39
39
  readonly columns: number;
40
- /** Reading direction; `rtl` mirrors left/right. */
40
+ /** Reading direction; `rtl` mirrors left/right. @default "ltr" */
41
41
  readonly direction?: "ltr" | "rtl";
42
42
  /** Rows traversed by PageUp/PageDown. @default 3 */
43
43
  readonly pageRows?: number;
@@ -74,7 +74,7 @@ export interface SelectCollectionOptions {
74
74
  /** Idle time before a typeahead query resets. */
75
75
  readonly typeaheadTimeout: MaybeRefOrGetter<number>;
76
76
 
77
- /** Options traversed by PageUp and PageDown. */
77
+ /** Options traversed by PageUp and PageDown. @default 10 */
78
78
  readonly pageSize?: MaybeRefOrGetter<number>;
79
79
  }
80
80