@fluentui/react-menu 0.0.0-nightly-20230502-0418.1 → 0.0.0-nightly-20230504-0417.1

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 (187) hide show
  1. package/CHANGELOG.json +25 -25
  2. package/CHANGELOG.md +15 -15
  3. package/dist/index.d.ts +755 -0
  4. package/lib/Menu.js +2 -0
  5. package/lib/Menu.js.map +1 -0
  6. package/lib/MenuDivider.js +2 -0
  7. package/lib/MenuDivider.js.map +1 -0
  8. package/lib/MenuGroup.js +2 -0
  9. package/lib/MenuGroup.js.map +1 -0
  10. package/lib/MenuGroupHeader.js +2 -0
  11. package/lib/MenuGroupHeader.js.map +1 -0
  12. package/lib/MenuItem.js +2 -0
  13. package/lib/MenuItem.js.map +1 -0
  14. package/lib/MenuItemCheckbox.js +2 -0
  15. package/lib/MenuItemCheckbox.js.map +1 -0
  16. package/lib/MenuItemRadio.js +2 -0
  17. package/lib/MenuItemRadio.js.map +1 -0
  18. package/lib/MenuList.js +2 -0
  19. package/lib/MenuList.js.map +1 -0
  20. package/lib/MenuPopover.js +2 -0
  21. package/lib/MenuPopover.js.map +1 -0
  22. package/lib/MenuSplitGroup.js +2 -0
  23. package/lib/MenuSplitGroup.js.map +1 -0
  24. package/lib/MenuTrigger.js +2 -0
  25. package/lib/MenuTrigger.js.map +1 -0
  26. package/lib/components/Menu/Menu.js +14 -0
  27. package/lib/components/Menu/Menu.js.map +1 -0
  28. package/lib/components/Menu/Menu.types.js +2 -0
  29. package/lib/components/Menu/Menu.types.js.map +1 -0
  30. package/lib/components/Menu/index.js +6 -0
  31. package/lib/components/Menu/index.js.map +1 -0
  32. package/lib/components/Menu/renderMenu.js +11 -0
  33. package/lib/components/Menu/renderMenu.js.map +1 -0
  34. package/lib/components/Menu/useMenu.js +268 -0
  35. package/lib/components/Menu/useMenu.js.map +1 -0
  36. package/lib/components/Menu/useMenuContextValues.js +41 -0
  37. package/lib/components/Menu/useMenuContextValues.js.map +1 -0
  38. package/lib/components/MenuDivider/MenuDivider.js +16 -0
  39. package/lib/components/MenuDivider/MenuDivider.js.map +1 -0
  40. package/lib/components/MenuDivider/MenuDivider.types.js +2 -0
  41. package/lib/components/MenuDivider/MenuDivider.types.js.map +1 -0
  42. package/lib/components/MenuDivider/index.js +6 -0
  43. package/lib/components/MenuDivider/index.js.map +1 -0
  44. package/lib/components/MenuDivider/renderMenuDivider.js +14 -0
  45. package/lib/components/MenuDivider/renderMenuDivider.js.map +1 -0
  46. package/lib/components/MenuDivider/useMenuDivider.js +19 -0
  47. package/lib/components/MenuDivider/useMenuDivider.js.map +1 -0
  48. package/lib/components/MenuDivider/useMenuDividerStyles.styles.js +25 -0
  49. package/lib/components/MenuDivider/useMenuDividerStyles.styles.js.map +1 -0
  50. package/lib/components/MenuGroup/MenuGroup.js +18 -0
  51. package/lib/components/MenuGroup/MenuGroup.js.map +1 -0
  52. package/lib/components/MenuGroup/MenuGroup.types.js +2 -0
  53. package/lib/components/MenuGroup/MenuGroup.types.js.map +1 -0
  54. package/lib/components/MenuGroup/index.js +7 -0
  55. package/lib/components/MenuGroup/index.js.map +1 -0
  56. package/lib/components/MenuGroup/renderMenuGroup.js +17 -0
  57. package/lib/components/MenuGroup/renderMenuGroup.js.map +1 -0
  58. package/lib/components/MenuGroup/useMenuGroup.js +21 -0
  59. package/lib/components/MenuGroup/useMenuGroup.js.map +1 -0
  60. package/lib/components/MenuGroup/useMenuGroupContextValues.js +13 -0
  61. package/lib/components/MenuGroup/useMenuGroupContextValues.js.map +1 -0
  62. package/lib/components/MenuGroup/useMenuGroupStyles.styles.js +9 -0
  63. package/lib/components/MenuGroup/useMenuGroupStyles.styles.js.map +1 -0
  64. package/lib/components/MenuGroupHeader/MenuGroupHeader.js +16 -0
  65. package/lib/components/MenuGroupHeader/MenuGroupHeader.js.map +1 -0
  66. package/lib/components/MenuGroupHeader/MenuGroupHeader.types.js +2 -0
  67. package/lib/components/MenuGroupHeader/MenuGroupHeader.types.js.map +1 -0
  68. package/lib/components/MenuGroupHeader/index.js +6 -0
  69. package/lib/components/MenuGroupHeader/index.js.map +1 -0
  70. package/lib/components/MenuGroupHeader/renderMenuGroupHeader.js +14 -0
  71. package/lib/components/MenuGroupHeader/renderMenuGroupHeader.js.map +1 -0
  72. package/lib/components/MenuGroupHeader/useMenuGroupHeader.js +22 -0
  73. package/lib/components/MenuGroupHeader/useMenuGroupHeader.js.map +1 -0
  74. package/lib/components/MenuGroupHeader/useMenuGroupHeaderStyles.styles.js +25 -0
  75. package/lib/components/MenuGroupHeader/useMenuGroupHeaderStyles.styles.js.map +1 -0
  76. package/lib/components/MenuItem/MenuItem.js +16 -0
  77. package/lib/components/MenuItem/MenuItem.js.map +1 -0
  78. package/lib/components/MenuItem/MenuItem.types.js +2 -0
  79. package/lib/components/MenuItem/MenuItem.types.js.map +1 -0
  80. package/lib/components/MenuItem/index.js +6 -0
  81. package/lib/components/MenuItem/index.js.map +1 -0
  82. package/lib/components/MenuItem/renderMenuItem.js +13 -0
  83. package/lib/components/MenuItem/renderMenuItem.js.map +1 -0
  84. package/lib/components/MenuItem/useCharacterSearch.js +20 -0
  85. package/lib/components/MenuItem/useCharacterSearch.js.map +1 -0
  86. package/lib/components/MenuItem/useMenuItem.js +101 -0
  87. package/lib/components/MenuItem/useMenuItem.js.map +1 -0
  88. package/lib/components/MenuItem/useMenuItemStyles.styles.js +150 -0
  89. package/lib/components/MenuItem/useMenuItemStyles.styles.js.map +1 -0
  90. package/lib/components/MenuItemCheckbox/MenuItemCheckbox.js +16 -0
  91. package/lib/components/MenuItemCheckbox/MenuItemCheckbox.js.map +1 -0
  92. package/lib/components/MenuItemCheckbox/MenuItemCheckbox.types.js +2 -0
  93. package/lib/components/MenuItemCheckbox/MenuItemCheckbox.types.js.map +1 -0
  94. package/lib/components/MenuItemCheckbox/index.js +6 -0
  95. package/lib/components/MenuItemCheckbox/index.js.map +1 -0
  96. package/lib/components/MenuItemCheckbox/renderMenuItemCheckbox.js +11 -0
  97. package/lib/components/MenuItemCheckbox/renderMenuItemCheckbox.js.map +1 -0
  98. package/lib/components/MenuItemCheckbox/useMenuItemCheckbox.js +42 -0
  99. package/lib/components/MenuItemCheckbox/useMenuItemCheckbox.js.map +1 -0
  100. package/lib/components/MenuItemCheckbox/useMenuItemCheckboxStyles.styles.js +28 -0
  101. package/lib/components/MenuItemCheckbox/useMenuItemCheckboxStyles.styles.js.map +1 -0
  102. package/lib/components/MenuItemRadio/MenuItemRadio.js +16 -0
  103. package/lib/components/MenuItemRadio/MenuItemRadio.js.map +1 -0
  104. package/lib/components/MenuItemRadio/MenuItemRadio.types.js +2 -0
  105. package/lib/components/MenuItemRadio/MenuItemRadio.types.js.map +1 -0
  106. package/lib/components/MenuItemRadio/index.js +6 -0
  107. package/lib/components/MenuItemRadio/index.js.map +1 -0
  108. package/lib/components/MenuItemRadio/renderMenuItemRadio.js +14 -0
  109. package/lib/components/MenuItemRadio/renderMenuItemRadio.js.map +1 -0
  110. package/lib/components/MenuItemRadio/useMenuItemRadio.js +42 -0
  111. package/lib/components/MenuItemRadio/useMenuItemRadio.js.map +1 -0
  112. package/lib/components/MenuItemRadio/useMenuItemRadioStyles.styles.js +28 -0
  113. package/lib/components/MenuItemRadio/useMenuItemRadioStyles.styles.js.map +1 -0
  114. package/lib/components/MenuList/MenuList.js +18 -0
  115. package/lib/components/MenuList/MenuList.js.map +1 -0
  116. package/lib/components/MenuList/MenuList.types.js +2 -0
  117. package/lib/components/MenuList/MenuList.types.js.map +1 -0
  118. package/lib/components/MenuList/index.js +7 -0
  119. package/lib/components/MenuList/index.js.map +1 -0
  120. package/lib/components/MenuList/renderMenuList.js +16 -0
  121. package/lib/components/MenuList/renderMenuList.js.map +1 -0
  122. package/lib/components/MenuList/useMenuList.js +147 -0
  123. package/lib/components/MenuList/useMenuList.js.map +1 -0
  124. package/lib/components/MenuList/useMenuListContextValues.js +23 -0
  125. package/lib/components/MenuList/useMenuListContextValues.js.map +1 -0
  126. package/lib/components/MenuList/useMenuListStyles.styles.js +23 -0
  127. package/lib/components/MenuList/useMenuListStyles.styles.js.map +1 -0
  128. package/lib/components/MenuPopover/MenuPopover.js +16 -0
  129. package/lib/components/MenuPopover/MenuPopover.js.map +1 -0
  130. package/lib/components/MenuPopover/MenuPopover.types.js +2 -0
  131. package/lib/components/MenuPopover/MenuPopover.types.js.map +1 -0
  132. package/lib/components/MenuPopover/index.js +6 -0
  133. package/lib/components/MenuPopover/index.js.map +1 -0
  134. package/lib/components/MenuPopover/renderMenuPopover.js +19 -0
  135. package/lib/components/MenuPopover/renderMenuPopover.js.map +1 -0
  136. package/lib/components/MenuPopover/useMenuPopover.js +108 -0
  137. package/lib/components/MenuPopover/useMenuPopover.js.map +1 -0
  138. package/lib/components/MenuPopover/useMenuPopoverStyles.styles.js +50 -0
  139. package/lib/components/MenuPopover/useMenuPopoverStyles.styles.js.map +1 -0
  140. package/lib/components/MenuSplitGroup/MenuSplitGroup.js +16 -0
  141. package/lib/components/MenuSplitGroup/MenuSplitGroup.js.map +1 -0
  142. package/lib/components/MenuSplitGroup/MenuSplitGroup.types.js +2 -0
  143. package/lib/components/MenuSplitGroup/MenuSplitGroup.types.js.map +1 -0
  144. package/lib/components/MenuSplitGroup/index.js +6 -0
  145. package/lib/components/MenuSplitGroup/index.js.map +1 -0
  146. package/lib/components/MenuSplitGroup/renderMenuSplitGroup.js +13 -0
  147. package/lib/components/MenuSplitGroup/renderMenuSplitGroup.js.map +1 -0
  148. package/lib/components/MenuSplitGroup/useMenuSplitGroup.js +61 -0
  149. package/lib/components/MenuSplitGroup/useMenuSplitGroup.js.map +1 -0
  150. package/lib/components/MenuSplitGroup/useMenuSplitGroupStyles.styles.js +34 -0
  151. package/lib/components/MenuSplitGroup/useMenuSplitGroupStyles.styles.js.map +1 -0
  152. package/lib/components/MenuTrigger/MenuTrigger.js +15 -0
  153. package/lib/components/MenuTrigger/MenuTrigger.js.map +1 -0
  154. package/lib/components/MenuTrigger/MenuTrigger.types.js +2 -0
  155. package/lib/components/MenuTrigger/MenuTrigger.types.js.map +1 -0
  156. package/lib/components/MenuTrigger/index.js +5 -0
  157. package/lib/components/MenuTrigger/index.js.map +1 -0
  158. package/lib/components/MenuTrigger/renderMenuTrigger.js +13 -0
  159. package/lib/components/MenuTrigger/renderMenuTrigger.js.map +1 -0
  160. package/lib/components/MenuTrigger/useMenuTrigger.styles.js +168 -0
  161. package/lib/components/MenuTrigger/useMenuTrigger.styles.js.map +1 -0
  162. package/lib/components/index.js +3 -0
  163. package/lib/components/index.js.map +1 -0
  164. package/lib/contexts/menuContext.js +27 -0
  165. package/lib/contexts/menuContext.js.map +1 -0
  166. package/lib/contexts/menuGroupContext.js +9 -0
  167. package/lib/contexts/menuGroupContext.js.map +1 -0
  168. package/lib/contexts/menuListContext.js +14 -0
  169. package/lib/contexts/menuListContext.js.map +1 -0
  170. package/lib/contexts/menuTriggerContext.js +10 -0
  171. package/lib/contexts/menuTriggerContext.js.map +1 -0
  172. package/lib/index.js +17 -0
  173. package/lib/index.js.map +1 -0
  174. package/lib/selectable/index.js +3 -0
  175. package/lib/selectable/index.js.map +1 -0
  176. package/lib/selectable/types.js +2 -0
  177. package/lib/selectable/types.js.map +1 -0
  178. package/lib/selectable/useCheckmarkStyles.styles.js +25 -0
  179. package/lib/selectable/useCheckmarkStyles.styles.js.map +1 -0
  180. package/lib/utils/index.js +2 -0
  181. package/lib/utils/index.js.map +1 -0
  182. package/lib/utils/useIsSubmenu.js +17 -0
  183. package/lib/utils/useIsSubmenu.js.map +1 -0
  184. package/lib/utils/useOnMenuEnter.js +65 -0
  185. package/lib/utils/useOnMenuEnter.js.map +1 -0
  186. package/package.json +12 -12
  187. package/.swcrc +0 -30
