chore: Exporting MENU_ENTER_EVENT and dispatchMenuEnterEvent utilitie…

…s from @fluentui/react-menu (#28499) * chore: Exporting MENU_ENTER_EVENT and dispatchMenuEnterEvent utilities from @fluentui/react-menu. * Adding change file. * Updating API.
microsoft · Jul 18, 2023 · 5918d22 · 5918d22
1 parent 3cbeb7e
commit 5918d22
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 3 deletions.
diff --git a/change/@fluentui-react-menu-f1d69af6-f08c-4798-9e3e-f6b558ea2553.json b/change/@fluentui-react-menu-f1d69af6-f08c-4798-9e3e-f6b558ea2553.json
@@ -0,0 +1,7 @@
+{
+  "type": "minor",
+  "comment": "chore: Exporting MENU_ENTER_EVENT and dispatchMenuEnterEvent utilities.",
+  "packageName": "@fluentui/react-menu",
+  "email": "Humberto.Morimoto@microsoft.com",
+  "dependentChangeType": "patch"
+}
diff --git a/packages/react-components/react-menu/etc/react-menu.api.md b/packages/react-components/react-menu/etc/react-menu.api.md
@@ -23,9 +23,15 @@ import type { SlotClassNames } from '@fluentui/react-utilities';
 import type { TriggerProps } from '@fluentui/react-utilities';
 import type { UseOnClickOrScrollOutsideOptions } from '@fluentui/react-utilities';
 
+// @public
+export const dispatchMenuEnterEvent: (el: HTMLElement, nativeEvent: MouseEvent) => void;
+
 // @public
 export const Menu: React_2.FC<MenuProps>;
 
+// @public
+export const MENU_ENTER_EVENT = "fuimenuenter";
+
 // @public (undocumented)
 export type MenuCheckedValueChangeData = {
     checkedItems: string[];

diff --git a/packages/react-components/react-menu/src/index.ts b/packages/react-components/react-menu/src/index.ts
@@ -117,4 +117,4 @@ export {
 } from './MenuItemLink';
 export type { MenuItemLinkProps, MenuItemLinkSlots, MenuItemLinkState } from './MenuItemLink';
 
-export { useOnMenuMouseEnter } from './utils';
+export { MENU_ENTER_EVENT, dispatchMenuEnterEvent, useOnMenuMouseEnter } from './utils';
diff --git a/packages/react-components/react-menu/src/utils/useOnMenuEnter.ts b/packages/react-components/react-menu/src/utils/useOnMenuEnter.ts
@@ -62,8 +62,8 @@ export const useOnMenuMouseEnter = (options: UseOnClickOrScrollOutsideOptions) =
 
 /**
  * Dispatches the custom MouseEvent enter event. Similar to calling `el.click()`
- * @param el element for the event target
- * @param nativeEvent the native mouse event this is mapped to
+ * @param el - element for the event target
+ * @param nativeEvent - the native mouse event this is mapped to
  */
 export const dispatchMenuEnterEvent = (el: HTMLElement, nativeEvent: MouseEvent) => {
   el.dispatchEvent(new CustomEvent(MENU_ENTER_EVENT, { bubbles: true, detail: { nativeEvent } }));