@elastic/eui
Version:
Elastic UI Component Library
366 lines (362 loc) • 17.4 kB
JavaScript
"use strict";
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
var _typeof = require("@babel/runtime/helpers/typeof");
Object.defineProperty(exports, "__esModule", {
value: true
});
exports._EuiPageTemplate = exports.TemplateContext = exports.EuiPageTemplate = void 0;
var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
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 _outer = require("./outer");
var _inner = require("./inner");
var _page_bottom_bar = require("./bottom_bar/page_bottom_bar");
var _page_empty_prompt = require("./empty_prompt/page_empty_prompt");
var _page = require("../page");
var _services = require("../../services");
var _global_styling = require("../../global_styling");
var _react2 = require("@emotion/react");
var _excluded = ["children", "responsive", "restrictWidth", "paddingSize", "grow", "bottomBorder", "offset", "panelled", "contentBorder", "component", "mainProps", "className", "minHeight"];
/*
* 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(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 ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
var TemplateContext = /*#__PURE__*/(0, _react.createContext)({
section: {},
header: {},
emptyPrompt: {},
bottomBar: {}
});
exports.TemplateContext = TemplateContext;
/**
* Consumed via `EuiPageTemplate`,
* it controls and propogates most of the shared props per direct child
*/
var _EuiPageTemplate = function _EuiPageTemplate(_ref) {
var children = _ref.children,
_ref$responsive = _ref.responsive,
responsive = _ref$responsive === void 0 ? ['xs', 's'] : _ref$responsive,
_ref$restrictWidth = _ref.restrictWidth,
restrictWidth = _ref$restrictWidth === void 0 ? true : _ref$restrictWidth,
_ref$paddingSize = _ref.paddingSize,
paddingSize = _ref$paddingSize === void 0 ? 'l' : _ref$paddingSize,
_ref$grow = _ref.grow,
grow = _ref$grow === void 0 ? true : _ref$grow,
bottomBorder = _ref.bottomBorder,
_offset = _ref.offset,
panelled = _ref.panelled,
contentBorder = _ref.contentBorder,
component = _ref.component,
mainProps = _ref.mainProps,
className = _ref.className,
_ref$minHeight = _ref.minHeight,
minHeight = _ref$minHeight === void 0 ? '460px' : _ref$minHeight,
rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
var _useEuiTheme = (0, _services.useEuiTheme)(),
euiTheme = _useEuiTheme.euiTheme;
var _useState = (0, _react.useState)(_offset),
_useState2 = (0, _slicedToArray2.default)(_useState, 2),
offset = _useState2[0],
setOffset = _useState2[1];
var templateContext = (0, _react.useContext)(TemplateContext);
// Used as a target to insert the bottom bar component
var pageInnerId = (0, _services.useGeneratedHtmlId)({
prefix: 'EuiPageTemplateInner',
conditionalId: mainProps === null || mainProps === void 0 ? void 0 : mainProps.id
});
(0, _react.useEffect)(function () {
if (_offset === undefined) {
var _document$body$datase;
var euiHeaderFixedCounter = Number((_document$body$datase = document.body.dataset.fixedHeaders) !== null && _document$body$datase !== void 0 ? _document$body$datase : 0);
setOffset(euiTheme.base * 3 * euiHeaderFixedCounter);
}
}, [_offset, euiTheme.base]);
// Sections include page header
var sections = [];
var sidebar = [];
var getBottomBorder = function getBottomBorder() {
if (bottomBorder !== undefined) {
return bottomBorder;
} else {
return sidebar.length ? true : 'extended';
}
};
var getHeaderProps = function getHeaderProps() {
return {
restrictWidth: restrictWidth,
paddingSize: paddingSize,
bottomBorder: getBottomBorder()
};
};
var getSectionProps = function getSectionProps() {
return {
restrictWidth: restrictWidth,
paddingSize: paddingSize,
color: panelled === false ? 'transparent' : 'plain'
};
};
var getSideBarProps = function getSideBarProps() {
return {
paddingSize: paddingSize,
responsive: responsive
};
};
var getBottomBarProps = function getBottomBarProps() {
return {
restrictWidth: restrictWidth,
paddingSize: paddingSize,
parent: "#".concat(pageInnerId)
};
};
var innerPanelled = function innerPanelled() {
return panelled === false ? false : Boolean(sidebar.length > 0);
};
var innerBordered = function innerBordered() {
return contentBorder !== undefined ? contentBorder : Boolean(sidebar.length > 0);
};
_react.default.Children.toArray(children).forEach(function (child, index) {
if (! /*#__PURE__*/_react.default.isValidElement(child)) return; // Skip non-components
if (child.type === _page.EuiPageSidebar || child.props.__EMOTION_TYPE_PLEASE_DO_NOT_USE__ === _page.EuiPageSidebar) {
sidebar.push( /*#__PURE__*/_react.default.cloneElement(child, _objectSpread(_objectSpread({
key: "sidebar".concat(index)
}, getSideBarProps()), child.props)));
} else {
sections.push(child);
}
});
var _minHeight = grow ? "max(".concat(minHeight, ", 100vh)") : minHeight;
var classes = (0, _classnames.default)('euiPageTemplate', className);
var pageStyle = _objectSpread(_objectSpread(_objectSpread({}, (0, _global_styling.logicalStyle)('min-height', _minHeight)), (0, _global_styling.logicalStyle)('padding-top', offset)), rest.style);
templateContext.header = getHeaderProps();
templateContext.section = getSectionProps();
templateContext.emptyPrompt = {
panelled: innerPanelled() ? true : panelled,
grow: true
};
templateContext.bottomBar = getBottomBarProps();
return (0, _react2.jsx)(TemplateContext.Provider, {
value: templateContext
}, (0, _react2.jsx)(_outer._EuiPageOuter, (0, _extends2.default)({}, rest, {
responsive: responsive,
style: pageStyle,
className: classes
}), sidebar, (0, _react2.jsx)(_inner._EuiPageInner, (0, _extends2.default)({}, mainProps, {
component: component,
id: pageInnerId,
border: innerBordered(),
panelled: innerPanelled(),
responsive: responsive
}), sections)));
};
exports._EuiPageTemplate = _EuiPageTemplate;
_EuiPageTemplate.propTypes = {
/**
* Adds `flex-grow: 1` to the whole page for stretching to fit vertically.
* Must be wrapped inside a flexbox, preferrably with `min-height: 100vh`
*/
grow: _propTypes.default.bool,
/**
* Changes the `flex-direction` property.
* Flip to `column` when not including a sidebar.
*/
direction: _propTypes.default.oneOf(["row", "column"]),
/**
* Decides at which point the main content wrapper will be 100vw.
*/
/**
* When direction is `row`, it will flip to `column` when within these breakpoints.
*/
responsive: _propTypes.default.arrayOf(_propTypes.default.any.isRequired),
className: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.string]),
"aria-label": _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.string]),
"data-test-subj": _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.string]),
css: _propTypes.default.oneOfType([_propTypes.default.any, _propTypes.default.any]),
/**
* Adds a white background and shadow to define the area.
*/
panelled: _propTypes.default.bool,
/**
* Adjust the overall padding.
*/
paddingSize: _propTypes.default.any,
/**
* Sets the max-width of the page,
* set to `true` to use the default size of `1200px`,
* set to `false` to not restrict the width,
* set to a number for a custom width in px,
* set to a string for a custom width in custom measurement.
*/
restrictWidth: _propTypes.default.oneOfType([_propTypes.default.bool.isRequired, _propTypes.default.number.isRequired, _propTypes.default.string.isRequired]),
/**
* Adds a bottom border to separate it from the content after;
* Passing `extended` will ensure the border touches the sides of the parent container.
*/
bottomBorder: _propTypes.default.oneOfType([_propTypes.default.bool.isRequired, _propTypes.default.oneOf(["extended"])]),
/**
* Applies a top or left border to the inner contents
* to add separation between content and sidebar when a sidebar exists.
*/
contentBorder: _propTypes.default.any,
/**
* Minimum height in which to enforce scrolling
*/
minHeight: _propTypes.default.any,
/**
* To account for any fixed elements like headers,
* pass in the value of the total height of those fixed elements.
* Otherwise they will be calculated based on the data attributes on the body element.
*/
offset: _propTypes.default.number,
/**
* Passes through some common HTML attributes to the `main` content wrapper
*/
mainProps: _propTypes.default.shape({
className: _propTypes.default.string,
"aria-label": _propTypes.default.string,
"data-test-subj": _propTypes.default.string,
css: _propTypes.default.any
}),
/**
* Sets which HTML element to render for the `main` content wrapper
* @default main
*/
component: _propTypes.default.oneOfType([_propTypes.default.any.isRequired, _propTypes.default.elementType.isRequired])
};
var _EuiPageSection = function _EuiPageSection(props) {
var templateContext = (0, _react.useContext)(TemplateContext);
return (0, _react2.jsx)(_page.EuiPageSection, (0, _extends2.default)({}, templateContext.section, {
grow: true
}, props));
};
_EuiPageSection.propTypes = {
className: _propTypes.default.string,
"aria-label": _propTypes.default.string,
"data-test-subj": _propTypes.default.string,
css: _propTypes.default.any,
/**
* Sets the max-width of the page,
* set to `true` to use the default size of `1200px`,
* set to `false` to not restrict the width,
* set to a number for a custom width in px,
* set to a string for a custom width in custom measurement.
*/
restrictWidth: _propTypes.default.oneOfType([_propTypes.default.bool.isRequired, _propTypes.default.number.isRequired, _propTypes.default.string.isRequired]),
/**
* Background color of the section;
* Usually a lightened form of the brand colors
*/
color: _propTypes.default.any,
/**
* Padding for all four sides
*/
paddingSize: _propTypes.default.any,
/**
* Horizontal and/or vertical alignment of the section contents
*/
alignment: _propTypes.default.any,
/**
* When true the panel will grow in height to fill container if parent is a flex group
*/
grow: _propTypes.default.bool,
/**
* Passed down to the div wrapper of the section contents
*/
contentProps: _propTypes.default.shape({
className: _propTypes.default.string,
"aria-label": _propTypes.default.string,
"data-test-subj": _propTypes.default.string,
css: _propTypes.default.any
}),
/**
* Sets which HTML element to render.
*/
component: _propTypes.default.oneOfType([_propTypes.default.any.isRequired, _propTypes.default.elementType.isRequired])
};
var _EuiPageHeader = function _EuiPageHeader(props) {
var templateContext = (0, _react.useContext)(TemplateContext);
return (0, _react2.jsx)(_page.EuiPageHeader, (0, _extends2.default)({}, templateContext.header, props));
};
_EuiPageHeader.propTypes = {
/**
* Adjust the overall padding.
*/
paddingSize: _propTypes.default.any,
className: _propTypes.default.string,
"aria-label": _propTypes.default.string,
"data-test-subj": _propTypes.default.string,
css: _propTypes.default.any,
/**
* Sets the max-width of the page,
* set to `true` to use the default size of `1200px`,
* set to `false` to not restrict the width,
* set to a number for a custom width in px,
* set to a string for a custom width in custom measurement.
*/
restrictWidth: _propTypes.default.oneOfType([_propTypes.default.bool.isRequired, _propTypes.default.number.isRequired, _propTypes.default.string.isRequired]),
/**
* Adds a bottom border to separate it from the content after;
* Passing `extended` will ensure the border touches the sides of the parent container.
*/
bottomBorder: _propTypes.default.oneOfType([_propTypes.default.bool.isRequired, _propTypes.default.oneOf(["extended"])])
};
var _EuiPageEmptyPrompt = function _EuiPageEmptyPrompt(props) {
var templateContext = (0, _react.useContext)(TemplateContext);
return (0, _react2.jsx)(_page_empty_prompt._EuiPageEmptyPrompt, (0, _extends2.default)({}, templateContext.emptyPrompt, props));
};
_EuiPageEmptyPrompt.propTypes = {
className: _propTypes.default.string,
"aria-label": _propTypes.default.string,
"data-test-subj": _propTypes.default.string,
css: _propTypes.default.any,
restrictWidth: _propTypes.default.oneOfType([_propTypes.default.bool.isRequired, _propTypes.default.number.isRequired, _propTypes.default.string.isRequired]),
color: _propTypes.default.any,
paddingSize: _propTypes.default.any,
alignment: _propTypes.default.any,
grow: _propTypes.default.bool,
contentProps: _propTypes.default.shape({
className: _propTypes.default.string,
"aria-label": _propTypes.default.string,
"data-test-subj": _propTypes.default.string,
css: _propTypes.default.any
}),
component: _propTypes.default.oneOfType([_propTypes.default.any.isRequired, _propTypes.default.elementType.isRequired]),
panelled: _propTypes.default.bool
};
var _EuiPageBottomBar = function _EuiPageBottomBar(props) {
var _useContext = (0, _react.useContext)(TemplateContext),
bottomBar = _useContext.bottomBar;
return (0, _react2.jsx)(_page_bottom_bar._EuiPageBottomBar, (0, _extends2.default)({}, bottomBar, props));
};
_EuiPageBottomBar.propTypes = {
/**
* The reference id of the element to insert into
*/
parent: _propTypes.default.string,
/**
* Sets the max-width of the page,
* set to `true` to use the default size of `1200px`,
* set to `false` to not restrict the width,
* set to a number for a custom width in px,
* set to a string for a custom width in custom measurement.
*/
restrictWidth: _propTypes.default.oneOfType([_propTypes.default.bool.isRequired, _propTypes.default.number.isRequired, _propTypes.default.string.isRequired])
};
var EuiPageTemplate = Object.assign(_EuiPageTemplate, {
Sidebar: _page.EuiPageSidebar,
Header: _EuiPageHeader,
Section: _EuiPageSection,
BottomBar: _EuiPageBottomBar,
EmptyPrompt: _EuiPageEmptyPrompt
});
exports.EuiPageTemplate = EuiPageTemplate;