rsuite 5.12.0 → 5.13.0

package/cjs/Sidenav/ExpandedSidenavDropdownItem.js

@@ -0,0 +1,141 @@
+"use strict";
+
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard");
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+exports.__esModule = true;
+exports.default = void 0;
+
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+
+var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutPropertiesLoose"));
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _isNil = _interopRequireDefault(require("lodash/isNil"));
+
+var _utils = require("../utils");
+
+var _Sidenav = require("./Sidenav");
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _Ripple = _interopRequireDefault(require("../Ripple"));
+
+var _SafeAnchor = _interopRequireDefault(require("../SafeAnchor"));
+
+var _NavContext = _interopRequireDefault(require("../Nav/NavContext"));
+
+var _useRenderDropdownItem = require("../Dropdown/useRenderDropdownItem");
+
+/**
+ * Tree View Node
+ * @see https://www.w3.org/TR/wai-aria-practices-1.2/#TreeView
+ */
+var ExpandedSidenavDropdownItem = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
+  var sidenav = (0, _react.useContext)(_Sidenav.SidenavContext);
+  var nav = (0, _react.useContext)(_NavContext.default);
+
+  if (!sidenav || !nav) {
+    throw new Error('<SidenavDropdownItem> component is not supposed to be used standalone. Use <Nav.Item> within <Sidenav> instead.');
+  }
+
+  var _props$as = props.as,
+      Component = _props$as === void 0 ? 'li' : _props$as,
+      activeProp = props.active,
+      children = props.children,
+      disabled = props.disabled,
+      divider = props.divider,
+      panel = props.panel,
+      className = props.className,
+      style = props.style,
+      _props$classPrefix = props.classPrefix,
+      classPrefix = _props$classPrefix === void 0 ? 'dropdown-item' : _props$classPrefix,
+      icon = props.icon,
+      eventKey = props.eventKey,
+      onClick = props.onClick,
+      onSelect = props.onSelect,
+      rest = (0, _objectWithoutPropertiesLoose2.default)(props, ["as", "active", "children", "disabled", "divider", "panel", "className", "style", "classPrefix", "icon", "eventKey", "onClick", "onSelect"]);
+
+  var _useClassNames = (0, _utils.useClassNames)(classPrefix),
+      merge = _useClassNames.merge,
+      withClassPrefix = _useClassNames.withClassPrefix,
+      prefix = _useClassNames.prefix;
+
+  var selected = activeProp !== null && activeProp !== void 0 ? activeProp : !(0, _isNil.default)(eventKey) && ((0, _utils.shallowEqual)(eventKey, sidenav.activeKey) || (0, _utils.shallowEqual)(nav.activeKey, eventKey));
+  var classes = merge(className, withClassPrefix({
+    'with-icon': icon,
+    active: selected,
+    disabled: disabled
+  }));
+  var handleClick = (0, _react.useCallback)(function (event) {
+    var _nav$onSelect, _sidenav$onSelect;
+
+    if (disabled) return;
+    onSelect === null || onSelect === void 0 ? void 0 : onSelect(eventKey, event);
+    (_nav$onSelect = nav.onSelect) === null || _nav$onSelect === void 0 ? void 0 : _nav$onSelect.call(nav, eventKey, event);
+    (_sidenav$onSelect = sidenav.onSelect) === null || _sidenav$onSelect === void 0 ? void 0 : _sidenav$onSelect.call(sidenav, eventKey, event);
+  }, [disabled, onSelect, sidenav, eventKey, nav]);
+  var menuitemEventHandlers = {
+    onClick: (0, _utils.createChainedFunction)(handleClick, onClick)
+  };
+  var renderDropdownItem = (0, _useRenderDropdownItem.useRenderDropdownItem)(Component);
+
+  if (divider) {
+    return renderDropdownItem((0, _extends2.default)({
+      ref: ref,
+      role: 'separator',
+      style: style,
+      className: merge(prefix('divider'), className)
+    }, rest));
+  }
+
+  if (panel) {
+    return renderDropdownItem((0, _extends2.default)({
+      ref: ref,
+      role: 'none presentation',
+      style: style,
+      className: merge(prefix('panel'), className)
+    }, rest, {
+      children: children
+    }));
+  }
+
+  return renderDropdownItem((0, _extends2.default)({
+    ref: ref
+  }, rest, {
+    style: style,
+    className: classes,
+    'aria-current': selected || undefined
+  }, menuitemEventHandlers, {
+    children: /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, icon && /*#__PURE__*/_react.default.cloneElement(icon, {
+      className: prefix('menu-icon')
+    }), children, /*#__PURE__*/_react.default.createElement(_Ripple.default, null))
+  }), _SafeAnchor.default);
+});
+
+ExpandedSidenavDropdownItem.displayName = 'Sidenav.Dropdown.Item';
+ExpandedSidenavDropdownItem.propTypes = {
+  as: _propTypes.default.elementType,
+  expanded: _propTypes.default.bool,
+  active: _propTypes.default.bool,
+  divider: _propTypes.default.bool,
+  panel: _propTypes.default.bool,
+  disabled: _propTypes.default.bool,
+  submenu: _propTypes.default.element,
+  onSelect: _propTypes.default.func,
+  onClick: _propTypes.default.func,
+  icon: _propTypes.default.node,
+  eventKey: _propTypes.default.any,
+  className: _propTypes.default.string,
+  style: _propTypes.default.object,
+  children: _propTypes.default.node,
+  classPrefix: _propTypes.default.string,
+  tabIndex: _propTypes.default.number,
+  title: _propTypes.default.node,
+  onMouseOver: _propTypes.default.func,
+  onMouseOut: _propTypes.default.func
+};
+var _default = ExpandedSidenavDropdownItem;
+exports.default = _default;

