@elastic/eui
Version:
Elastic UI Component Library
291 lines (287 loc) • 16.1 kB
JavaScript
"use strict";
function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.POSITIONS = exports.PADDING_SIZES = exports.EuiBottomBar = void 0;
var _classnames = _interopRequireDefault(require("classnames"));
var _propTypes = _interopRequireDefault(require("prop-types"));
var _react = _interopRequireWildcard(require("react"));
var _services = require("../../services");
var _accessibility = require("../accessibility");
var _i18n = require("../i18n");
var _resize_observer = require("../observer/resize_observer");
var _portal = require("../portal");
var _bottom_bar = require("./bottom_bar.styles");
var _react2 = require("@emotion/react");
var _excluded = ["position", "paddingSize", "affordForDisplacement", "children", "className", "bodyClassName", "landmarkHeading", "usePortal", "left", "right", "bottom", "top", "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 _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
function _extends() { return _extends = Object.assign ? Object.assign.bind() : function (n) { for (var e = 1; e < arguments.length; e++) { var t = arguments[e]; for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]); } return n; }, _extends.apply(null, arguments); }
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) { _defineProperty(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; }
function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
function _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest(); }
function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t.return && (u = t.return(), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
function _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], t.indexOf(o) >= 0 || {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }
function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (e.indexOf(n) >= 0) continue; t[n] = r[n]; } return t; }
var PADDING_SIZES = exports.PADDING_SIZES = ['none', 's', 'm', 'l'];
var POSITIONS = exports.POSITIONS = ['static', 'fixed', 'sticky'];
var _EuiBottomBar = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
var _ref$position = _ref.position,
position = _ref$position === void 0 ? 'fixed' : _ref$position,
_ref$paddingSize = _ref.paddingSize,
paddingSize = _ref$paddingSize === void 0 ? 'm' : _ref$paddingSize,
_ref$affordForDisplac = _ref.affordForDisplacement,
affordForDisplacement = _ref$affordForDisplac === void 0 ? true : _ref$affordForDisplac,
children = _ref.children,
className = _ref.className,
bodyClassName = _ref.bodyClassName,
landmarkHeading = _ref.landmarkHeading,
_ref$usePortal = _ref.usePortal,
usePortal = _ref$usePortal === void 0 ? true : _ref$usePortal,
_ref$left = _ref.left,
left = _ref$left === void 0 ? 0 : _ref$left,
_ref$right = _ref.right,
right = _ref$right === void 0 ? 0 : _ref$right,
_ref$bottom = _ref.bottom,
bottom = _ref$bottom === void 0 ? 0 : _ref$bottom,
top = _ref.top,
style = _ref.style,
rest = _objectWithoutProperties(_ref, _excluded);
var styles = (0, _services.useEuiMemoizedStyles)(_bottom_bar.euiBottomBarStyles);
var _useEuiThemeCSSVariab = (0, _services.useEuiThemeCSSVariables)(),
setGlobalCSSVariables = _useEuiThemeCSSVariab.setGlobalCSSVariables;
// Force some props if `fixed` position, but not if the user has supplied these
affordForDisplacement = position !== 'fixed' ? false : affordForDisplacement;
usePortal = position !== 'fixed' ? false : usePortal;
var _useState = (0, _react.useState)(null),
_useState2 = _slicedToArray(_useState, 2),
resizeRef = _useState2[0],
setResizeRef = _useState2[1];
var setRef = (0, _services.useCombinedRefs)([setResizeRef, ref]);
// TODO: Allow this hooke to be conditional
var dimensions = (0, _resize_observer.useResizeObserver)(resizeRef);
(0, _react.useEffect)(function () {
if (affordForDisplacement && usePortal) {
document.body.style.paddingBottom = "".concat(dimensions.height, "px");
// EUI doesn't use this css variable, but it is useful for consumers
setGlobalCSSVariables({
'--euiBottomBarOffset': "".concat(dimensions.height, "px")
});
}
if (bodyClassName) {
document.body.classList.add(bodyClassName);
}
return function () {
if (affordForDisplacement && usePortal) {
document.body.style.paddingBottom = '';
setGlobalCSSVariables({
'--euiBottomBarOffset': null
});
}
if (bodyClassName) {
document.body.classList.remove(bodyClassName);
}
};
}, [affordForDisplacement, usePortal, dimensions, bodyClassName, setGlobalCSSVariables]);
var classes = (0, _classnames.default)('euiBottomBar', "euiBottomBar--".concat(position), className);
var cssStyles = [styles.euiBottomBar, styles[position], styles[paddingSize]];
var newStyle = _objectSpread({
left: left,
right: right,
bottom: bottom,
top: top
}, style);
var bar = (0, _react2.jsx)(_react.default.Fragment, null, (0, _react2.jsx)(_i18n.EuiI18n, {
token: "euiBottomBar.screenReaderHeading",
default: "Page level controls"
}, function (screenReaderHeading) {
return (
// Though it would be better to use aria-labelledby than aria-label and not repeat the same string twice
// A bug in voiceover won't list some landmarks in the rotor without an aria-label
(0, _react2.jsx)("section", _extends({
"aria-label": landmarkHeading ? landmarkHeading : screenReaderHeading,
className: classes,
css: cssStyles,
ref: setRef,
style: newStyle
}, rest), (0, _react2.jsx)(_accessibility.EuiScreenReaderOnly, null, (0, _react2.jsx)("h2", null, landmarkHeading ? landmarkHeading : screenReaderHeading)), children)
);
}), (0, _react2.jsx)(_accessibility.EuiScreenReaderOnly, null, (0, _react2.jsx)("p", {
"aria-live": "assertive"
}, landmarkHeading ? (0, _react2.jsx)(_i18n.EuiI18n, {
token: "euiBottomBar.customScreenReaderAnnouncement",
default: "There is a new region landmark called {landmarkHeading} with page level controls at the end of the document.",
values: {
landmarkHeading: landmarkHeading
}
}) : (0, _react2.jsx)(_i18n.EuiI18n, {
token: "euiBottomBar.screenReaderAnnouncement",
default: "There is a new region landmark with page level controls at the end of the document."
}))));
return usePortal ? (0, _react2.jsx)(_portal.EuiPortal, typeof usePortal !== 'boolean' ? usePortal : undefined, bar) : bar;
});
_EuiBottomBar.propTypes = {
className: _propTypes.default.string,
"aria-label": _propTypes.default.string,
"data-test-subj": _propTypes.default.string,
css: _propTypes.default.any,
/**
* How to position the bottom bar against its parent.
*/
position: _propTypes.default.oneOfType([_propTypes.default.oneOf(["fixed"]), _propTypes.default.oneOf(["static", "sticky"]).isRequired]),
/**
* Whether to wrap in an EuiPortal which appends the component to the body element.
* Only works if `position` is `fixed`.
*/
usePortal: _propTypes.default.oneOfType([_propTypes.default.bool.isRequired, _propTypes.default.shape({
/**
* ReactNode to render as this component's content
*/
children: _propTypes.default.node.isRequired,
/**
* If not specified, `EuiPortal` will insert itself
* into the end of the `document.body` by default
*/
insert: _propTypes.default.shape({
sibling: _propTypes.default.any.isRequired,
position: _propTypes.default.any.isRequired
}),
/**
* Optional ref callback
*/
portalRef: _propTypes.default.func
}).isRequired]),
/**
* Whether the component should apply padding on the document body element to afford for its own displacement height.
* Only works if `usePortal` is true and `position` is `fixed`.
*/
affordForDisplacement: _propTypes.default.bool,
/**
* Padding applied to the bar. Default is 'm'.
*/
paddingSize: _propTypes.default.any,
/**
* Optional class applied to the body element on mount.
*/
bodyClassName: _propTypes.default.string,
/**
* Customize the screen reader heading that helps users find this control.
*
* @default Page level controls
*/
landmarkHeading: _propTypes.default.string,
/**
* Starting vertical position when `fixed` position.
* Offset from the top of the window when `sticky` position.
* Has no affect on `static` positions.
*/
top: _propTypes.default.any,
/**
* Ending horizontal position when `fixed` position.
* Has no affect on `static` or `sticky` positions.
*/
right: _propTypes.default.any,
/**
* Starting vertical position when `fixed` position.
* Offset from the bottom of the window when `sticky` position.
* Has no affect on `static` positions.
*/
bottom: _propTypes.default.any,
/**
* Starting horizontal position when `fixed` position.
* Has no affect on `static` or `sticky` positions.
*/
left: _propTypes.default.any
};
var EuiBottomBar = exports.EuiBottomBar = /*#__PURE__*/(0, _react.forwardRef)(function (props, ref) {
var BottomBar = _EuiBottomBar;
return (0, _react2.jsx)(_services.EuiThemeProvider, {
colorMode: "dark",
wrapperProps: {
cloneElement: true
}
}, (0, _react2.jsx)(BottomBar, _extends({
ref: ref
}, props)));
});
EuiBottomBar.propTypes = {
className: _propTypes.default.string,
"aria-label": _propTypes.default.string,
"data-test-subj": _propTypes.default.string,
css: _propTypes.default.any,
/**
* How to position the bottom bar against its parent.
*/
position: _propTypes.default.oneOfType([_propTypes.default.oneOf(["fixed"]), _propTypes.default.oneOf(["static", "sticky"]).isRequired]),
/**
* Whether to wrap in an EuiPortal which appends the component to the body element.
* Only works if `position` is `fixed`.
*/
usePortal: _propTypes.default.oneOfType([_propTypes.default.bool.isRequired, _propTypes.default.shape({
children: _propTypes.default.node.isRequired,
insert: _propTypes.default.shape({
sibling: _propTypes.default.any.isRequired,
position: _propTypes.default.any.isRequired
}),
portalRef: _propTypes.default.func
}).isRequired]),
/**
* Whether the component should apply padding on the document body element to afford for its own displacement height.
* Only works if `usePortal` is true and `position` is `fixed`.
*/
affordForDisplacement: _propTypes.default.bool,
/**
* Padding applied to the bar. Default is 'm'.
*/
paddingSize: _propTypes.default.any,
/**
* Optional class applied to the body element on mount.
*/
bodyClassName: _propTypes.default.string,
/**
* Customize the screen reader heading that helps users find this control.
*
* @default Page level controls
*/
landmarkHeading: _propTypes.default.string,
/**
* Starting vertical position when `fixed` position.
* Offset from the top of the window when `sticky` position.
* Has no affect on `static` positions.
*/
top: _propTypes.default.any,
/**
* Ending horizontal position when `fixed` position.
* Has no affect on `static` or `sticky` positions.
*/
right: _propTypes.default.any,
/**
* Starting vertical position when `fixed` position.
* Offset from the bottom of the window when `sticky` position.
* Has no affect on `static` positions.
*/
bottom: _propTypes.default.any,
/**
* Starting horizontal position when `fixed` position.
* Has no affect on `static` or `sticky` positions.
*/
left: _propTypes.default.any
};
EuiBottomBar.displayName = 'EuiBottomBar';
_EuiBottomBar.displayName = 'EuiBottomBar';