Skip to content
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.

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

WIP: Accessibility improvements #373

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
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
3 changes: 3 additions & 0 deletions docs/demo/modes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
## modes

<code src="../examples/modes.tsx">
49 changes: 49 additions & 0 deletions docs/examples/modes.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
/* eslint no-console:0 */

import React from 'react';
import Menu, { SubMenu, Item as MenuItem } from 'rc-menu';
import { MenuMode } from '@/interface';
import '../../assets/index.less';

export default () => {

const [mode, setMode] = React.useState<MenuMode>("horizontal")

const [width, setWidth] = React.useState(400)

function handleSelect(info) {
console.log('selected ', info);
}

function handleClick(info) {
console.log('click ', info);
}

return (
<div>
<select value={mode} onChange={(e) => setMode(e.target.value as MenuMode)}>
<option>horizontal</option>
<option>inline</option>
<option>vertical</option>
<option>vertical-left</option>
<option>vertical-right</option>
</select>

<input value={width} onChange={e => setWidth(Number(e.target.value))} />

<div style={{ width }}>
<Menu onSelect={handleSelect} defaultActiveFirst onClick={handleClick} mode={mode}>
<MenuItem key="1">item 1</MenuItem>
<MenuItem disabled>disabled</MenuItem>
<MenuItem key="3">item 3</MenuItem>
<MenuItem key="4">item 4</MenuItem>
<SubMenu title="item 5" key="5">
<MenuItem key="5-1">item 5-1</MenuItem>
<MenuItem key="5-2">item 5-2</MenuItem>
</SubMenu>
<MenuItem key="6">item 6</MenuItem>
</Menu>
</div>
</div>
);
};
20 changes: 20 additions & 0 deletions src/Menu.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ class Menu extends React.Component<MenuProps, MenuState> {
selectedKeys,
openKeys,
activeKey: { '0-menu-': getActiveKey(props, props.activeKey) },
focused: false
});

this.state = {
Expand All @@ -123,6 +124,8 @@ class Menu extends React.Component<MenuProps, MenuState> {

isRootMenu: boolean;

blurTimeout: number;

store: MiniStore;

innerMenu: typeof SubPopupMenu;
Expand Down Expand Up @@ -344,6 +347,21 @@ class Menu extends React.Component<MenuProps, MenuState> {
}
};

onFocus =() => {
clearTimeout(this.blurTimeout)
this.store.setState({
focused: true
});
}

onBlur =() => {
this.blurTimeout = setTimeout(() => {
this.store.setState({
focused: false
});
})
}

onTransitionEnd = (e: React.TransitionEvent<HTMLDivElement>) => {
// when inlineCollapsed menu width animation finished
// https://github.com/ant-design/ant-design/issues/12864
Expand Down Expand Up @@ -418,6 +436,8 @@ class Menu extends React.Component<MenuProps, MenuState> {
onSelect: this.onSelect,
onMouseEnter: this.onMouseEnter,
onTransitionEnd: this.onTransitionEnd,
onFocus: this.onFocus,
onBlur: this.onBlur,
parentMenu: this,
motion: getMotion(this.props, this.state, mode),
};
Expand Down
16 changes: 15 additions & 1 deletion src/MenuItem.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,22 @@ export class MenuItem extends React.Component<MenuItemProps> {
componentDidMount() {
// invoke customized ref to expose component to mixin
this.callRef();
if (this.props.active && this.props.focused) {
setTimeout(() => {
this.node.focus()
console.log("focus menuitem mount");
});
}
}

componentDidUpdate() {
this.callRef();
if (this.props.active && this.props.focused) {
setTimeout(() => {
this.node.focus()
console.log("focus menuitem");
});
}
}

componentWillUnmount() {
Expand Down Expand Up @@ -240,6 +252,7 @@ export class MenuItem extends React.Component<MenuItemProps> {
{...mouseEvent}
style={style}
ref={this.saveNode}
tabIndex={this.props.active ? 0 : -1}
>
{props.children}
{icon}
Expand All @@ -249,9 +262,10 @@ export class MenuItem extends React.Component<MenuItemProps> {
}

const connected = connect<any, any, any>(
({ activeKey, selectedKeys }, { eventKey, subMenuKey }) => ({
({ activeKey, selectedKeys, focused }, { eventKey, subMenuKey }) => ({
active: activeKey[subMenuKey] === eventKey,
isSelected: selectedKeys.indexOf(eventKey) !== -1,
focused
}),
)(MenuItem);

Expand Down
15 changes: 11 additions & 4 deletions src/SubMenu.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,10 @@ export class SubMenu extends React.Component<SubMenuProps, SubMenuState> {
manualRef(this);
}

if (this.props.active && this.props.focused) {
this.node?.focus()
}

if (mode !== 'horizontal' || !parentMenu?.isRootMenu || !isOpen) {
return;
}
Expand Down Expand Up @@ -620,9 +624,6 @@ export class SubMenu extends React.Component<SubMenuProps, SubMenuState> {
role="button"
{...titleMouseEvents}
{...titleClickEvents}
aria-expanded={visible}
{...ariaOwns}
aria-haspopup="true"
title={typeof props.title === 'string' ? props.title : undefined}
>
{props.title}
Expand Down Expand Up @@ -668,8 +669,13 @@ export class SubMenu extends React.Component<SubMenuProps, SubMenuState> {
<li
{...(props as any)}
{...mouseEvents}
{...ariaOwns}
className={className}
role="menuitem"
tabIndex={this.props.active ? 0 : -1}
ref={elem => this.node = elem}
aria-expanded={visible}
aria-haspopup="true"
>
<Trigger
prefixCls={prefixCls}
Expand All @@ -696,10 +702,11 @@ export class SubMenu extends React.Component<SubMenuProps, SubMenuState> {
}

const connected = connect<any, any, any>(
({ openKeys, activeKey, selectedKeys }, { eventKey, subMenuKey }) => ({
({ openKeys, activeKey, selectedKeys, focused }, { eventKey, subMenuKey }) => ({
isOpen: openKeys.indexOf(eventKey) > -1,
active: activeKey[subMenuKey] === eventKey,
selectedKeys,
focused
}),
)(SubMenu as any);

Expand Down
3 changes: 1 addition & 2 deletions src/SubPopupMenu.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@ export class SubPopupMenu extends React.Component<SubPopupMenuProps> {

do {
const child = children[i];
if (!child || child.props.disabled) {
if (!child || child.props.disabled || child.props.style?.display === 'none') {
i = (i + 1) % len;
} else {
return child;
Expand Down Expand Up @@ -435,7 +435,6 @@ export class SubPopupMenu extends React.Component<SubPopupMenuProps> {
domProps.id = props.id;
}
if (props.focusable) {
domProps.tabIndex = 0;
domProps.onKeyDown = this.onKeyDown as any;
}
const {
Expand Down