Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
Comment thread
dmytrokirpa marked this conversation as resolved.
"type": "patch",
"comment": "fix: update useMenuTriggerBase hook signature",
"packageName": "@fluentui/react-headless-components-preview",
"email": "dmytrokirpa@microsoft.com",
"dependentChangeType": "patch"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "patch",
"comment": "fix: update useMenuTriggerBase hook signature",
"packageName": "@fluentui/react-menu",
"email": "dmytrokirpa@microsoft.com",
"dependentChangeType": "patch"
}
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ export const useMenuTrigger = (props: MenuTriggerProps): MenuTriggerState => {
firstFocusable?.focus();
}, [menuPopoverRef]);

const baseState = useMenuTriggerBase_unstable(props, { focusFirst });
const baseState = useMenuTriggerBase_unstable({ ...props, focusFirst });
const open = useMenuContext(ctx => ctx.open);
const openOnContext = useMenuContext(ctx => ctx.openOnContext);
const setOpen = useMenuContext(ctx => ctx.setOpen);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -414,6 +414,11 @@ export type MenuState = ComponentState<InternalMenuSlots> & Required<Pick<MenuPr
// @public
export const MenuTrigger: React_2.FC<MenuTriggerProps>;

// @public (undocumented)
export type MenuTriggerBaseProps = MenuTriggerProps & {
focusFirst?: () => void;
};

// @public
export type MenuTriggerChildProps<Type extends ARIAButtonType = ARIAButtonType, Props = {}> = ARIAButtonResultProps<Type, Props & {
'aria-haspopup'?: 'menu';
Expand Down Expand Up @@ -612,12 +617,7 @@ export const useMenuSplitGroupStyles_unstable: (state: MenuSplitGroupState) => M
export const useMenuTrigger_unstable: (props: MenuTriggerProps) => MenuTriggerState;

// @public
export const useMenuTriggerBase_unstable: (props: MenuTriggerProps, options?: UseMenuTriggerBaseOptions) => MenuTriggerState;

// @public
export type UseMenuTriggerBaseOptions = {
focusFirst?: () => void;
};
export const useMenuTriggerBase_unstable: (props: MenuTriggerBaseProps) => MenuTriggerState;

// @public (undocumented)
export const useMenuTriggerContext_unstable: () => boolean;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
export type {
MenuTriggerChildProps,
MenuTriggerBaseProps,
MenuTriggerProps,
MenuTriggerState,
UseMenuTriggerBaseOptions,
} from './components/MenuTrigger/index';
export {
MenuTrigger,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,15 @@ export type MenuTriggerProps = TriggerProps<MenuTriggerChildProps> & {
disableButtonEnhancement?: boolean;
};

export type MenuTriggerBaseProps = MenuTriggerProps & {
/**
* Optional callback to focus the first focusable element in the menu popover
* when an arrow key is pressed on an open submenu trigger.
* If omitted, the keyboard handler is a no-op.
*/
focusFirst?: () => void;
};

/**
* Props that are passed to the child of the MenuTrigger when cloned to ensure correct behaviour for the Menu
*/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
export { MenuTrigger } from './MenuTrigger';
export type { MenuTriggerChildProps, MenuTriggerProps, MenuTriggerState } from './MenuTrigger.types';
export type {
MenuTriggerChildProps,
MenuTriggerBaseProps,
MenuTriggerProps,
MenuTriggerState,
} from './MenuTrigger.types';
export { renderMenuTrigger_unstable } from './renderMenuTrigger';
export { useMenuTrigger_unstable, useMenuTriggerBase_unstable } from './useMenuTrigger';
export type { UseMenuTriggerBaseOptions } from './useMenuTrigger';
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import {
} from '@fluentui/react-utilities';
import * as React from 'react';

import type { MenuTriggerProps, MenuTriggerState } from './MenuTrigger.types';
import type { MenuTriggerBaseProps, MenuTriggerProps, MenuTriggerState } from './MenuTrigger.types';
import { useMenuContext_unstable } from '../../contexts/menuContext';
import { useMenuListContext_unstable } from '../../contexts/menuListContext';
import { useIsSubmenu, useOnMenuSafeZoneTimeout } from '../../utils';
Expand Down Expand Up @@ -44,24 +44,12 @@ export const useMenuTrigger_unstable = (props: MenuTriggerProps): MenuTriggerSta
firstFocusable?.focus();
}, [findFirstFocusable, menuPopoverRef]);

return useMenuTriggerBase_unstable(props, { focusFirst });
return useMenuTriggerBase_unstable({ ...props, focusFirst });
};

/**
* Options accepted by `useMenuTriggerBase_unstable`.
*/
export type UseMenuTriggerBaseOptions = {
/**
* Pluggable "focus the first focusable element in the menu popover" callback,
* invoked when an already-open submenu trigger receives the open arrow key.
*
* Not provided by the base hook itself - the base hook is intentionally headless
* and leaves focus discovery to the caller. `useMenuTrigger_unstable` plugs in a
* Tabster-aware implementation; a headless consumer is expected to supply its own.
* If omitted, the keyboard handler is a no-op for that case.
*/
focusFirst?: () => void;
};

/**
* Base hook for MenuTrigger component, produces state required to render the component.
Expand All @@ -75,11 +63,8 @@ export type UseMenuTriggerBaseOptions = {
*
* @public
*/
export const useMenuTriggerBase_unstable = (
props: MenuTriggerProps,
options?: UseMenuTriggerBaseOptions,
): MenuTriggerState => {
const { children, disableButtonEnhancement = false } = props;
export const useMenuTriggerBase_unstable = (props: MenuTriggerBaseProps): MenuTriggerState => {
const { children, disableButtonEnhancement = false, focusFirst } = props;

const triggerRef = useMenuContext_unstable(context => context.triggerRef);
const setOpen = useMenuContext_unstable(context => context.setOpen);
Expand All @@ -91,8 +76,6 @@ export const useMenuTriggerBase_unstable = (
const isSubmenu = useIsSubmenu();
const shouldOpenOnArrowRight = useMenuListContext_unstable(ctx => ctx.shouldOpenOnArrowRight ?? true);

const focusFirst = options?.focusFirst;

const openedWithKeyboardRef = React.useRef(false);
const openedViaSafeZoneRef = React.useRef(false);
const hasMouseMovedRef = React.useRef(false);
Expand Down
7 changes: 1 addition & 6 deletions packages/react-components/react-menu/library/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -126,12 +126,7 @@ export {
useMenuTrigger_unstable,
useMenuTriggerBase_unstable,
} from './MenuTrigger';
export type {
MenuTriggerChildProps,
MenuTriggerProps,
MenuTriggerState,
UseMenuTriggerBaseOptions,
} from './MenuTrigger';
export type { MenuTriggerChildProps, MenuTriggerProps, MenuTriggerState, MenuTriggerBaseProps } from './MenuTrigger';

export { useCheckmarkStyles_unstable } from './selectable/index';
export type { MenuItemSelectableProps, MenuItemSelectableState, SelectableHandler } from './selectable/index';
Expand Down
Loading