mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-05 17:59:57 +08:00
362 lines
11 KiB
TypeScript
362 lines
11 KiB
TypeScript
import * as React from 'react';
|
|
import RcMenu, { Divider, ItemGroup } from 'rc-menu';
|
|
import createContext, { Context } from '@ant-design/create-react-context';
|
|
import classNames from 'classnames';
|
|
import omit from 'omit.js';
|
|
import SubMenu from './SubMenu';
|
|
import Item from './MenuItem';
|
|
import { ConfigConsumer, ConfigConsumerProps } from '../config-provider';
|
|
import animation from '../_util/openAnimation';
|
|
import warning from '../_util/warning';
|
|
import { polyfill } from 'react-lifecycles-compat';
|
|
import { SiderContext, SiderContextProps } from '../layout/Sider';
|
|
import raf from '../_util/raf';
|
|
|
|
export interface SelectParam {
|
|
key: string;
|
|
keyPath: Array<string>;
|
|
item: any;
|
|
domEvent: any;
|
|
selectedKeys: Array<string>;
|
|
}
|
|
|
|
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;
|
|
inlineCollapsed?: boolean;
|
|
subMenuCloseDelay?: number;
|
|
subMenuOpenDelay?: number;
|
|
focusable?: boolean;
|
|
onMouseEnter?: (e: MouseEvent) => void;
|
|
getPopupContainer?: (triggerNode: HTMLElement) => HTMLElement;
|
|
overflowedIndicator?: React.ReactNode;
|
|
}
|
|
|
|
type InternalMenuProps = MenuProps & SiderContextProps;
|
|
|
|
export interface MenuState {
|
|
openKeys: string[];
|
|
|
|
// This may be not best way since origin code use `this.switchingModeFromInline` to handle collapse management.
|
|
// But for current test, seems it's OK just use state.
|
|
switchingModeFromInline: boolean;
|
|
inlineOpenKeys: string[];
|
|
prevProps: InternalMenuProps;
|
|
mounted: boolean;
|
|
}
|
|
|
|
export interface MenuContextProps {
|
|
inlineCollapsed: boolean;
|
|
antdMenuTheme?: MenuTheme;
|
|
}
|
|
|
|
export const MenuContext: Context<MenuContextProps> = createContext({
|
|
inlineCollapsed: false,
|
|
});
|
|
|
|
class InternalMenu extends React.Component<InternalMenuProps, MenuState> {
|
|
static defaultProps: Partial<MenuProps> = {
|
|
className: '',
|
|
theme: 'light', // or dark
|
|
focusable: false,
|
|
};
|
|
|
|
static getDerivedStateFromProps(nextProps: InternalMenuProps, prevState: MenuState) {
|
|
const { prevProps } = prevState;
|
|
const newState: Partial<MenuState> = {
|
|
prevProps: nextProps,
|
|
};
|
|
if (prevProps.mode === 'inline' && nextProps.mode !== 'inline') {
|
|
newState.switchingModeFromInline = true;
|
|
}
|
|
|
|
if ('openKeys' in nextProps) {
|
|
newState.openKeys = nextProps.openKeys;
|
|
} else {
|
|
// [Legacy] Old code will return after `openKeys` changed.
|
|
// Not sure the reason, we should keep this logic still.
|
|
if (
|
|
(nextProps.inlineCollapsed && !prevProps.inlineCollapsed) ||
|
|
(nextProps.siderCollapsed && !prevProps.siderCollapsed)
|
|
) {
|
|
newState.switchingModeFromInline = true;
|
|
newState.inlineOpenKeys = prevState.openKeys;
|
|
newState.openKeys = [];
|
|
}
|
|
|
|
if (
|
|
(!nextProps.inlineCollapsed && prevProps.inlineCollapsed) ||
|
|
(!nextProps.siderCollapsed && prevProps.siderCollapsed)
|
|
) {
|
|
newState.openKeys = prevState.inlineOpenKeys;
|
|
newState.inlineOpenKeys = [];
|
|
}
|
|
}
|
|
|
|
return newState;
|
|
}
|
|
|
|
private mountRafId: number;
|
|
|
|
constructor(props: InternalMenuProps) {
|
|
super(props);
|
|
|
|
warning(
|
|
!('onOpen' in props || 'onClose' in props),
|
|
'Menu',
|
|
'`onOpen` and `onClose` are removed, please use `onOpenChange` instead, ' +
|
|
'see: https://u.ant.design/menu-on-open-change.',
|
|
);
|
|
|
|
warning(
|
|
!('inlineCollapsed' in props && props.mode !== 'inline'),
|
|
'Menu',
|
|
'`inlineCollapsed` should only be used when `mode` is inline.',
|
|
);
|
|
|
|
let openKeys;
|
|
if ('openKeys' in props) {
|
|
openKeys = props.openKeys;
|
|
} else if ('defaultOpenKeys' in props) {
|
|
openKeys = props.defaultOpenKeys;
|
|
}
|
|
|
|
this.state = {
|
|
openKeys: openKeys || [],
|
|
switchingModeFromInline: false,
|
|
inlineOpenKeys: [],
|
|
prevProps: props,
|
|
mounted: false,
|
|
};
|
|
}
|
|
|
|
// [Legacy] Origin code can render full defaultOpenKeys is caused by `rc-animate` bug.
|
|
// We have to workaround this to prevent animation on first render.
|
|
// https://github.com/ant-design/ant-design/issues/15966
|
|
componentDidMount() {
|
|
this.mountRafId = raf(() => {
|
|
this.setState({
|
|
mounted: true,
|
|
});
|
|
}, 10);
|
|
}
|
|
|
|
componentWillUnmount() {
|
|
raf.cancel(this.mountRafId);
|
|
}
|
|
|
|
restoreModeVerticalFromInline() {
|
|
const { switchingModeFromInline } = this.state;
|
|
if (switchingModeFromInline) {
|
|
this.setState({
|
|
switchingModeFromInline: false,
|
|
});
|
|
}
|
|
}
|
|
|
|
// 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);
|
|
}
|
|
};
|
|
|
|
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 SVGElement e.target.className.indexOf is not a function
|
|
// https://github.com/ant-design/ant-design/issues/15699
|
|
const { className } = e.target as HTMLElement | SVGElement;
|
|
// SVGAnimatedString.animVal should be identical to SVGAnimatedString.baseVal, unless during an animation.
|
|
const classNameValue =
|
|
Object.prototype.toString.call(className) === '[object SVGAnimatedString]'
|
|
? className.animVal
|
|
: className;
|
|
|
|
// 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
|
|
const iconScaled = e.propertyName === 'font-size' && classNameValue.indexOf('anticon') >= 0;
|
|
if (widthCollapsed || iconScaled) {
|
|
this.restoreModeVerticalFromInline();
|
|
}
|
|
};
|
|
|
|
handleClick = (e: ClickParam) => {
|
|
this.handleOpenChange([]);
|
|
|
|
const { onClick } = this.props;
|
|
if (onClick) {
|
|
onClick(e);
|
|
}
|
|
};
|
|
|
|
handleOpenChange = (openKeys: string[]) => {
|
|
this.setOpenKeys(openKeys);
|
|
|
|
const { onOpenChange } = this.props;
|
|
if (onOpenChange) {
|
|
onOpenChange(openKeys);
|
|
}
|
|
};
|
|
|
|
setOpenKeys(openKeys: string[]) {
|
|
if (!('openKeys' in this.props)) {
|
|
this.setState({ openKeys });
|
|
}
|
|
}
|
|
|
|
getRealMenuMode() {
|
|
const inlineCollapsed = this.getInlineCollapsed();
|
|
if (this.state.switchingModeFromInline && inlineCollapsed) {
|
|
return 'inline';
|
|
}
|
|
const { mode } = this.props;
|
|
return inlineCollapsed ? 'vertical' : mode;
|
|
}
|
|
|
|
getInlineCollapsed() {
|
|
const { inlineCollapsed } = this.props;
|
|
if (this.props.siderCollapsed !== undefined) {
|
|
return this.props.siderCollapsed;
|
|
}
|
|
return inlineCollapsed;
|
|
}
|
|
|
|
getMenuOpenAnimation(menuMode: MenuMode) {
|
|
const { openAnimation, openTransitionName } = this.props;
|
|
let menuOpenAnimation = openAnimation || openTransitionName;
|
|
if (openAnimation === undefined && openTransitionName === undefined) {
|
|
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.state.switchingModeFromInline) {
|
|
menuOpenAnimation = '';
|
|
this.setState({
|
|
switchingModeFromInline: false,
|
|
});
|
|
// this.switchingModeFromInline = false;
|
|
} else {
|
|
menuOpenAnimation = 'zoom-big';
|
|
}
|
|
}
|
|
}
|
|
return menuOpenAnimation;
|
|
}
|
|
|
|
renderMenu = ({ getPopupContainer, getPrefixCls }: ConfigConsumerProps) => {
|
|
const { mounted } = this.state;
|
|
const { prefixCls: customizePrefixCls, className, theme, collapsedWidth } = this.props;
|
|
const passProps = omit(this.props, ['collapsedWidth', 'siderCollapsed']);
|
|
const menuMode = this.getRealMenuMode();
|
|
const menuOpenAnimation = this.getMenuOpenAnimation(menuMode!);
|
|
|
|
const prefixCls = getPrefixCls('menu', customizePrefixCls);
|
|
const menuClassName = classNames(className, `${prefixCls}-${theme}`, {
|
|
[`${prefixCls}-inline-collapsed`]: this.getInlineCollapsed(),
|
|
});
|
|
|
|
const menuProps: MenuProps = {
|
|
openKeys: this.state.openKeys,
|
|
onOpenChange: this.handleOpenChange,
|
|
className: menuClassName,
|
|
mode: menuMode,
|
|
};
|
|
|
|
if (menuMode !== 'inline') {
|
|
// closing vertical popup submenu after click it
|
|
menuProps.onClick = this.handleClick;
|
|
menuProps.openTransitionName = mounted ? menuOpenAnimation : '';
|
|
} else {
|
|
menuProps.openAnimation = mounted ? menuOpenAnimation : {};
|
|
}
|
|
|
|
// https://github.com/ant-design/ant-design/issues/8587
|
|
if (
|
|
this.getInlineCollapsed() &&
|
|
(collapsedWidth === 0 || collapsedWidth === '0' || collapsedWidth === '0px')
|
|
) {
|
|
return null;
|
|
}
|
|
|
|
return (
|
|
<RcMenu
|
|
getPopupContainer={getPopupContainer}
|
|
{...passProps}
|
|
{...menuProps}
|
|
prefixCls={prefixCls}
|
|
onTransitionEnd={this.handleTransitionEnd}
|
|
onMouseEnter={this.handleMouseEnter}
|
|
/>
|
|
);
|
|
};
|
|
|
|
render() {
|
|
return (
|
|
<MenuContext.Provider
|
|
value={{
|
|
inlineCollapsed: this.getInlineCollapsed() || false,
|
|
antdMenuTheme: this.props.theme,
|
|
}}
|
|
>
|
|
<ConfigConsumer>{this.renderMenu}</ConfigConsumer>
|
|
</MenuContext.Provider>
|
|
);
|
|
}
|
|
}
|
|
|
|
polyfill(InternalMenu);
|
|
|
|
// We should keep this as ref-able
|
|
export default class Menu extends React.Component<MenuProps, {}> {
|
|
static Divider = Divider;
|
|
static Item = Item;
|
|
static SubMenu = SubMenu;
|
|
static ItemGroup = ItemGroup;
|
|
|
|
render() {
|
|
return (
|
|
<SiderContext.Consumer>
|
|
{(context: SiderContextProps) => <InternalMenu {...this.props} {...context} />}
|
|
</SiderContext.Consumer>
|
|
);
|
|
}
|
|
}
|