ant-design/components/menu/index.tsx

285 lines
8.3 KiB
TypeScript
Raw Normal View History

import * as React from 'react';
import RcMenu, { Divider, ItemGroup } from 'rc-menu';
2018-08-07 21:07:52 +08:00
import * as PropTypes from 'prop-types';
2017-06-30 18:08:30 +08:00
import classNames from 'classnames';
import SubMenu from './SubMenu';
2017-06-30 21:07:01 +08:00
import Item from './MenuItem';
import { ConfigConsumer, ConfigConsumerProps } from '../config-provider';
import animation from '../_util/openAnimation';
import warning from '../_util/warning';
2018-04-01 01:15:42 +08:00
import { SiderContext } from '../layout/Sider';
2015-08-06 16:49:54 +08:00
2016-09-13 15:31:29 +08:00
export interface SelectParam {
key: string;
keyPath: Array<string>;
item: any;
domEvent: any;
selectedKeys: Array<string>;
}
2016-09-13 15:31:29 +08:00
export interface ClickParam {
key: string;
keyPath: Array<string>;
item: any;
domEvent: any;
}
export type MenuMode = 'vertical' | 'vertical-left' | 'vertical-right' | 'horizontal' | 'inline';
export type MenuTheme = 'light' | 'dark';
export interface MenuProps {
id?: string;
theme?: MenuTheme;
mode?: MenuMode;
selectable?: boolean;
selectedKeys?: Array<string>;
defaultSelectedKeys?: Array<string>;
openKeys?: Array<string>;
defaultOpenKeys?: Array<string>;
onOpenChange?: (openKeys: string[]) => void;
onSelect?: (param: SelectParam) => void;
onDeselect?: (param: SelectParam) => void;
onClick?: (param: ClickParam) => void;
style?: React.CSSProperties;
openAnimation?: string | Object;
openTransitionName?: string | Object;
className?: string;
prefixCls?: string;
multiple?: boolean;
inlineIndent?: number;
2017-06-30 18:08:30 +08:00
inlineCollapsed?: boolean;
subMenuCloseDelay?: number;
subMenuOpenDelay?: number;
2018-06-06 21:05:32 +08:00
focusable?: boolean;
onMouseEnter?: (e: MouseEvent) => void;
getPopupContainer?: (triggerNode?: HTMLElement) => HTMLElement;
}
export interface MenuState {
openKeys: string[];
}
export default class Menu extends React.Component<MenuProps, MenuState> {
static Divider = Divider;
static Item = Item;
static SubMenu = SubMenu;
static ItemGroup = ItemGroup;
2018-06-06 21:05:32 +08:00
static defaultProps: Partial<MenuProps> = {
className: '',
2018-06-06 21:05:32 +08:00
theme: 'light', // or dark
2018-05-01 18:50:22 +08:00
focusable: false,
2016-07-13 11:14:24 +08:00
};
2017-06-30 21:07:01 +08:00
static childContextTypes = {
inlineCollapsed: PropTypes.bool,
antdMenuTheme: PropTypes.string,
2017-06-30 21:07:01 +08:00
};
static contextTypes = {
siderCollapsed: PropTypes.bool,
collapsedWidth: PropTypes.oneOfType([PropTypes.number, PropTypes.string]),
};
2018-12-13 02:07:58 +08:00
2018-11-09 17:38:19 +08:00
context: any;
switchingModeFromInline: boolean;
inlineOpenKeys: string[] = [];
2018-12-13 02:07:58 +08:00
constructor(props: MenuProps) {
super(props);
warning(
!('onOpen' in props || 'onClose' in props),
'`onOpen` and `onClose` are removed, please use `onOpenChange` instead, ' +
2018-12-07 20:02:01 +08:00
'see: https://u.ant.design/menu-on-open-change.',
);
warning(
!('inlineCollapsed' in props && props.mode !== 'inline'),
2018-12-07 20:02:01 +08:00
"`inlineCollapsed` should only be used when Menu's `mode` is inline.",
);
let openKeys;
if ('openKeys' in props) {
openKeys = props.openKeys;
} else if ('defaultOpenKeys' in props) {
openKeys = props.defaultOpenKeys;
}
this.state = {
openKeys: openKeys || [],
2015-08-06 16:49:54 +08:00
};
}
2018-12-13 02:07:58 +08:00
2017-06-30 21:07:01 +08:00
getChildContext() {
return {
inlineCollapsed: this.getInlineCollapsed(),
antdMenuTheme: this.props.theme,
2017-06-30 21:07:01 +08:00
};
}
2018-12-13 02:07:58 +08:00
2018-04-01 01:15:42 +08:00
componentWillReceiveProps(nextProps: MenuProps, nextContext: SiderContext) {
2018-12-07 20:02:01 +08:00
if (this.props.mode === 'inline' && nextProps.mode !== 'inline') {
this.switchingModeFromInline = true;
}
2018-12-13 02:07:58 +08:00
if ('openKeys' in nextProps) {
this.setState({ openKeys: nextProps.openKeys! });
return;
}
2018-12-07 20:02:01 +08:00
if (
(nextProps.inlineCollapsed && !this.props.inlineCollapsed) ||
(nextContext.siderCollapsed && !this.context.siderCollapsed)
) {
this.switchingModeFromInline = true;
2017-06-30 18:08:30 +08:00
this.inlineOpenKeys = this.state.openKeys;
this.setState({ openKeys: [] });
2017-06-30 18:08:30 +08:00
}
2018-12-07 20:02:01 +08:00
if (
(!nextProps.inlineCollapsed && this.props.inlineCollapsed) ||
(!nextContext.siderCollapsed && this.context.siderCollapsed)
) {
this.setState({ openKeys: this.inlineOpenKeys });
2017-06-30 18:08:30 +08:00
this.inlineOpenKeys = [];
}
2016-04-27 17:44:25 +08:00
}
2018-12-13 02:07:58 +08:00
restoreModeVerticalFromInline() {
if (this.switchingModeFromInline) {
this.switchingModeFromInline = false;
this.setState({});
}
}
2018-12-13 02:07:58 +08:00
// Restore vertical mode when menu is collapsed responsively when mounted
// https://github.com/ant-design/ant-design/issues/13104
// TODO: not a perfect solution, looking a new way to avoid setting switchingModeFromInline in this situation
handleMouseEnter = (e: MouseEvent) => {
this.restoreModeVerticalFromInline();
const { onMouseEnter } = this.props;
if (onMouseEnter) {
onMouseEnter(e);
}
2018-12-07 20:02:01 +08:00
};
handleTransitionEnd = (e: TransitionEvent) => {
// when inlineCollapsed menu width animation finished
// https://github.com/ant-design/ant-design/issues/12864
const widthCollapsed = e.propertyName === 'width' && e.target === e.currentTarget;
// Fix for <Menu style={{ width: '100%' }} />, the width transition won't trigger when menu is collapsed
// https://github.com/ant-design/ant-design-pro/issues/2783
2018-12-07 20:02:01 +08:00
const iconScaled =
e.propertyName === 'font-size' && (e.target as HTMLElement).className.indexOf('anticon') >= 0;
if (widthCollapsed || iconScaled) {
this.restoreModeVerticalFromInline();
}
2018-12-07 20:02:01 +08:00
};
handleClick = (e: ClickParam) => {
this.handleOpenChange([]);
2016-10-24 12:04:26 +08:00
const { onClick } = this.props;
2016-10-24 12:04:26 +08:00
if (onClick) {
onClick(e);
}
2018-12-07 20:02:01 +08:00
};
handleOpenChange = (openKeys: string[]) => {
2016-05-07 16:06:02 +08:00
this.setOpenKeys(openKeys);
2016-10-24 12:04:26 +08:00
const { onOpenChange } = this.props;
2016-10-24 12:04:26 +08:00
if (onOpenChange) {
onOpenChange(openKeys);
}
2018-12-07 20:02:01 +08:00
};
setOpenKeys(openKeys: string[]) {
2016-05-06 18:07:23 +08:00
if (!('openKeys' in this.props)) {
this.setState({ openKeys });
}
}
2018-12-13 02:07:58 +08:00
2017-06-30 18:08:30 +08:00
getRealMenuMode() {
const inlineCollapsed = this.getInlineCollapsed();
if (this.switchingModeFromInline && inlineCollapsed) {
return 'inline';
}
const { mode } = this.props;
return inlineCollapsed ? 'vertical' : mode;
}
2018-12-13 02:07:58 +08:00
getInlineCollapsed() {
const { inlineCollapsed } = this.props;
2017-06-30 23:08:11 +08:00
if (this.context.siderCollapsed !== undefined) {
return this.context.siderCollapsed;
}
return inlineCollapsed;
2017-06-30 18:08:30 +08:00
}
2018-12-13 02:07:58 +08:00
getMenuOpenAnimation(menuMode: MenuMode) {
2017-06-30 18:08:30 +08:00
const { openAnimation, openTransitionName } = this.props;
let menuOpenAnimation = openAnimation || openTransitionName;
if (openAnimation === undefined && openTransitionName === undefined) {
2018-12-13 10:49:08 +08:00
if (menuMode === 'horizontal') {
menuOpenAnimation = 'slide-up';
} else if (menuMode === 'inline') {
menuOpenAnimation = animation;
} else {
// When mode switch from inline
// submenu should hide without animation
if (this.switchingModeFromInline) {
menuOpenAnimation = '';
this.switchingModeFromInline = false;
} else {
menuOpenAnimation = 'zoom-big';
}
}
2015-08-24 18:18:46 +08:00
}
2017-06-30 18:08:30 +08:00
return menuOpenAnimation;
}
renderMenu = ({ getPopupContainer, getPrefixCls }: ConfigConsumerProps) => {
const { prefixCls: customizePrefixCls, className, theme } = this.props;
2017-06-30 18:08:30 +08:00
const menuMode = this.getRealMenuMode();
const menuOpenAnimation = this.getMenuOpenAnimation(menuMode!);
2017-06-30 18:08:30 +08:00
const prefixCls = getPrefixCls('menu', customizePrefixCls);
2017-06-30 18:08:30 +08:00
const menuClassName = classNames(className, `${prefixCls}-${theme}`, {
[`${prefixCls}-inline-collapsed`]: this.getInlineCollapsed(),
2017-06-30 18:08:30 +08:00
});
2015-11-12 14:57:54 +08:00
2017-06-30 18:08:30 +08:00
const menuProps: MenuProps = {
openKeys: this.state.openKeys,
onOpenChange: this.handleOpenChange,
className: menuClassName,
mode: menuMode,
};
if (menuMode !== 'inline') {
// closing vertical popup submenu after click it
2017-06-30 18:08:30 +08:00
menuProps.onClick = this.handleClick;
menuProps.openTransitionName = menuOpenAnimation;
2015-08-24 18:18:46 +08:00
} else {
2017-06-30 18:08:30 +08:00
menuProps.openAnimation = menuOpenAnimation;
2015-08-24 18:18:46 +08:00
}
2017-06-30 18:08:30 +08:00
// https://github.com/ant-design/ant-design/issues/8587
const { collapsedWidth } = this.context;
if (
this.getInlineCollapsed() &&
(collapsedWidth === 0 || collapsedWidth === '0' || collapsedWidth === '0px')
) {
return null;
}
return (
<RcMenu
2018-11-26 12:06:42 +08:00
getPopupContainer={getPopupContainer}
{...this.props}
{...menuProps}
prefixCls={prefixCls}
onTransitionEnd={this.handleTransitionEnd}
onMouseEnter={this.handleMouseEnter}
/>
);
2018-12-07 20:02:01 +08:00
};
2018-11-26 12:06:42 +08:00
render() {
2018-12-07 20:02:01 +08:00
return <ConfigConsumer>{this.renderMenu}</ConfigConsumer>;
2018-11-26 12:06:42 +08:00
}
}