@elastic/eui
Version:
Elastic UI Component Library
221 lines (215 loc) • 11.2 kB
JavaScript
;
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
var _typeof = require("@babel/runtime/helpers/typeof");
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.euiFixedHeadersCount = exports.EuiHeader = exports.EuiFixedHeader = void 0;
var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
var _react = _interopRequireWildcard(require("react"));
var _propTypes = _interopRequireDefault(require("prop-types"));
var _classnames = _interopRequireDefault(require("classnames"));
var _services = require("../../services");
var _global_styling = require("../../global_styling");
var _header_breadcrumbs = require("./header_breadcrumbs");
var _header_section = require("./header_section");
var _header = require("./header.styles");
var _react2 = require("@emotion/react");
var _euiFixedHeadersCount, _euiFixedHeadersCount2;
var _excluded = ["children", "className", "sections", "position", "theme"],
_excluded2 = ["children", "style"];
/*
* 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.
*/
function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(e) { return e ? t : r; })(e); }
function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != _typeof(e) && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
var createHeaderSection = function createHeaderSection(sections) {
return sections.map(function (section, index) {
return (0, _react2.jsx)(_header_section.EuiHeaderSectionItem, {
key: index
}, section);
});
};
var EuiHeader = exports.EuiHeader = function EuiHeader(_ref) {
var children = _ref.children,
className = _ref.className,
sections = _ref.sections,
_ref$position = _ref.position,
position = _ref$position === void 0 ? 'static' : _ref$position,
_ref$theme = _ref.theme,
theme = _ref$theme === void 0 ? 'default' : _ref$theme,
rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
var classes = (0, _classnames.default)('euiHeader', className);
var styles = (0, _services.useEuiMemoizedStyles)(_header.euiHeaderStyles);
var cssStyles = [styles.euiHeader, styles[position], styles[theme]];
if (sections && children) {
// In case both children and sections are passed, warn in the console that the children will be disregarded
console.warn('EuiHeader cannot accept both `children` and `sections`. It will disregard the `children`.');
}
var contents = (0, _react.useMemo)(function () {
if (!sections || !sections.length) return null;
return sections.map(function (section, index) {
var content = [];
if (section.items) {
// Items get wrapped in EuiHeaderSection and each item in a EuiHeaderSectionItem
content.push((0, _react2.jsx)(_header_section.EuiHeaderSection, {
key: "items-".concat(index)
}, createHeaderSection(section.items)));
}
if (section.breadcrumbs) {
content.push(
// Breadcrumbs are separate and cannot be contained in a EuiHeaderSection
// in order for truncation to work
(0, _react2.jsx)(_header_breadcrumbs.EuiHeaderBreadcrumbs, (0, _extends2.default)({
key: "breadcrumbs-".concat(index),
breadcrumbs: section.breadcrumbs
}, section.breadcrumbProps)));
}
return content;
});
}, [sections]) || children;
return position === 'fixed' ? (0, _react2.jsx)(EuiFixedHeader, (0, _extends2.default)({
css: cssStyles,
className: classes
}, rest), contents) : (0, _react2.jsx)("div", (0, _extends2.default)({
css: cssStyles,
className: classes
}, rest), contents);
};
/**
* Fixed headers - logic around dynamically calculating the total
* page offset and setting the `top` position of subsequent headers
*/
// Start a counter to manage the total number of fixed headers
// Exported for unit testing only
EuiHeader.propTypes = {
className: _propTypes.default.string,
"aria-label": _propTypes.default.string,
"data-test-subj": _propTypes.default.string,
css: _propTypes.default.any,
/**
* An array of objects to wrap in a {@link EuiHeaderSection}.
* Each section is spaced using `space-between`.
* See {@link EuiHeaderSections} for object details.
* This prop disregards the prop `children` if both are passed.
*/
sections: _propTypes.default.arrayOf(_propTypes.default.shape({
/**
* An array of items that will be wrapped in a {@link EuiHeaderSectionItem}
*/
items: _propTypes.default.arrayOf(_propTypes.default.node.isRequired),
/**
* Breadcrumbs in the header cannot be wrapped in a {@link EuiHeaderSection} in order for truncation to work.
* Simply pass the array of EuiBreadcrumb objects
*/
breadcrumbs: _propTypes.default.arrayOf(_propTypes.default.any.isRequired),
/**
* Other props to pass to {@link EuiHeaderBreadcrumbs}
*/
breadcrumbProps: _propTypes.default.any
}).isRequired),
/**
* Helper that positions the header against the window body and
* adds the correct amount of top padding to the window when in `fixed` mode
*/
position: _propTypes.default.oneOf(["static", "fixed"]),
/**
* The `default` will inherit its coloring from the light or dark theme.
* Or, force the header into pseudo `dark` theme for all themes.
*/
theme: _propTypes.default.oneOf(["default", "dark"])
};
var euiFixedHeadersCount = exports.euiFixedHeadersCount = 0;
// Exported for unit testing only
var EuiFixedHeader = exports.EuiFixedHeader = function EuiFixedHeader(_ref2) {
var children = _ref2.children,
style = _ref2.style,
rest = (0, _objectWithoutProperties2.default)(_ref2, _excluded2);
var _useEuiThemeCSSVariab = (0, _services.useEuiThemeCSSVariables)(),
setGlobalCSSVariables = _useEuiThemeCSSVariab.setGlobalCSSVariables;
var headerHeight = (0, _services.useEuiMemoizedStyles)(_header.euiHeaderVariables).height;
var getHeaderOffset = (0, _react.useCallback)(function () {
return (0, _global_styling.mathWithUnits)(headerHeight, function (x) {
return x * euiFixedHeadersCount;
});
}, [headerHeight]);
var _useState = (0, _react.useState)(),
_useState2 = (0, _slicedToArray2.default)(_useState, 2),
topPosition = _useState2[0],
setTopPosition = _useState2[1];
(0, _react.useEffect)(function () {
// Get the top position from the offset of previous header(s)
setTopPosition(getHeaderOffset());
// Increment fixed header counter for each fixed header
_euiFixedHeadersCount = euiFixedHeadersCount++, exports.euiFixedHeadersCount = euiFixedHeadersCount, _euiFixedHeadersCount;
setGlobalCSSVariables({
'--euiFixedHeadersOffset': getHeaderOffset()
});
document.body.classList.add('euiBody--headerIsFixed'); // TODO: Consider deleting this legacy className
return function () {
_euiFixedHeadersCount2 = euiFixedHeadersCount--, exports.euiFixedHeadersCount = euiFixedHeadersCount, _euiFixedHeadersCount2;
setGlobalCSSVariables({
'--euiFixedHeadersOffset': getHeaderOffset()
});
if (euiFixedHeadersCount === 0) {
document.body.classList.remove('euiBody--headerIsFixed'); // TODO: Consider deleting this legacy className
}
};
}, [getHeaderOffset, setGlobalCSSVariables]);
var inlineStyles = (0, _react.useMemo)(function () {
return (0, _global_styling.logicalStyles)(_objectSpread({
top: topPosition
}, style));
}, [topPosition, style]);
return (0, _react2.jsx)("div", (0, _extends2.default)({
"data-fixed-header": true // Used by EuiFlyouts as a query selector
,
style: inlineStyles
}, rest), children);
};
EuiFixedHeader.propTypes = {
className: _propTypes.default.string,
"aria-label": _propTypes.default.string,
"data-test-subj": _propTypes.default.string,
css: _propTypes.default.any,
/**
* An array of objects to wrap in a {@link EuiHeaderSection}.
* Each section is spaced using `space-between`.
* See {@link EuiHeaderSections} for object details.
* This prop disregards the prop `children` if both are passed.
*/
sections: _propTypes.default.arrayOf(_propTypes.default.shape({
/**
* An array of items that will be wrapped in a {@link EuiHeaderSectionItem}
*/
items: _propTypes.default.arrayOf(_propTypes.default.node.isRequired),
/**
* Breadcrumbs in the header cannot be wrapped in a {@link EuiHeaderSection} in order for truncation to work.
* Simply pass the array of EuiBreadcrumb objects
*/
breadcrumbs: _propTypes.default.arrayOf(_propTypes.default.any.isRequired),
/**
* Other props to pass to {@link EuiHeaderBreadcrumbs}
*/
breadcrumbProps: _propTypes.default.any
}).isRequired),
/**
* Helper that positions the header against the window body and
* adds the correct amount of top padding to the window when in `fixed` mode
*/
position: _propTypes.default.oneOf(["static", "fixed"]),
/**
* The `default` will inherit its coloring from the light or dark theme.
* Or, force the header into pseudo `dark` theme for all themes.
*/
theme: _propTypes.default.oneOf(["default", "dark"])
};