package/cjs/Sidenav/ExpandedSidenavDropdownMenu.d.ts

@@ -0,0 +1,26 @@
+import React from 'react';
+import { RsRefForwardingComponent, WithAsProps } from '../@types/common';
+import { IconProps } from '@rsuite/icons/lib/Icon';
+export interface SidenavDropdownMenuProps<T = any> extends WithAsProps, Omit<React.HTMLAttributes<HTMLLIElement>, 'title' | 'onSelect'> {
+    /** Primary content */
+    children?: React.ReactNode;
+    /** You can use a custom element for this component */
+    as?: React.ElementType;
+    /** Disable the current option */
+    disabled?: boolean;
+    /** The value of the current option */
+    eventKey?: T;
+    /** Set the icon */
+    icon?: React.ReactElement<IconProps>;
+    /** Whether the submenu is expanded, used in Sidenav. */
+    expanded?: boolean;
+    /** Select the callback function for the current option  */
+    onSelect?: (eventKey: T, event: React.SyntheticEvent) => void;
+    title?: React.ReactNode;
+}
+/**
+ * Tree View Node
+ * @see https://www.w3.org/TR/wai-aria-practices-1.2/#TreeView
+ */
+declare const ExpandedSidenavDropdownMenu: RsRefForwardingComponent<'li', SidenavDropdownMenuProps>;
+export default ExpandedSidenavDropdownMenu;

package/cjs/Sidenav/ExpandedSidenavDropdownMenu.js

