@elastic/eui
Version:
Elastic UI Component Library
313 lines (307 loc) • 21.5 kB
JavaScript
"use strict";
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.EuiSideNav = void 0;
var _react = _interopRequireWildcard(require("react"));
var _propTypes = _interopRequireDefault(require("prop-types"));
var _classnames = _interopRequireDefault(require("classnames"));
var _side_nav_item = require("./side_nav_item");
var _button = require("../button");
var _title = require("../title");
var _accessibility = require("../accessibility");
var _services = require("../../services");
var _responsive = require("../responsive");
var _react2 = require("@emotion/react");
var _excluded = ["id", "name", "isSelected", "items", "icon", "onClick", "href", "forceOpen"],
_excluded2 = ["className", "items", "toggleOpenOnMobile", "isOpenOnMobile", "mobileTitle", "mobileBreakpoints", "renderItem", "truncate", "heading", "headingProps"],
_excluded3 = ["screenReaderOnly", "element"];
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
function _inherits(subClass, superClass) { if (typeof superClass !== "function" && superClass !== null) { throw new TypeError("Super expression must either be null or a function"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); Object.defineProperty(subClass, "prototype", { writable: false }); if (superClass) _setPrototypeOf(subClass, superClass); }
function _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }
function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }
function _possibleConstructorReturn(self, call) { if (call && (_typeof(call) === "object" || typeof call === "function")) { return call; } else if (call !== void 0) { throw new TypeError("Derived constructors may only return object or undefined"); } return _assertThisInitialized(self); }
function _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); } return self; }
function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }
function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); } /*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
var EuiSideNav = /*#__PURE__*/function (_Component) {
_inherits(EuiSideNav, _Component);
var _super = _createSuper(EuiSideNav);
function EuiSideNav() {
var _this;
_classCallCheck(this, EuiSideNav);
for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
args[_key] = arguments[_key];
}
_this = _super.call.apply(_super, [this].concat(args));
_defineProperty(_assertThisInitialized(_this), "generateId", (0, _services.htmlIdGenerator)('euiSideNav'));
_defineProperty(_assertThisInitialized(_this), "isItemOpen", function (item) {
// The developer can force the item to be open.
if (item.forceOpen) {
return true;
}
// Of course a selected item is open.
if (item.isSelected) {
return true;
}
// The item has to be open if it has a child that's open.
if (item.items) {
return item.items.some(_this.isItemOpen);
}
return false;
});
_defineProperty(_assertThisInitialized(_this), "renderTree", function (items) {
var depth = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 0;
var _this$props = _this.props,
renderItem = _this$props.renderItem,
truncate = _this$props.truncate;
return items.map(function (item) {
var id = item.id,
name = item.name,
isSelected = item.isSelected,
childItems = item.items,
icon = item.icon,
onClick = item.onClick,
href = item.href,
forceOpen = item.forceOpen,
rest = _objectWithoutProperties(item, _excluded);
// Root items are always open.
var isOpen = depth === 0 ? true : _this.isItemOpen(item);
var renderedItems;
if (childItems) {
renderedItems = _this.renderTree(childItems, depth + 1);
}
// Act as an accordion only if item is not linked but has children (and not the root)
var childrenOnly = depth > 0 && !onClick && !href && !!childItems;
return (0, _react2.jsx)(_side_nav_item.EuiSideNavItem, _extends({
isOpen: isOpen,
isSelected: !childrenOnly && isSelected,
isParent: !!childItems,
icon: icon,
onClick: onClick,
href: href,
items: renderedItems,
key: id,
depth: depth,
renderItem: renderItem,
truncate: truncate,
childrenOnly: childrenOnly
}, rest), name);
});
});
return _this;
}
_createClass(EuiSideNav, [{
key: "render",
value: function render() {
var _this$props2 = this.props,
className = _this$props2.className,
items = _this$props2.items,
toggleOpenOnMobile = _this$props2.toggleOpenOnMobile,
isOpenOnMobile = _this$props2.isOpenOnMobile,
mobileTitle = _this$props2.mobileTitle,
mobileBreakpoints = _this$props2.mobileBreakpoints,
renderItem = _this$props2.renderItem,
truncate = _this$props2.truncate,
heading = _this$props2.heading,
_this$props2$headingP = _this$props2.headingProps,
headingProps = _this$props2$headingP === void 0 ? {} : _this$props2$headingP,
rest = _objectWithoutProperties(_this$props2, _excluded2);
var classes = (0, _classnames.default)('euiSideNav', className, {
'euiSideNav-isOpenMobile': isOpenOnMobile
});
// To support the extra CSS needed to show/hide/animate the content,
// We add a className for every breakpoint supported
var contentClasses = (0, _classnames.default)('euiSideNav__content', mobileBreakpoints === null || mobileBreakpoints === void 0 ? void 0 : mobileBreakpoints.map(function (breakpointName) {
return "euiSideNav__contentMobile-".concat(breakpointName);
}));
var sideNavContentId = this.generateId('content');
var navContent = (0, _react2.jsx)("div", {
id: sideNavContentId,
className: contentClasses
}, this.renderTree(items));
var _ref = headingProps,
_ref$screenReaderOnly = _ref.screenReaderOnly,
headingScreenReaderOnly = _ref$screenReaderOnly === void 0 ? false : _ref$screenReaderOnly,
_ref$element = _ref.element,
HeadingElement = _ref$element === void 0 ? 'h2' : _ref$element,
titleProps = _objectWithoutProperties(_ref, _excluded3);
var hasMobileVersion = mobileBreakpoints && mobileBreakpoints.length > 0;
var hasHeader = !!heading;
var headingNode;
var sharedHeadingProps = {
id: (headingProps === null || headingProps === void 0 ? void 0 : headingProps.id) || this.generateId('heading'),
className: headingProps === null || headingProps === void 0 ? void 0 : headingProps.className,
'data-test-subj': headingProps === null || headingProps === void 0 ? void 0 : headingProps['data-test-subj'],
'aria-label': headingProps === null || headingProps === void 0 ? void 0 : headingProps['aria-label']
};
if (hasHeader) {
headingNode = (0, _react2.jsx)(HeadingElement, sharedHeadingProps, heading);
if (headingScreenReaderOnly) {
headingNode = (0, _react2.jsx)(_accessibility.EuiScreenReaderOnly, null, headingNode);
} else {
headingNode = (0, _react2.jsx)(_title.EuiTitle, _extends({
size: "xs"
}, titleProps, {
className: (0, _classnames.default)('euiSideNav__heading', headingProps === null || headingProps === void 0 ? void 0 : headingProps.className)
}), (0, _react2.jsx)(HeadingElement, sharedHeadingProps, heading));
}
}
var mobileNode;
var breakpoints = mobileBreakpoints;
if (hasMobileVersion) {
mobileNode = (0, _react2.jsx)(_responsive.EuiShowFor, {
sizes: breakpoints || 'none'
}, (0, _react2.jsx)("nav", _extends({
"aria-labelledby": sharedHeadingProps.id,
className: classes
}, rest), (0, _react2.jsx)(HeadingElement, sharedHeadingProps, (0, _react2.jsx)(_button.EuiButtonEmpty, {
className: "euiSideNav__mobileToggle",
textProps: {
className: 'euiSideNav__mobileToggleText'
},
contentProps: {
className: 'euiSideNav__mobileToggleContent'
},
onClick: toggleOpenOnMobile,
iconType: "apps",
iconSide: "right",
"aria-controls": sideNavContentId,
"aria-expanded": isOpenOnMobile
}, mobileTitle || heading)), navContent));
}
return (0, _react2.jsx)(_react.default.Fragment, null, mobileNode, (0, _react2.jsx)(_responsive.EuiHideFor, {
sizes: breakpoints || 'none'
}, (0, _react2.jsx)("nav", _extends({
"aria-labelledby": headingNode ? sharedHeadingProps.id : undefined,
className: classes
}, rest), headingNode, navContent)));
}
}]);
return EuiSideNav;
}(_react.Component);
exports.EuiSideNav = EuiSideNav;
_defineProperty(EuiSideNav, "defaultProps", {
items: [],
mobileBreakpoints: ['xs', 's']
});
EuiSideNav.propTypes = {
/**
* Class names to be merged into the final `className` property.
*/
className: _propTypes.default.string,
"aria-label": _propTypes.default.string,
"data-test-subj": _propTypes.default.string,
css: _propTypes.default.any,
/**
* Creates an associated heading element and uses the same node as default for `mobileTitle`
*/
heading: _propTypes.default.node,
/**
* Adds a couple extra #EuiSideNavHeading props and extends the props of EuiTitle that wraps the `heading`
*/
headingProps: _propTypes.default.shape({
className: _propTypes.default.string,
"aria-label": _propTypes.default.string,
"data-test-subj": _propTypes.default.string,
css: _propTypes.default.any,
/**
* The actual HTML heading element to wrap the `heading`.
* Default is `h2`
*/
element: _propTypes.default.oneOf(["h1", "h2", "h3", "h4", "h5", "h6", "span"]),
/**
* For best accessibility, `<nav>` elements should have a nested heading. But you can hide this element if it's redundent from something else (except on mobile).
*/
screenReaderOnly: _propTypes.default.bool
}),
/**
* When called, toggles visibility of the navigation menu at mobile responsive widths. The callback should set the `isOpenOnMobile` prop to actually toggle navigation visibility.
*/
toggleOpenOnMobile: _propTypes.default.func,
/**
* If `true`, the navigation menu will be open at mobile device widths. Use in conjunction with the `toggleOpenOnMobile` prop.
*/
isOpenOnMobile: _propTypes.default.bool,
/**
* A React node to render at mobile responsive widths, representing the title of this navigation menu.
*/
mobileTitle: _propTypes.default.node,
/**
* Array of breakpoint names for when to show the mobile version.
* Set to `undefined` to remove responsive behavior
*/
mobileBreakpoints: _propTypes.default.arrayOf(_propTypes.default.any.isRequired),
/**
* An array of #EuiSideNavItem objects. Lists navigation menu items.
*/
items: _propTypes.default.arrayOf(_propTypes.default.shape({
/**
* A value that is passed to React as the `key` for this item
*/
id: _propTypes.default.oneOfType([_propTypes.default.string.isRequired, _propTypes.default.number.isRequired]).isRequired,
/**
* If set to true it will force the item to display in an "open" state at all times.
*/
forceOpen: _propTypes.default.bool,
/**
* Array containing additional item objects, representing nested children of this navigation item.
*/
items: _propTypes.default.arrayOf(_propTypes.default.shape({
/**
* A value that is passed to React as the `key` for this item
*/
id: _propTypes.default.oneOfType([_propTypes.default.string.isRequired, _propTypes.default.number.isRequired]).isRequired,
/**
* If set to true it will force the item to display in an "open" state at all times.
*/
forceOpen: _propTypes.default.bool,
/**
* Array containing additional item objects, representing nested children of this navigation item.
*/
items: _propTypes.default.arrayOf(_propTypes.default.any.isRequired),
/**
* React node representing the text to render for this item (usually a string will suffice).
*/
name: _propTypes.default.node.isRequired,
/**
* Function overriding default rendering for this navigation item — when called, it should return a React node representing a replacement navigation item.
*/
renderItem: _propTypes.default.func
}).isRequired),
/**
* React node representing the text to render for this item (usually a string will suffice).
*/
name: _propTypes.default.node.isRequired,
/**
* Function overriding default rendering for this navigation item — when called, it should return a React node representing a replacement navigation item.
*/
renderItem: _propTypes.default.func
}).isRequired).isRequired,
/**
* Overrides default navigation menu item rendering. When called, it should return a React node representing a replacement navigation item.
*/
renderItem: _propTypes.default.func,
/**
* Truncates the text of all items to stick to a single line
*/
truncate: _propTypes.default.bool
};