mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-12-15 01:11:26 +08:00
33cb4c9bb4
* fix: Menu should onOpenChange when collapse inline menu close #23755 * fix snapshot
369 lines
10 KiB
TypeScript
369 lines
10 KiB
TypeScript
import * as React from 'react';
|
|
import RcMenu, { Divider, ItemGroup } from 'rc-menu';
|
|
import classNames from 'classnames';
|
|
import omit from 'omit.js';
|
|
import SubMenu from './SubMenu';
|
|
import Item from './MenuItem';
|
|
import { ConfigConsumer, ConfigConsumerProps } from '../config-provider';
|
|
import warning from '../_util/warning';
|
|
import { SiderContext, SiderContextProps } from '../layout/Sider';
|
|
import raf from '../_util/raf';
|
|
import collapseMotion from '../_util/motion';
|
|
import MenuContext, { MenuTheme } from './MenuContext';
|
|
|
|
export { MenuItemGroupProps } from 'rc-menu/es/MenuItemGroup';
|
|
|
|
export interface SelectParam {
|
|
key: string;
|
|
keyPath: Array<string>;
|
|
item: any;
|
|
domEvent: Event;
|
|
selectedKeys: Array<string>;
|
|
}
|
|
|
|
export interface ClickParam {
|
|
key: string;
|
|
keyPath: Array<string>;
|
|
item: any;
|
|
domEvent: Event;
|
|
}
|
|
|
|
export type MenuMode = 'vertical' | 'vertical-left' | 'vertical-right' | 'horizontal' | 'inline';
|
|
|
|
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;
|
|
openTransitionName?: string;
|
|
motion?: 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;
|
|
forceSubMenuRender?: boolean;
|
|
}
|
|
|
|
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;
|
|
}
|
|
|
|
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(
|
|
!('inlineCollapsed' in props && props.mode !== 'inline'),
|
|
'Menu',
|
|
'`inlineCollapsed` should only be used when `mode` is inline.',
|
|
);
|
|
|
|
warning(
|
|
!(props.siderCollapsed !== undefined && 'inlineCollapsed' in props),
|
|
'Menu',
|
|
'`inlineCollapsed` not control Menu under Sider. Should set `collapsed` on Sider instead.',
|
|
);
|
|
|
|
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,
|
|
};
|
|
}
|
|
|
|
componentWillUnmount() {
|
|
raf.cancel(this.mountRafId);
|
|
}
|
|
|
|
componentDidUpdate(prevProps: InternalMenuProps) {
|
|
const { siderCollapsed, inlineCollapsed, onOpenChange } = this.props;
|
|
if (
|
|
(!prevProps.inlineCollapsed && inlineCollapsed) ||
|
|
(!prevProps.siderCollapsed && siderCollapsed)
|
|
) {
|
|
onOpenChange?.([]);
|
|
}
|
|
}
|
|
|
|
setOpenKeys(openKeys: string[]) {
|
|
if (!('openKeys' in this.props)) {
|
|
this.setState({ openKeys });
|
|
}
|
|
}
|
|
|
|
getRealMenuMode() {
|
|
const { mode } = this.props;
|
|
const { switchingModeFromInline } = this.state;
|
|
const inlineCollapsed = this.getInlineCollapsed();
|
|
if (switchingModeFromInline && inlineCollapsed) {
|
|
return 'inline';
|
|
}
|
|
return inlineCollapsed ? 'vertical' : mode;
|
|
}
|
|
|
|
getInlineCollapsed() {
|
|
const { inlineCollapsed, siderCollapsed } = this.props;
|
|
if (siderCollapsed !== undefined) {
|
|
return siderCollapsed;
|
|
}
|
|
return inlineCollapsed;
|
|
}
|
|
|
|
getOpenMotionProps(
|
|
menuMode: MenuMode,
|
|
): { openTransitionName?: any; openAnimation?: any; motion?: Object } {
|
|
const { openTransitionName, openAnimation, motion } = this.props;
|
|
const { switchingModeFromInline } = this.state;
|
|
|
|
// Provides by user
|
|
if (motion) {
|
|
return { motion };
|
|
}
|
|
|
|
if (openAnimation) {
|
|
warning(
|
|
typeof openAnimation === 'string',
|
|
'Menu',
|
|
'`openAnimation` do not support object. Please use `motion` instead.',
|
|
);
|
|
return { openAnimation };
|
|
}
|
|
|
|
if (openTransitionName) {
|
|
return { openTransitionName };
|
|
}
|
|
|
|
// Default logic
|
|
if (menuMode === 'horizontal') {
|
|
return { motion: { motionName: 'slide-up' } };
|
|
}
|
|
|
|
if (menuMode === 'inline') {
|
|
return { motion: collapseMotion };
|
|
}
|
|
|
|
// When mode switch from inline
|
|
// submenu should hide without animation
|
|
return {
|
|
motion: {
|
|
motionName: switchingModeFromInline ? '' : 'zoom-big',
|
|
},
|
|
};
|
|
}
|
|
|
|
// 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);
|
|
}
|
|
};
|
|
|
|
restoreModeVerticalFromInline() {
|
|
const { switchingModeFromInline } = this.state;
|
|
if (switchingModeFromInline) {
|
|
this.setState({
|
|
switchingModeFromInline: false,
|
|
});
|
|
}
|
|
}
|
|
|
|
renderMenu = ({ getPopupContainer, getPrefixCls, direction }: ConfigConsumerProps) => {
|
|
const { prefixCls: customizePrefixCls, className, theme, collapsedWidth } = this.props;
|
|
const { openKeys } = this.state;
|
|
const passProps = omit(this.props, ['collapsedWidth', 'siderCollapsed']);
|
|
const menuMode = this.getRealMenuMode();
|
|
const menuOpenMotion = this.getOpenMotionProps(menuMode!);
|
|
|
|
const prefixCls = getPrefixCls('menu', customizePrefixCls);
|
|
const menuClassName = classNames(className, `${prefixCls}-${theme}`, {
|
|
[`${prefixCls}-inline-collapsed`]: this.getInlineCollapsed(),
|
|
});
|
|
|
|
const menuProps: MenuProps = {
|
|
openKeys,
|
|
onOpenChange: this.handleOpenChange,
|
|
className: menuClassName,
|
|
mode: menuMode,
|
|
|
|
// Motion
|
|
...menuOpenMotion,
|
|
};
|
|
|
|
if (menuMode !== 'inline') {
|
|
// closing vertical popup submenu after click it
|
|
menuProps.onClick = this.handleClick;
|
|
}
|
|
|
|
// https://github.com/ant-design/ant-design/issues/8587
|
|
const hideMenu =
|
|
this.getInlineCollapsed() &&
|
|
(collapsedWidth === 0 || collapsedWidth === '0' || collapsedWidth === '0px');
|
|
if (hideMenu) {
|
|
menuProps.openKeys = [];
|
|
}
|
|
|
|
return (
|
|
<MenuContext.Provider
|
|
value={{
|
|
inlineCollapsed: this.getInlineCollapsed() || false,
|
|
antdMenuTheme: theme,
|
|
direction,
|
|
}}
|
|
>
|
|
<RcMenu
|
|
getPopupContainer={getPopupContainer}
|
|
{...passProps}
|
|
{...menuProps}
|
|
prefixCls={prefixCls}
|
|
onTransitionEnd={this.handleTransitionEnd}
|
|
onMouseEnter={this.handleMouseEnter}
|
|
direction={direction}
|
|
/>
|
|
</MenuContext.Provider>
|
|
);
|
|
};
|
|
|
|
render() {
|
|
return <ConfigConsumer>{this.renderMenu}</ConfigConsumer>;
|
|
}
|
|
}
|
|
|
|
// 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>
|
|
);
|
|
}
|
|
}
|