@@ -0,0 +1,145 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard");
+
+exports.__esModule = true;
+exports.default = void 0;
+
+var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
+
+var _taggedTemplateLiteralLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteralLoose"));
+
+var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutPropertiesLoose"));
+
+var _react = _interopRequireWildcard(require("react"));
+
+var _isNil = _interopRequireDefault(require("lodash/isNil"));
+
+var _omit = _interopRequireDefault(require("lodash/omit"));
+
+var _utils = require("../utils");
+
+var _Sidenav = require("./Sidenav");
+
+var _useCustom2 = _interopRequireDefault(require("../utils/useCustom"));
+
+var _ArrowLeftLine = _interopRequireDefault(require("@rsuite/icons/ArrowLeftLine"));
+
+var _ArrowRightLine = _interopRequireDefault(require("@rsuite/icons/ArrowRightLine"));
+
+var _propTypes = _interopRequireDefault(require("prop-types"));
+
+var _SidenavDropdownCollapse = _interopRequireDefault(require("./SidenavDropdownCollapse"));
+
+var _Ripple = _interopRequireDefault(require("../Ripple"));
+
+var _Disclosure = _interopRequireDefault(require("../Disclosure/Disclosure"));
+
+var _templateObject, _templateObject2;
+
+/**
+ * Tree View Node
+ * @see https://www.w3.org/TR/wai-aria-practices-1.2/#TreeView
+ */
+var ExpandedSidenavDropdownMenu = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
+  var sidenavContext = (0, _react.useContext)(_Sidenav.SidenavContext);
+
+  if (!sidenavContext) {
+    throw new Error('<SidenavDropdownMenu> component is not supposed to be used standalone. Use <Nav.Menu> inside <Sidenav> instead.');
+  }
+
+  var _props$as = props.as,
+      Component = _props$as === void 0 ? 'li' : _props$as,
+      children = props.children,
+      disabled = props.disabled,
+      className = props.className,
+      style = props.style,
+      _props$classPrefix = props.classPrefix,
+      classPrefix = _props$classPrefix === void 0 ? 'dropdown-item' : _props$classPrefix,
+      tabIndex = props.tabIndex,
+      icon = props.icon,
+      title = props.title,
+      eventKey = props.eventKey,
+      onClick = props.onClick,
+      onSelect = props.onSelect,
+      rest = (0, _objectWithoutPropertiesLoose2.default)(props, ["as", "children", "disabled", "className", "style", "classPrefix", "tabIndex", "icon", "title", "eventKey", "onClick", "onSelect"]);
+
+  var _useCustom = (0, _useCustom2.default)('DropdownMenu'),
+      rtl = _useCustom.rtl;
+
+  var _useClassNames = (0, _utils.useClassNames)(classPrefix),
+      merge = _useClassNames.merge,
+      withClassPrefix = _useClassNames.withClassPrefix,
+      prefix = _useClassNames.prefix;
+
+  var _sidenavContext$openK = sidenavContext.openKeys,
+      openKeys = _sidenavContext$openK === void 0 ? [] : _sidenavContext$openK,
+      onOpenChange = sidenavContext.onOpenChange,
+      onSidenavSelect = sidenavContext.onSelect;
+  var handleClick = (0, _react.useCallback)(function (event) {
+    if (disabled) return;
+    onSelect === null || onSelect === void 0 ? void 0 : onSelect(eventKey, event);
+    onSidenavSelect === null || onSidenavSelect === void 0 ? void 0 : onSidenavSelect(eventKey, event);
+  }, [disabled, onSelect, onSidenavSelect, eventKey]);
+  var menuitemEventHandlers = {
+    onClick: (0, _utils.createChainedFunction)(handleClick, onClick)
+  };
+  var Icon = rtl ? _ArrowLeftLine.default : _ArrowRightLine.default;
+  return /*#__PURE__*/_react.default.createElement(_Disclosure.default, {
+    open: !(0, _isNil.default)(eventKey) && openKeys.includes(eventKey),
+    onToggle: function onToggle(_, event) {
+      return onOpenChange === null || onOpenChange === void 0 ? void 0 : onOpenChange(eventKey, event);
+    }
+  }, function (_ref) {
+    var open = _ref.open;
+    var classes = merge(className, prefix('submenu'), prefix("pull-" + (rtl ? 'left' : 'right')), prefix(open ? 'expand' : 'collapse'), withClassPrefix({
+      'with-icon': icon,
+      // open,
+      disabled: disabled
+    }));
+    return /*#__PURE__*/_react.default.createElement(Component, (0, _extends2.default)({
+      ref: ref
+    }, rest, {
+      tabIndex: disabled ? -1 : tabIndex,
+      style: style,
+      className: classes
+    }, menuitemEventHandlers), /*#__PURE__*/_react.default.createElement(_Disclosure.default.Button, null, function (buttonProps) {
+      return /*#__PURE__*/_react.default.createElement("button", (0, _extends2.default)({
+        className: prefix(_templateObject || (_templateObject = (0, _taggedTemplateLiteralLoose2.default)(["toggle"]))),
+        onClick: handleClick
+      }, (0, _omit.default)(buttonProps, ['open'])), icon && /*#__PURE__*/_react.default.cloneElement(icon, {
+        className: prefix('menu-icon')
+      }), title, /*#__PURE__*/_react.default.createElement(Icon, {
+        className: prefix(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteralLoose2.default)(["toggle-icon"])))
+      }), /*#__PURE__*/_react.default.createElement(_Ripple.default, null));
+    }), /*#__PURE__*/_react.default.createElement(_Disclosure.default.Content, null, function (_ref2) {
+      var open = _ref2.open;
+      return /*#__PURE__*/_react.default.createElement(_SidenavDropdownCollapse.default, {
+        open: open
+      }, children);
+    }));
+  });
+});
+
+ExpandedSidenavDropdownMenu.displayName = 'Sidenav.Dropdown.Menu';
+ExpandedSidenavDropdownMenu.propTypes = {
+  as: _propTypes.default.elementType,
+  expanded: _propTypes.default.bool,
+  disabled: _propTypes.default.bool,
+  onSelect: _propTypes.default.func,
+  onClick: _propTypes.default.func,
+  icon: _propTypes.default.node,
+  eventKey: _propTypes.default.any,
+  className: _propTypes.default.string,
+  style: _propTypes.default.object,
+  children: _propTypes.default.node,
+  classPrefix: _propTypes.default.string,
+  tabIndex: _propTypes.default.number,
+  title: _propTypes.default.node,
+  onMouseOver: _propTypes.default.func,
+  onMouseOut: _propTypes.default.func
+};
+var _default = ExpandedSidenavDropdownMenu;
+exports.default = _default;

