Skip to content

feat: menu ref support focus #442

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 27, 2022
Merged

feat: menu ref support focus #442

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 11 additions & 4 deletions src/Menu.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import type {
SelectInfo,
RenderIconType,
ItemType,
MenuRef,
} from './interface';
import MenuItem from './MenuItem';
import { parseItems } from './utils/nodeUtil';
Expand All @@ -28,7 +29,7 @@ import { PathRegisterContext, PathUserContext } from './context/PathContext';
import useKeyRecords, { OVERFLOW_KEY } from './hooks/useKeyRecords';
import { IdContext } from './context/IdContext';
import PrivateContext from './context/PrivateContext';
import { composeRef } from 'rc-util/lib/ref';
import { useImperativeHandle } from 'react';

/**
* Menu modify after refactor:
Expand Down Expand Up @@ -149,7 +150,7 @@ interface LegacyMenuProps extends MenuProps {
openAnimation?: string;
}

const Menu = React.forwardRef<HTMLUListElement, MenuProps>((props, ref) => {
const Menu = React.forwardRef<MenuRef, MenuProps>((props, ref) => {
const {
prefixCls = 'rc-menu',
style,
Expand Down Expand Up @@ -232,7 +233,13 @@ const Menu = React.forwardRef<HTMLUListElement, MenuProps>((props, ref) => {
const [mounted, setMounted] = React.useState(false);

const containerRef = React.useRef<HTMLUListElement>();
const mergedRef = composeRef(containerRef, ref);

useImperativeHandle(ref, () => ({
list: containerRef.current,
focus: (options?: FocusOptions) => {
containerRef.current?.focus(options);
},
}));

const uuid = useUUID(id);

Expand Down Expand Up @@ -498,7 +505,7 @@ const Menu = React.forwardRef<HTMLUListElement, MenuProps>((props, ref) => {
const container = (
<Overflow
id={id}
ref={mergedRef as any}
ref={containerRef as any}
prefixCls={`${prefixCls}-overflow`}
component="ul"
itemComponent={MenuItem}
Expand Down
5 changes: 5 additions & 0 deletions src/interface.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,3 +116,8 @@ export type SelectEventHandler = (info: SelectInfo) => void;

// ========================== Click ==========================
export type MenuClickEventHandler = (info: MenuInfo) => void;

export type MenuRef = {
focus: (options?: FocusOptions) => void;
list: HTMLUListElement;
};
17 changes: 15 additions & 2 deletions tests/Menu.spec.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -650,14 +650,27 @@ describe('Menu', () => {

it('should support ref', () => {
const menuRef = React.createRef();
const wrapper = mount(
<Menu ref={menuRef}>
<MenuItem key="light">Light</MenuItem>
</Menu>,
);

mount(
expect(menuRef.current?.list).toBe(wrapper.find('ul').first().getDOMNode());
});

it('should support focus through ref', () => {
const menuRef = React.createRef();
const wrapper = mount(
<Menu ref={menuRef}>
<MenuItem key="light">Light</MenuItem>
</Menu>,
);
menuRef.current?.focus();

expect(menuRef.current).toBeTruthy();
expect(document.activeElement).toBe(
wrapper.find('ul').first().getDOMNode(),
);
});
});
/* eslint-enable */