@@ -0,0 +1,755 @@
1
+ /// <reference types="react" />
2
+
3
+ import { ARIAButtonElement } from '@fluentui/react-aria';
4
+ import { ARIAButtonResultProps } from '@fluentui/react-aria';
5
+ import { ARIAButtonType } from '@fluentui/react-aria';
6
+ import type { ComponentProps } from '@fluentui/react-utilities';
7
+ import type { ComponentState } from '@fluentui/react-utilities';
8
+ import type { ContextSelector } from '@fluentui/react-context-selector';
9
+ import type { ForwardRefComponent } from '@fluentui/react-utilities';
10
+ import type { PortalProps } from '@fluentui/react-portal';
11
+ import type { PositioningShorthand } from '@fluentui/react-positioning';
12
+ import { PositioningVirtualElement } from '@fluentui/react-positioning';
13
+ import * as React_2 from 'react';
14
+ import { SetVirtualMouseTarget } from '@fluentui/react-positioning';
15
+ import type { Slot } from '@fluentui/react-utilities';
16
+ import type { SlotClassNames } from '@fluentui/react-utilities';
17
+ import type { TriggerProps } from '@fluentui/react-utilities';
18
+
19
+ /**
20
+ * Wrapper component that manages state for a popup MenuList and a MenuTrigger
21
+ */
22
+ export declare const Menu: React_2.FC<MenuProps>;
23
+
24
+ export declare type MenuCheckedValueChangeData = {
25
+ /** The items for this value that are checked */
26
+ checkedItems: string[];
27
+ /** The name of the value */
28
+ name: string;
29
+ };
30
+
31
+ export declare type MenuCheckedValueChangeEvent = React_2.MouseEvent | React_2.KeyboardEvent;
32
+
33
+ /**
34
+ * Context shared between Menu and its children components
35
+ *
36
+ * Extends and drills down MenuList props to simplify API
37
+ */
38
+ export declare type MenuContextValue = Pick<MenuState, 'openOnHover' | 'openOnContext' | 'triggerRef' | 'menuPopoverRef' | 'setOpen' | 'isSubmenu' | 'mountNode' | 'triggerId' | 'hasIcons' | 'hasCheckmarks' | 'persistOnItemClick' | 'inline' | 'checkedValues' | 'onCheckedValueChange'> & {
39
+ open: boolean;
40
+ triggerId: string;
41
+ /**
42
+ * Default values to be checked on mount
43
+ * @deprecated this property is not used internally anymore,
44
+ * the signature remains just to avoid breaking changes
45
+ */
46
+ defaultCheckedValues?: Record<string, string[]>;
47
+ };
48
+
49
+ export declare type MenuContextValues = {
50
+ menu: MenuContextValue;
51
+ };
52
+
53
+ /**
54
+ * Define a styled MenuDivider, using the `useMenuDivider_unstable` hook.
55
+ */
56
+ export declare const MenuDivider: ForwardRefComponent<MenuDividerProps>;
57
+
58
+ export declare const menuDividerClassNames: SlotClassNames<MenuDividerSlots>;
59
+
60
+ export declare type MenuDividerProps = ComponentProps<MenuDividerSlots>;
61
+
62
+ export declare type MenuDividerSlots = {
63
+ root: Slot<'div'>;
64
+ };
65
+
66
+ export declare type MenuDividerState = ComponentState<MenuDividerSlots>;
67
+
68
+ /**
69
+ * Define a styled MenuGroup, using the `useMenuGroup_unstable` hook.
70
+ */
71
+ export declare const MenuGroup: ForwardRefComponent<MenuGroupProps>;
72
+
73
+ export declare const menuGroupClassNames: SlotClassNames<MenuGroupSlots>;
74
+
75
+ export declare const MenuGroupContextProvider: React_2.Provider<MenuGroupContextValue>;
76
+
77
+ /**
78
+ * Context used to guarantee correct aria-relationship between header
79
+ * and group information
80
+ */
81
+ export declare type MenuGroupContextValue = {
82
+ /**
83
+ * Element id applied to the `MenuGroupHeader` component
84
+ */
85
+ headerId: string;
86
+ };
87
+
88
+ export declare type MenuGroupContextValues = {
89
+ menuGroup: MenuGroupContextValue;
90
+ };
91
+
92
+ /**
93
+ * Define a styled MenuGroupHeader, using the `useMenuGroupHeader_unstable` hook.
94
+ */
95
+ export declare const MenuGroupHeader: ForwardRefComponent<MenuGroupHeaderProps>;
96
+
97
+ export declare const menuGroupHeaderClassNames: SlotClassNames<MenuGroupHeaderSlots>;
98
+
99
+ export declare type MenuGroupHeaderProps = ComponentProps<MenuGroupHeaderSlots>;
100
+
101
+ export declare type MenuGroupHeaderSlots = {
102
+ root: Slot<'div'>;
103
+ };
104
+
105
+ export declare type MenuGroupHeaderState = ComponentState<MenuGroupHeaderSlots>;
106
+
107
+ export declare type MenuGroupProps = ComponentProps<MenuGroupSlots>;
108
+
109
+ export declare type MenuGroupSlots = {
110
+ root: Slot<'div'>;
111
+ };
112
+
113
+ export declare type MenuGroupState = ComponentState<MenuGroupSlots> & {
114
+ /**
115
+ * id applied to the DOM element of `MenuGroupHeader`
116
+ */
117
+ headerId: string;
118
+ };
119
+
120
+ /**
121
+ * Define a styled MenuItem, using the `useMenuItem_unstable` and `useMenuItemStyles_unstable` hook.
122
+ */
123
+ export declare const MenuItem: ForwardRefComponent<MenuItemProps>;
124
+
125
+ /**
126
+ * Define a styled MenuItemCheckbox, using the `useMenuItemCheckbox_unstable` hook.
127
+ */
128
+ export declare const MenuItemCheckbox: ForwardRefComponent<MenuItemCheckboxProps>;
129
+
130
+ export declare const menuItemCheckboxClassNames: SlotClassNames<Omit<MenuItemSlots, 'submenuIndicator'>>;
131
+
132
+ export declare type MenuItemCheckboxProps = MenuItemProps & MenuItemSelectableProps;
133
+
134
+ export declare type MenuItemCheckboxState = MenuItemState & MenuItemSelectableState;
135
+
136
+ export declare const menuItemClassNames: SlotClassNames<MenuItemSlots>;
137
+
138
+ export declare type MenuItemProps = ComponentProps<Partial<MenuItemSlots>> & {
139
+ /**
140
+ * If the menu item is a trigger for a submenu
141
+ *
142
+ * @default false
143
+ */
144
+ hasSubmenu?: boolean;
145
+ /**
146
+ * Clicking on the menu item will not dismiss an open menu
147
+ *
148
+ * @default false
149
+ */
150
+ persistOnClick?: boolean;
151
+ disabled?: boolean;
152
+ /**
153
+ * @deprecated this property does nothing.
154
+ * disabled focusable is by default by simply using `disabled` property
155
+ */
156
+ disabledFocusable?: boolean;
157
+ };
158
+
159
+ /**
160
+ * Define a styled MenuItemRadio, using the `useMenuItemRadio_unstable` hook.
161
+ */
162
+ export declare const MenuItemRadio: ForwardRefComponent<MenuItemRadioProps>;
163
+
164
+ export declare const menuItemRadioClassNames: SlotClassNames<Omit<MenuItemSlots, 'submenuIndicator'>>;
165
+
166
+ export declare type MenuItemRadioProps = MenuItemProps & MenuItemSelectableProps;
167
+
168
+ export declare type MenuItemRadioState = MenuItemState & MenuItemSelectableState;
169
+
170
+ /**
171
+ * Props for selecatble menu items
172
+ */
173
+ export declare type MenuItemSelectableProps = {
174
+ /**
175
+ * Follows input convention
176
+ * https://www.w3schools.com/jsref/prop_checkbox_name.asp
177
+ */
178
+ name: string;
179
+ /**
180
+ * Follows input convention
181
+ * https://www.w3schools.com/jsref/prop_checkbox_value.asp
182
+ */
183
+ value: string;
184
+ };
185
+
186
+ /**
187
+ * State for selectable menu items
188
+ */
189
+ export declare type MenuItemSelectableState = MenuItemSelectableProps & {
190
+ /**
191
+ * Selectable is checked
192
+ */
193
+ checked: boolean;
194
+ };
195
+
196
+ export declare type MenuItemSlots = {
197
+ root: Slot<'div'>;
198
+ /**
199
+ * Icon slot rendered before children content
200
+ */
201
+ icon?: Slot<'span'>;
202
+ /**
203
+ * A helper slot for alignment when a menu item is used with selectable menuitems
204
+ * Avoid using this slot as a replacement for MenuItemCheckbox and MenuItemRadio components
205
+ */
206
+ checkmark?: Slot<'span'>;
207
+ /**
208
+ * Icon slot that shows the indicator for a submenu
209
+ */
210
+ submenuIndicator?: Slot<'span'>;
211
+ /**
212
+ * Component children are placed in this slot
213
+ * Avoid using the `children` property in this slot in favour of Component children whenever possible
214
+ */
215
+ content?: Slot<'span'>;
216
+ /**
217
+ * Secondary content rendered opposite the primary content (e.g Shortcut text)
218
+ */
219
+ secondaryContent?: Slot<'span'>;
220
+ };
221
+
222
+ export declare type MenuItemState = ComponentState<MenuItemSlots> & Required<Pick<MenuItemProps, 'disabled' | 'hasSubmenu' | 'persistOnClick'>>;
223
+
224
+ /**
225
+ * Define a styled MenuList, using the `useMenuList_unstable` hook.
226
+ */
227
+ export declare const MenuList: ForwardRefComponent<MenuListProps>;
228
+
229
+ export declare const menuListClassNames: SlotClassNames<MenuListSlots>;
230
+
231
+ /**
232
+ * Context shared between MenuList and its children components
233
+ */
234
+ export declare type MenuListContextValue = Pick<MenuListProps, 'checkedValues' | 'hasIcons' | 'hasCheckmarks'> & {
235
+ setFocusByFirstCharacter?: (e: React_2.KeyboardEvent<HTMLElement>, itemEl: HTMLElement) => void;
236
+ toggleCheckbox?: SelectableHandler;
237
+ selectRadio?: SelectableHandler;
238
+ /**
239
+ * Callback when checked items change for value with a name
240
+ *
241
+ * @param event - React's original SyntheticEvent
242
+ * @param data - A data object with relevant information
243
+ *
244
+ * @deprecated this property is not used internally anymore,
245
+ * the signature remains just to avoid breaking changes
246
+ */
247
+ onCheckedValueChange?: (e: MenuCheckedValueChangeEvent, data: MenuCheckedValueChangeData) => void;
248
+ };
249
+
250
+ export declare type MenuListContextValues = {
251
+ menuList: MenuListContextValue;
252
+ };
253
+
254
+ export declare type MenuListProps = ComponentProps<MenuListSlots> & {
255
+ /**
256
+ * Map of all checked values
257
+ */
258
+ checkedValues?: Record<string, string[]>;
259
+ /**
260
+ * Default values to be checked on mount
261
+ */
262
+ defaultCheckedValues?: Record<string, string[]>;
263
+ /**
264
+ * States that menu items can contain selectable items and reserve slots for item alignment
265
+ */
266
+ hasCheckmarks?: boolean;
267
+ /**
268
+ * States that menu items can contain icons and reserve slots for item alignment
269
+ */
270
+ hasIcons?: boolean;
271
+ /**
272
+ * Callback when checked items change for value with a name
273
+ *
274
+ * @param event - React's original SyntheticEvent
275
+ * @param data - A data object with relevant information
276
+ */
277
+ onCheckedValueChange?: (e: MenuCheckedValueChangeEvent, data: MenuCheckedValueChangeData) => void;
278
+ };
279
+
280
+ export declare const MenuListProvider: React_2.Provider<MenuListContextValue> & React_2.FC<React_2.ProviderProps<MenuListContextValue>>;
281
+
282
+ export declare type MenuListSlots = {
283
+ root: Slot<'div'>;
284
+ };
285
+
286
+ export declare type MenuListState = ComponentState<MenuListSlots> & Required<Pick<MenuListProps, 'checkedValues' | 'hasCheckmarks' | 'hasIcons'>> & Pick<MenuListProps, 'defaultCheckedValues' | 'onCheckedValueChange'> & {
287
+ /**
288
+ * Selects a radio item, will de-select the currently selected ratio item
289
+ */
290
+ selectRadio: SelectableHandler;
291
+ /**
292
+ * Callback to set focus on the next menu item by first character
293
+ */
294
+ setFocusByFirstCharacter: NonNullable<MenuListContextValue['setFocusByFirstCharacter']>;
295
+ toggleCheckbox: SelectableHandler;
296
+ };
297
+
298
+ /**
299
+ * Data attached to open/close events
300
+ */
301
+ export declare type MenuOpenChangeData = {
302
+ /**
303
+ * indicates whether the request for the open state was bubbled from a nested menu
304
+ */
305
+ bubble?: boolean;
306
+ /**
307
+ * Indicates whether the change of state was a keyboard interaction
308
+ * @deprecated
309
+ * This should not be used, since `Enter`, `Space` and click should be interpreted as the same thing as a click
310
+ */
311
+ keyboard?: boolean;
312
+ open: boolean;
313
+ } & ({
314
+ type: 'menuTriggerContextMenu';
315
+ event: React_2.MouseEvent<HTMLElement>;
316
+ } | {
317
+ type: 'menuTriggerClick';
318
+ event: React_2.MouseEvent<HTMLElement>;
319
+ } | {
320
+ type: 'menuTriggerMouseEnter';
321
+ event: React_2.MouseEvent<HTMLElement>;
322
+ } | {
323
+ type: 'menuTriggerMouseLeave';
324
+ event: React_2.MouseEvent<HTMLElement>;
325
+ } | {
326
+ type: 'menuTriggerMouseMove';
327
+ event: React_2.MouseEvent<HTMLElement>;
328
+ } | {
329
+ type: 'menuTriggerKeyDown';
330
+ event: React_2.KeyboardEvent<HTMLElement>;
331
+ } | {
332
+ type: 'menuItemClick';
333
+ event: React_2.MouseEvent<HTMLElement>;
334
+ } | {
335
+ type: 'menuPopoverMouseEnter';
336
+ event: React_2.MouseEvent<HTMLElement>;
337
+ } | {
338
+ type: 'menuPopoverKeyDown';
339
+ event: React_2.KeyboardEvent<HTMLElement>;
340
+ } | {
341
+ type: 'clickOutside';
342
+ event: MouseEvent | TouchEvent;
343
+ } | {
344
+ type: 'scrollOutside';
345
+ event: MouseEvent | TouchEvent;
346
+ } | {
347
+ type: 'menuMouseEnter';
348
+ event: MouseEvent | TouchEvent;
349
+ });
350
+
351
+ /**
352
+ * The supported events that will trigger open/close of the menu
353
+ */
354
+ export declare type MenuOpenEvent = MenuOpenChangeData['event'];
355
+
356
+ /**
357
+ * @deprecated use MenuOpenEvent instead
358
+ */
359
+ export declare type MenuOpenEvents = MenuOpenEvent;
360
+
361
+ /**
362
+ * Popover intended to wrap `MenuList` and adds styling and interaction support specific to menus
363
+ */
364
+ export declare const MenuPopover: ForwardRefComponent<MenuPopoverProps>;
365
+
366
+ export declare const menuPopoverClassNames: SlotClassNames<MenuPopoverSlots>;
367
+
368
+ /**
369
+ * MenuPopover Props
370
+ */
371
+ export declare type MenuPopoverProps = ComponentProps<MenuPopoverSlots>;
372
+
373
+ export declare type MenuPopoverSlots = {
374
+ root: Slot<'div'>;
375
+ };
376
+
377
+ /**
378
+ * State used in rendering MenuPopover
379
+ */
380
+ export declare type MenuPopoverState = ComponentState<MenuPopoverSlots> & Pick<PortalProps, 'mountNode'> & {
381
+ /**
382
+ * Root menus are rendered out of DOM order on `document.body`, use this to render the menu in DOM order
383
+ * This option is disregarded for submenus
384
+ */
385
+ inline: boolean;
386
+ };
387
+
388
+ /**
389
+ * Extends and drills down Menulist props to simplify API
390
+ */
391
+ export declare type MenuProps = ComponentProps<MenuSlots> & Pick<PortalProps, 'mountNode'> & Pick<MenuListProps, 'checkedValues' | 'defaultCheckedValues' | 'hasCheckmarks' | 'hasIcons' | 'onCheckedValueChange'> & {
392
+ /**
393
+ * Can contain two children including {@link MenuTrigger} and {@link MenuPopover}.
394
+ * Alternatively can only contain {@link MenuPopover} if using a custom `target`.
395
+ */
396
+ children: [JSX.Element, JSX.Element] | JSX.Element;
397
+ /**
398
+ * Sets the delay for mouse open/close for the popover one mouse enter/leave
399
+ */
400
+ hoverDelay?: number;
401
+ /**
402
+ * Root menus are rendered out of DOM order on `document.body`, use this to render the menu in DOM order
403
+ * This option is disregarded for submenus
404
+ *
405
+ * @default false
406
+ */
407
+ inline?: boolean;
408
+ /**
409
+ * Call back when the component requests to change value
410
+ * The `open` value is used as a hint when directly controlling the component
411
+ */
412
+ onOpenChange?: (e: MenuOpenEvent, data: MenuOpenChangeData) => void;
413
+ /**
414
+ * Whether the popup is open
415
+ *
416
+ * @default false
417
+ */
418
+ open?: boolean;
419
+ /**
420
+ * Whether the popup is open by default
421
+ *
422
+ * @default false
423
+ */
424
+ defaultOpen?: boolean;
425
+ /**
426
+ * Opens the menu on right click (context menu), removes all other menu open interactions
427
+ *
428
+ * @default false
429
+ */
430
+ openOnContext?: boolean;
431
+ /**
432
+ * Opens the menu on hover
433
+ *
434
+ * @default false
435
+ */
436
+ openOnHover?: boolean;
437
+ /**
438
+ * Do not dismiss the menu when a menu item is clicked
439
+ *
440
+ * @default false
441
+ */
442
+ persistOnItemClick?: boolean;
443
+ /**
444
+ * Configures the positioned menu
445
+ */
446
+ positioning?: PositioningShorthand;
447
+ /**
448
+ * Close when scroll outside of it
449
+ *
450
+ * @default false
451
+ */
452
+ closeOnScroll?: boolean;
453
+ };
454
+
455
+ export declare const MenuProvider: React_2.Provider<MenuContextValue> & React_2.FC<React_2.ProviderProps<MenuContextValue>>;
456
+
457
+ export declare type MenuSlots = {};
458
+
459
+ /**
460
+ * Layout wrapper that provides extra keyboard navigation behavior for two `MenuItem` components.
461
+ */
462
+ export declare const MenuSplitGroup: ForwardRefComponent<MenuSplitGroupProps>;
463
+
464
+ export declare const menuSplitGroupClassNames: SlotClassNames<MenuSplitGroupSlots>;
465
+
466
+ /**
467
+ * MenuSplitGroup Props
468
+ */
469
+ export declare type MenuSplitGroupProps = ComponentProps<MenuSplitGroupSlots>;
470
+
471
+ export declare type MenuSplitGroupSlots = {
472
+ root: Slot<'div'>;
473
+ };
474
+
475
+ /**
476
+ * State used in rendering MenuSplitGroup
477
+ */
478
+ export declare type MenuSplitGroupState = ComponentState<MenuSplitGroupSlots>;
479
+
480
+ export declare type MenuState = ComponentState<MenuSlots> & Required<Pick<MenuProps, 'hasCheckmarks' | 'hasIcons' | 'mountNode' | 'inline' | 'checkedValues' | 'onCheckedValueChange' | 'open' | 'openOnHover' | 'closeOnScroll' | 'hoverDelay' | 'openOnContext' | 'persistOnItemClick'>> & {
481
+ /**
482
+ * Anchors the popper to the mouse click for context events
483
+ */
484
+ contextTarget?: PositioningVirtualElement;
485
+ /**
486
+ * Whether this menu is a submenu
487
+ */
488
+ isSubmenu: boolean;
489
+ /**
490
+ * Internal react node that just simplifies handling children
491
+ */
492
+ menuPopover: React_2.ReactNode;
493
+ /**
494
+ * The ref for the popup
495
+ */
496
+ menuPopoverRef: React_2.MutableRefObject<HTMLElement>;
497
+ /**
498
+ * Internal react node that just simplifies handling children
499
+ */
500
+ menuTrigger: React_2.ReactNode;
501
+ /**
502
+ * A callback to set the target of the popper to the mouse click for context events
503
+ */
504
+ setContextTarget: SetVirtualMouseTarget;
505
+ /**
506
+ * Callback to open/close the popup
507
+ */
508
+ setOpen: (e: MenuOpenEvent, data: MenuOpenChangeData) => void;
509
+ /**
510
+ * Id for the MenuTrigger element for aria relationship
511
+ */
512
+ triggerId: string;
513
+ /**
514
+ * The ref for the MenuTrigger, used for popup positioning
515
+ */
516
+ triggerRef: React_2.MutableRefObject<HTMLElement>;
517
+ /**
518
+ * Call back when the component requests to change value
519
+ * The `open` value is used as a hint when directly controlling the component
520
+ * @deprecated this property is not used internally anymore,
521
+ * the signature remains just to avoid breaking changes
522
+ */
523
+ onOpenChange?: (e: MenuOpenEvent, data: MenuOpenChangeData) => void;
524
+ /**
525
+ * Default values to be checked on mount
526
+ @deprecated this property is not used internally anymore,
527
+ * the signature remains just to avoid breaking changes
528
+ */
529
+ defaultCheckedValues?: Record<string, string[]>;
530
+ };
531
+
532
+ /**
533
+ * Wraps a trigger element as an only child
534
+ * and adds the necessary event handling to open a popup menu
535
+ */
536
+ export declare const MenuTrigger: React_2.FC<MenuTriggerProps>;
537
+
538
+ /**
539
+ * Props that are passed to the child of the MenuTrigger when cloned to ensure correct behaviour for the Menu
540
+ */
541
+ export declare type MenuTriggerChildProps<Type extends ARIAButtonType = ARIAButtonType, Props = {}> = ARIAButtonResultProps<Type, Props & {
542
+ 'aria-haspopup'?: 'menu';
543
+ 'aria-expanded'?: boolean;
544
+ id: string;
545
+ ref: React_2.Ref<never>;
546
+ onMouseEnter: React_2.MouseEventHandler<HTMLButtonElement & HTMLAnchorElement & HTMLDivElement>;
547
+ onMouseLeave: React_2.MouseEventHandler<HTMLButtonElement & HTMLAnchorElement & HTMLDivElement>;
548
+ onMouseMove: React_2.MouseEventHandler<HTMLButtonElement & HTMLAnchorElement & HTMLDivElement>;
549
+ onContextMenu: React_2.MouseEventHandler<HTMLButtonElement & HTMLAnchorElement & HTMLDivElement>;
550
+ }>;
551
+
552
+ export declare const MenuTriggerContextProvider: React_2.Provider<boolean>;
553
+
554
+ export declare type MenuTriggerProps = TriggerProps<MenuTriggerChildProps> & {
555
+ /**
556
+ * Disables internal trigger mechanism that ensures a child provided will be a compliant ARIA button.
557
+ * @default false
558
+ */
559
+ disableButtonEnhancement?: boolean;
560
+ };
561
+
562
+ export declare type MenuTriggerState = {
563
+ children: React_2.ReactElement | null;
564
+ isSubmenu: boolean;
565
+ };
566
+
567
+ /**
568
+ * Render the final JSX of Menu
569
+ */
570
+ export declare const renderMenu_unstable: (state: MenuState, contextValues: MenuContextValues) => JSX.Element;
571
+
572
+ /**
573
+ * Redefine the render function to add slots. Reuse the menudivider structure but add
574
+ * slots to children.
575
+ */
576
+ export declare const renderMenuDivider_unstable: (state: MenuDividerState) => JSX.Element;
577
+
578
+ /**
579
+ * Redefine the render function to add slots. Reuse the menugroup structure but add
580
+ * slots to children.
581
+ */
582
+ export declare const renderMenuGroup_unstable: (state: MenuGroupState, contextValues: MenuGroupContextValues) => JSX.Element;
583
+
584
+ /**
585
+ * Redefine the render function to add slots. Reuse the menugroupheader structure but add
586
+ * slots to children.
587
+ */
588
+ export declare const renderMenuGroupHeader_unstable: (state: MenuGroupHeaderState) => JSX.Element;
589
+
590
+ /**
591
+ * Function that renders the final JSX of the component
592
+ */
593
+ export declare const renderMenuItem_unstable: (state: MenuItemState) => JSX.Element;
594
+
595
+ /** Function that renders the final JSX of the component */
596
+ export declare const renderMenuItemCheckbox_unstable: (state: MenuItemCheckboxState) => JSX.Element;
597
+
598
+ /**
599
+ * Redefine the render function to add slots. Reuse the menuitemradio structure but add
600
+ * slots to children.
601
+ */
602
+ export declare const renderMenuItemRadio_unstable: (state: MenuItemRadioState) => JSX.Element;
603
+
604
+ /**
605
+ * Function that renders the final JSX of the component
606
+ */
607
+ export declare const renderMenuList_unstable: (state: MenuListState, contextValues: MenuListContextValues) => JSX.Element;
608
+
609
+ /**
610
+ * Render the final JSX of MenuPopover
611
+ */
612
+ export declare const renderMenuPopover_unstable: (state: MenuPopoverState) => JSX.Element;
613
+
614
+ /**
615
+ * Render the final JSX of MenuSplitGroup
616
+ */
617
+ export declare const renderMenuSplitGroup_unstable: (state: MenuSplitGroupState) => JSX.Element;
618
+
619
+ /**
620
+ * Render the final JSX of MenuTrigger
621
+ *
622
+ * Only renders children
623
+ */
624
+ export declare const renderMenuTrigger_unstable: (state: MenuTriggerState) => JSX.Element;
625
+
626
+ export declare type SelectableHandler = (e: React_2.MouseEvent | React_2.KeyboardEvent, name: string, value: string, checked: boolean) => void;
627
+
628
+ /**
629
+ * @deprecated this type is not being used internally anymore
630
+ */
631
+ export declare type UninitializedMenuListState = Omit<MenuListState, 'checkedValues' | 'selectRadio' | 'setFocusByFirstCharacter' | 'toggleCheckbox'> & Partial<Pick<MenuListState, 'checkedValues'>>;
632
+
633
+ /**
634
+ * Applies styles to a checkmark slot for selectable menu items
635
+ *
636
+ * @param state - should contain a `checkmark` slot
637
+ */
638
+ export declare const useCheckmarkStyles_unstable: (state: MenuItemSelectableState & Pick<MenuItemState, 'checkmark'>) => void;
639
+
640
+ /**
641
+ * Create the state required to render Menu.
642
+ *
643
+ * The returned state can be modified with hooks such as useMenuStyles,
644
+ * before being passed to renderMenu_unstable.
645
+ *
646
+ * @param props - props from this instance of Menu
647
+ */
648
+ export declare const useMenu_unstable: (props: MenuProps) => MenuState;
649
+
650
+ export declare const useMenuContext_unstable: <T>(selector: ContextSelector<MenuContextValue, T>) => T;
651
+
652
+ export declare function useMenuContextValues_unstable(state: MenuState): MenuContextValues;
653
+
654
+ /**
655
+ * Given user props, returns state and render function for a MenuDivider.
656
+ */
657
+ export declare const useMenuDivider_unstable: (props: MenuDividerProps, ref: React_2.Ref<HTMLElement>) => MenuDividerState;
658
+
659
+ export declare const useMenuDividerStyles_unstable: (state: MenuDividerState) => MenuDividerState;
660
+
661
+ /**
662
+ * Given user props, returns state and render function for a MenuGroup.
663
+ */
664
+ export declare function useMenuGroup_unstable(props: MenuGroupProps, ref: React_2.Ref<HTMLElement>): MenuGroupState;
665
+
666
+ export declare const useMenuGroupContext_unstable: () => MenuGroupContextValue;
667
+
668
+ export declare function useMenuGroupContextValues_unstable(state: MenuGroupState): MenuGroupContextValues;
669
+
670
+ /**
671
+ * Given user props, returns state and render function for a MenuGroupHeader.
672
+ */
673
+ export declare function useMenuGroupHeader_unstable(props: MenuGroupHeaderProps, ref: React_2.Ref<HTMLElement>): MenuGroupHeaderState;
674
+
675
+ export declare const useMenuGroupHeaderStyles_unstable: (state: MenuGroupHeaderState) => MenuGroupHeaderState;
676
+
677
+ export declare const useMenuGroupStyles_unstable: (state: MenuGroupState) => MenuGroupState;
678
+
679
+ /**
680
+ * Returns the props and state required to render the component
681
+ */
682
+ export declare const useMenuItem_unstable: (props: MenuItemProps, ref: React_2.Ref<ARIAButtonElement<'div'>>) => MenuItemState;
683
+
684
+ /** Returns the props and state required to render the component */
685
+ export declare const useMenuItemCheckbox_unstable: (props: MenuItemCheckboxProps, ref: React_2.Ref<ARIAButtonElement<'div'>>) => MenuItemCheckboxState;
686
+
687
+ export declare const useMenuItemCheckboxStyles_unstable: (state: MenuItemCheckboxState) => void;
688
+
689
+ /**
690
+ * Given user props, returns state and render function for a MenuItemRadio.
691
+ */
692
+ export declare const useMenuItemRadio_unstable: (props: MenuItemRadioProps, ref: React_2.Ref<ARIAButtonElement<'div'>>) => MenuItemRadioState;
693
+
694
+ export declare const useMenuItemRadioStyles_unstable: (state: MenuItemRadioState) => void;
695
+
696
+ /** Applies style classnames to slots */
697
+ export declare const useMenuItemStyles_unstable: (state: MenuItemState) => void;
698
+
699
+ /**
700
+ * Returns the props and state required to render the component
701
+ */
702
+ export declare const useMenuList_unstable: (props: MenuListProps, ref: React_2.Ref<HTMLElement>) => MenuListState;
703
+
704
+ export declare const useMenuListContext_unstable: <T>(selector: ContextSelector<MenuListContextValue, T>) => T;
705
+
706
+ export declare function useMenuListContextValues_unstable(state: MenuListState): MenuListContextValues;
707
+
708
+ /**
709
+ * Apply styling to the Menu slots based on the state
710
+ */
711
+ export declare const useMenuListStyles_unstable: (state: MenuListState) => MenuListState;
712
+
713
+ /**
714
+ * Create the state required to render MenuPopover.
715
+ *
716
+ * The returned state can be modified with hooks such as useMenuPopoverStyles_unstable,
717
+ * before being passed to renderMenuPopover_unstable.
718
+ *
719
+ * @param props - props from this instance of MenuPopover
720
+ * @param ref - reference to root HTMLElement of MenuPopover
721
+ */
722
+ export declare const useMenuPopover_unstable: (props: MenuPopoverProps, ref: React_2.Ref<HTMLElement>) => MenuPopoverState;
723
+
724
+ /**
725
+ * Apply styling to the Menu slots based on the state
726
+ */
727
+ export declare const useMenuPopoverStyles_unstable: (state: MenuPopoverState) => MenuPopoverState;
728
+
729
+ /**
730
+ * Create the state required to render MenuSplitGroup.
731
+ *
732
+ * The returned state can be modified with hooks such as useMenuSplitGroupStyles_unstable,
733
+ * before being passed to renderMenuSplitGroup_unstable.
734
+ *
735
+ * @param props - props from this instance of MenuSplitGroup
736
+ * @param ref - reference to root HTMLElement of MenuSplitGroup
737
+ */
738
+ export declare const useMenuSplitGroup_unstable: (props: MenuSplitGroupProps, ref: React_2.Ref<HTMLElement>) => MenuSplitGroupState;
739
+
740
+ /**
741
+ * Apply styling to the MenuSplitGroup slots based on the state
742
+ */
743
+ export declare const useMenuSplitGroupStyles_unstable: (state: MenuSplitGroupState) => MenuSplitGroupState;
744
+
745
+ /**
746
+ * Create the state required to render MenuTrigger.
747
+ * Clones the only child component and adds necessary event handling behaviours to open a popup menu
748
+ *
749
+ * @param props - props from this instance of MenuTrigger
750
+ */
751
+ export declare const useMenuTrigger_unstable: (props: MenuTriggerProps) => MenuTriggerState;
752
+
753
+ export declare const useMenuTriggerContext_unstable: () => boolean;
754
+
755
+ export { }