package/cjs/Sidenav/Sidenav.d.ts

@@ -21,17 +21,23 @@ export interface SidenavProps<T = string> extends WithAsProps {
     onOpenChange?: (openKeys: T[], event: React.SyntheticEvent) => void;
     /**
      * Select the callback function for the menu
-     * @deprecated Use <Sidenav onSelect> instead
+     * @deprecated Use <Nav onSelect> instead
      */
     onSelect?: (eventKey: T | undefined, event: React.SyntheticEvent) => void;
 }
 export declare const SidenavContext: React.Context<SidenavContextType<string> | null>;
 export interface SidenavContextType<T = string> {
     openKeys: T[];
-    activeKey: T | null;
+    /**
+     * @deprecated Use activeKey from NavContext instead
+     */
+    activeKey: T | undefined;
     sidenav: boolean;
     expanded: boolean;
     onOpenChange: (eventKey: T, event: React.SyntheticEvent) => void;
+    /**
+     * @deprecated Use onSelect from NavContext instead
+     */
     onSelect?: (eventKey: T | undefined, event: React.SyntheticEvent) => void;
 }
 export interface SidenavComponent extends RsRefForwardingComponent<'div', SidenavProps> {

package/cjs/Sidenav/Sidenav.js

@@ -46,8 +46,7 @@ var Sidenav = /*#__PURE__*/_react.default.forwardRef(function (props, ref) {
       appearance = _props$appearance === void 0 ? 'default' : _props$appearance,
       _props$expanded = props.expanded,
       expanded = _props$expanded === void 0 ? true : _props$expanded,
-      _props$activeKey = props.activeKey,
-      activeKey = _props$activeKey === void 0 ? null : _props$activeKey,
+      activeKey = props.activeKey,
       _props$defaultOpenKey = props.defaultOpenKeys,
       defaultOpenKeys = _props$defaultOpenKey === void 0 ? emptyArray : _props$defaultOpenKey,
       openKeysProp = props.openKeys,

package/cjs/Sidenav/SidenavDropdown.d.ts

@@ -1,13 +1,17 @@
 import React from 'react';
 import { TypeAttributes, WithAsProps, RsRefForwardingComponent } from '../@types/common';
 import { IconProps } from '@rsuite/icons/lib/Icon';
-export interface SidenavDropdownProps<T = any> extends WithAsProps, Omit<React.HTMLAttributes<HTMLElement>, 'title'> {
+import Button from '../Button';
+import NavDropdownItem from '../Nav/NavDropdownItem';
+import NavDropdownMenu from '../Nav/NavDropdownMenu';
+export declare type SidenavDropdownTrigger = 'click' | 'hover' | 'contextMenu';
+export interface NavDropdownProps<T = any> extends WithAsProps, Omit<React.HTMLAttributes<HTMLElement>, 'onSelect' | 'title'> {
     /** Define the title as a submenu */
     title?: React.ReactNode;
     /** Set the icon */
     icon?: React.ReactElement<IconProps>;
-    /** The option to activate the state, corresponding to the eventkey in the Dropdown.item */
-    activeKey?: T;
+    /** Triggering events */
+    trigger?: SidenavDropdownTrigger | readonly SidenavDropdownTrigger[];
     /** The placement of Menu */
     placement?: TypeAttributes.Placement8;
     /** Whether or not component is disabled */
@@ -28,10 +32,9 @@ export interface SidenavDropdownProps<T = any> extends WithAsProps, Omit<React.H
      */
     open?: boolean;
     /**
-     * Custom title
-     * @deprecated Use `renderToggle` instead.
+     * @deprecated
      */
-    renderTitle?: (children?: React.ReactNode) => React.ReactNode;
+    renderTitle?: (children: React.ReactNode) => React.ReactNode;
     /** Custom Toggle */
     renderToggle?: (props: WithAsProps, ref: React.Ref<any>) => any;
     /** The callback function that the menu closes */
@@ -39,7 +42,26 @@ export interface SidenavDropdownProps<T = any> extends WithAsProps, Omit<React.H
     /** Menu Pop-up callback function */
     onOpen?: () => void;
     /** Callback function for menu state switching */
-    onToggle?: (open?: boolean) => void;
+    onToggle?: (open: boolean, eventKey?: T | undefined, event?: React.SyntheticEvent) => void;
+}
+export interface SidenavDropdownComponent extends RsRefForwardingComponent<'div', NavDropdownProps> {
+    <ToggleAs extends React.ElementType = typeof Button>(props: NavDropdownProps & {
+        ref?: React.Ref<any>;
+        toggleAs?: ToggleAs;
+    } & React.ComponentProps<ToggleAs>, context: any): JSX.Element | null;
+    Item: typeof NavDropdownItem;
+    Menu: typeof NavDropdownMenu;
 }
-declare const SidenavDropdown: RsRefForwardingComponent<'li', SidenavDropdownProps>;
+/**
+ * @private this component is not supposed to be used directly
+ *          Instead it's rendered by a <Nav.Menu> within a <Sidenav>
+ *
+ * <Sidenav>
+ *   <Nav>
+ *     <Nav.Menu> -> This submenu will render <SidenavDropdown> component
+ *     </Nav.Menu>
+ *   </Nav>
+ * </Sidenav>
+ */
+declare const SidenavDropdown: SidenavDropdownComponent;
 export default SidenavDropdown;