MenuItem.js 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214
  1. import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
  2. import _objectSpread from "@babel/runtime/helpers/esm/objectSpread2";
  3. import _toConsumableArray from "@babel/runtime/helpers/esm/toConsumableArray";
  4. import _extends from "@babel/runtime/helpers/esm/extends";
  5. import _objectWithoutProperties from "@babel/runtime/helpers/esm/objectWithoutProperties";
  6. import _classCallCheck from "@babel/runtime/helpers/esm/classCallCheck";
  7. import _createClass from "@babel/runtime/helpers/esm/createClass";
  8. import _inherits from "@babel/runtime/helpers/esm/inherits";
  9. import _createSuper from "@babel/runtime/helpers/esm/createSuper";
  10. var _excluded = ["title", "attribute", "elementRef"],
  11. _excluded2 = ["style", "className", "eventKey", "warnKey", "disabled", "itemIcon", "children", "role", "onMouseEnter", "onMouseLeave", "onClick", "onKeyDown", "onFocus"],
  12. _excluded3 = ["active"];
  13. import classNames from 'classnames';
  14. import Overflow from 'rc-overflow';
  15. import KeyCode from "rc-util/es/KeyCode";
  16. import omit from "rc-util/es/omit";
  17. import { useComposeRef } from "rc-util/es/ref";
  18. import warning from "rc-util/es/warning";
  19. import * as React from 'react';
  20. import { useMenuId } from "./context/IdContext";
  21. import { MenuContext } from "./context/MenuContext";
  22. import { useFullPath, useMeasure } from "./context/PathContext";
  23. import PrivateContext from "./context/PrivateContext";
  24. import useActive from "./hooks/useActive";
  25. import useDirectionStyle from "./hooks/useDirectionStyle";
  26. import Icon from "./Icon";
  27. import { warnItemProp } from "./utils/warnUtil";
  28. // Since Menu event provide the `info.item` which point to the MenuItem node instance.
  29. // We have to use class component here.
  30. // This should be removed from doc & api in future.
  31. var LegacyMenuItem = /*#__PURE__*/function (_React$Component) {
  32. _inherits(LegacyMenuItem, _React$Component);
  33. var _super = _createSuper(LegacyMenuItem);
  34. function LegacyMenuItem() {
  35. _classCallCheck(this, LegacyMenuItem);
  36. return _super.apply(this, arguments);
  37. }
  38. _createClass(LegacyMenuItem, [{
  39. key: "render",
  40. value: function render() {
  41. var _this$props = this.props,
  42. title = _this$props.title,
  43. attribute = _this$props.attribute,
  44. elementRef = _this$props.elementRef,
  45. restProps = _objectWithoutProperties(_this$props, _excluded);
  46. // Here the props are eventually passed to the DOM element.
  47. // React does not recognize non-standard attributes.
  48. // Therefore, remove the props that is not used here.
  49. // ref: https://github.com/ant-design/ant-design/issues/41395
  50. var passedProps = omit(restProps, ['eventKey', 'popupClassName', 'popupOffset', 'onTitleClick']);
  51. warning(!attribute, '`attribute` of Menu.Item is deprecated. Please pass attribute directly.');
  52. return /*#__PURE__*/React.createElement(Overflow.Item, _extends({}, attribute, {
  53. title: typeof title === 'string' ? title : undefined
  54. }, passedProps, {
  55. ref: elementRef
  56. }));
  57. }
  58. }]);
  59. return LegacyMenuItem;
  60. }(React.Component);
  61. /**
  62. * Real Menu Item component
  63. */
  64. var InternalMenuItem = /*#__PURE__*/React.forwardRef(function (props, ref) {
  65. var style = props.style,
  66. className = props.className,
  67. eventKey = props.eventKey,
  68. warnKey = props.warnKey,
  69. disabled = props.disabled,
  70. itemIcon = props.itemIcon,
  71. children = props.children,
  72. role = props.role,
  73. onMouseEnter = props.onMouseEnter,
  74. onMouseLeave = props.onMouseLeave,
  75. onClick = props.onClick,
  76. onKeyDown = props.onKeyDown,
  77. onFocus = props.onFocus,
  78. restProps = _objectWithoutProperties(props, _excluded2);
  79. var domDataId = useMenuId(eventKey);
  80. var _React$useContext = React.useContext(MenuContext),
  81. prefixCls = _React$useContext.prefixCls,
  82. onItemClick = _React$useContext.onItemClick,
  83. contextDisabled = _React$useContext.disabled,
  84. overflowDisabled = _React$useContext.overflowDisabled,
  85. contextItemIcon = _React$useContext.itemIcon,
  86. selectedKeys = _React$useContext.selectedKeys,
  87. onActive = _React$useContext.onActive;
  88. var _React$useContext2 = React.useContext(PrivateContext),
  89. _internalRenderMenuItem = _React$useContext2._internalRenderMenuItem;
  90. var itemCls = "".concat(prefixCls, "-item");
  91. var legacyMenuItemRef = React.useRef();
  92. var elementRef = React.useRef();
  93. var mergedDisabled = contextDisabled || disabled;
  94. var mergedEleRef = useComposeRef(ref, elementRef);
  95. var connectedKeys = useFullPath(eventKey);
  96. // ================================ Warn ================================
  97. if (process.env.NODE_ENV !== 'production' && warnKey) {
  98. warning(false, 'MenuItem should not leave undefined `key`.');
  99. }
  100. // ============================= Info =============================
  101. var getEventInfo = function getEventInfo(e) {
  102. return {
  103. key: eventKey,
  104. // Note: For legacy code is reversed which not like other antd component
  105. keyPath: _toConsumableArray(connectedKeys).reverse(),
  106. item: legacyMenuItemRef.current,
  107. domEvent: e
  108. };
  109. };
  110. // ============================= Icon =============================
  111. var mergedItemIcon = itemIcon || contextItemIcon;
  112. // ============================ Active ============================
  113. var _useActive = useActive(eventKey, mergedDisabled, onMouseEnter, onMouseLeave),
  114. active = _useActive.active,
  115. activeProps = _objectWithoutProperties(_useActive, _excluded3);
  116. // ============================ Select ============================
  117. var selected = selectedKeys.includes(eventKey);
  118. // ======================== DirectionStyle ========================
  119. var directionStyle = useDirectionStyle(connectedKeys.length);
  120. // ============================ Events ============================
  121. var onInternalClick = function onInternalClick(e) {
  122. if (mergedDisabled) {
  123. return;
  124. }
  125. var info = getEventInfo(e);
  126. onClick === null || onClick === void 0 || onClick(warnItemProp(info));
  127. onItemClick(info);
  128. };
  129. var onInternalKeyDown = function onInternalKeyDown(e) {
  130. onKeyDown === null || onKeyDown === void 0 || onKeyDown(e);
  131. if (e.which === KeyCode.ENTER) {
  132. var info = getEventInfo(e);
  133. // Legacy. Key will also trigger click event
  134. onClick === null || onClick === void 0 || onClick(warnItemProp(info));
  135. onItemClick(info);
  136. }
  137. };
  138. /**
  139. * Used for accessibility. Helper will focus element without key board.
  140. * We should manually trigger an active
  141. */
  142. var onInternalFocus = function onInternalFocus(e) {
  143. onActive(eventKey);
  144. onFocus === null || onFocus === void 0 || onFocus(e);
  145. };
  146. // ============================ Render ============================
  147. var optionRoleProps = {};
  148. if (props.role === 'option') {
  149. optionRoleProps['aria-selected'] = selected;
  150. }
  151. var renderNode = /*#__PURE__*/React.createElement(LegacyMenuItem, _extends({
  152. ref: legacyMenuItemRef,
  153. elementRef: mergedEleRef,
  154. role: role === null ? 'none' : role || 'menuitem',
  155. tabIndex: disabled ? null : -1,
  156. "data-menu-id": overflowDisabled && domDataId ? null : domDataId
  157. }, omit(restProps, ['extra']), activeProps, optionRoleProps, {
  158. component: "li",
  159. "aria-disabled": disabled,
  160. style: _objectSpread(_objectSpread({}, directionStyle), style),
  161. className: classNames(itemCls, _defineProperty(_defineProperty(_defineProperty({}, "".concat(itemCls, "-active"), active), "".concat(itemCls, "-selected"), selected), "".concat(itemCls, "-disabled"), mergedDisabled), className),
  162. onClick: onInternalClick,
  163. onKeyDown: onInternalKeyDown,
  164. onFocus: onInternalFocus
  165. }), children, /*#__PURE__*/React.createElement(Icon, {
  166. props: _objectSpread(_objectSpread({}, props), {}, {
  167. isSelected: selected
  168. }),
  169. icon: mergedItemIcon
  170. }));
  171. if (_internalRenderMenuItem) {
  172. renderNode = _internalRenderMenuItem(renderNode, props, {
  173. selected: selected
  174. });
  175. }
  176. return renderNode;
  177. });
  178. function MenuItem(props, ref) {
  179. var eventKey = props.eventKey;
  180. // ==================== Record KeyPath ====================
  181. var measure = useMeasure();
  182. var connectedKeyPath = useFullPath(eventKey);
  183. // eslint-disable-next-line consistent-return
  184. React.useEffect(function () {
  185. if (measure) {
  186. measure.registerPath(eventKey, connectedKeyPath);
  187. return function () {
  188. measure.unregisterPath(eventKey, connectedKeyPath);
  189. };
  190. }
  191. }, [connectedKeyPath]);
  192. if (measure) {
  193. return null;
  194. }
  195. // ======================== Render ========================
  196. return /*#__PURE__*/React.createElement(InternalMenuItem, _extends({}, props, {
  197. ref: ref
  198. }));
  199. }
  200. export default /*#__PURE__*/React.forwardRef(MenuItem);