@elastic/eui 88.1.0 → 88.2.0

package/es/components/page_template/page_template.js

@@ -6,12 +6,6 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 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); }
-function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _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(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
-function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i.return && (_r = _i.return(), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
-function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
 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; }
 /*
@@ -22,7 +16,7 @@ function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) r
  * Side Public License, v 1.
  */
 
-import React, { createContext, useContext, useEffect, useState } from 'react';
+import React, { createContext, useContext } from 'react';
 import PropTypes from "prop-types";
 import classNames from 'classnames';
 import { _EuiPageOuter as EuiPageOuter } from './outer';
@@ -30,7 +24,7 @@ import { _EuiPageInner as EuiPageInner } from './inner';
 import { _EuiPageBottomBar as EuiPageBottomBar } from './bottom_bar/page_bottom_bar';
 import { _EuiPageEmptyPrompt as EuiPageEmptyPrompt } from './empty_prompt/page_empty_prompt';
 import { EuiPageHeader, EuiPageSection, EuiPageSidebar } from '../page';
-import { useEuiTheme, useGeneratedHtmlId } from '../../services';
+import { useGeneratedHtmlId } from '../../services';
 import { logicalStyle } from '../../global_styling';
 import { jsx as ___EmotionJSX } from "@emotion/react";
 export var TemplateContext = /*#__PURE__*/createContext({
@@ -39,14 +33,6 @@ export var TemplateContext = /*#__PURE__*/createContext({
   emptyPrompt: {},
   bottomBar: {}
 });
-var calculateOffset = function calculateOffset(base) {
-  var _document$body$datase;
-  if (typeof document === 'undefined') return 0; // SSR catch
-
-  var euiHeaderFixedCounter = Number((_document$body$datase = document.body.dataset.fixedHeaders) !== null && _document$body$datase !== void 0 ? _document$body$datase : 0);
-  return base * 3 * euiHeaderFixedCounter;
-};
-
 /**
  * Consumed via `EuiPageTemplate`,
  * it controls and propogates most of the shared props per direct child
@@ -62,7 +48,7 @@ export var _EuiPageTemplate = function _EuiPageTemplate(_ref) {
     _ref$grow = _ref.grow,
     grow = _ref$grow === void 0 ? true : _ref$grow,
     bottomBorder = _ref.bottomBorder,
-    _offset = _ref.offset,
+    offset = _ref.offset,
     panelled = _ref.panelled,
     contentBorder = _ref.contentBorder,
     component = _ref.component,
@@ -71,14 +57,6 @@ export var _EuiPageTemplate = function _EuiPageTemplate(_ref) {
     _ref$minHeight = _ref.minHeight,
     minHeight = _ref$minHeight === void 0 ? '460px' : _ref$minHeight,
     rest = _objectWithoutProperties(_ref, _excluded);
-  var _useEuiTheme = useEuiTheme(),
-    euiTheme = _useEuiTheme.euiTheme;
-  var _useState = useState(function () {
-      return _offset !== null && _offset !== void 0 ? _offset : calculateOffset(euiTheme.base);
-    }),
-    _useState2 = _slicedToArray(_useState, 2),
-    offset = _useState2[0],
-    setOffset = _useState2[1];
   var templateContext = useContext(TemplateContext);
 
   // Used as a target to insert the bottom bar component
@@ -86,11 +64,6 @@ export var _EuiPageTemplate = function _EuiPageTemplate(_ref) {
     prefix: 'EuiPageTemplateInner',
     conditionalId: mainProps === null || mainProps === void 0 ? void 0 : mainProps.id
   });
-  useEffect(function () {
-    if (_offset === undefined) {
-      setOffset(calculateOffset(euiTheme.base));
-    }
-  }, [_offset, euiTheme.base]);
 
   // Sections include page header
   var sections = [];
@@ -149,7 +122,7 @@ export var _EuiPageTemplate = function _EuiPageTemplate(_ref) {
   });
   var _minHeight = grow ? "max(".concat(minHeight, ", 100vh)") : minHeight;
   var classes = classNames('euiPageTemplate', className);
-  var pageStyle = _objectSpread(_objectSpread(_objectSpread({}, logicalStyle('min-height', _minHeight)), logicalStyle('padding-top', offset)), rest.style);
+  var pageStyle = _objectSpread(_objectSpread(_objectSpread({}, logicalStyle('min-height', _minHeight)), logicalStyle('padding-top', offset !== null && offset !== void 0 ? offset : 'var(--euiFixedHeadersOffset, 0)')), rest.style);
   templateContext.header = getHeaderProps();
   templateContext.section = getSectionProps();
   templateContext.emptyPrompt = {

package/es/components/text_truncate/index.js

@@ -0,0 +1,10 @@
+/*
+ * 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.
+ */
+
+export { EuiTextTruncate } from './text_truncate';
+export { TruncationUtilsWithDOM, TruncationUtilsWithCanvas } from './utils';

package/es/components/text_truncate/text_truncate.js

@@ -0,0 +1,232 @@
+var _excluded = ["width"],
+  _excluded2 = ["width", "children", "text", "truncation", "truncationOffset", "truncationPosition", "ellipsis", "containerRef", "measurementRenderAPI"],
+  _excluded3 = ["onResize"];
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _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(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i.return && (_r = _i.return(), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+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; }
+/*
+ * 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.
+ */
+
+import React, { useState, useMemo, useCallback } from 'react';
+import PropTypes from "prop-types";
+import { useCombinedRefs } from '../../services';
+import { EuiResizeObserver } from '../observer/resize_observer';
+import { TruncationUtilsWithDOM, TruncationUtilsWithCanvas } from './utils';
+import { euiTextTruncateStyles } from './text_truncate.styles';
+import { jsx as ___EmotionJSX } from "@emotion/react";
+var TRUNCATION_TYPES = ['end', 'start', 'startEnd', 'middle'];
+export var EuiTextTruncate = function EuiTextTruncate(_ref) {
+  var width = _ref.width,
+    props = _objectWithoutProperties(_ref, _excluded);
+  return width != null ? ___EmotionJSX(EuiTextTruncateWithWidth, _extends({
+    width: width
+  }, props)) : ___EmotionJSX(EuiTextTruncateWithResizeObserver, props);
+};
+EuiTextTruncate.propTypes = {
+  className: PropTypes.string,
+  "aria-label": PropTypes.string,
+  "data-test-subj": PropTypes.string,
+  css: PropTypes.any,
+  /**
+       * The full text string to truncate
+       */
+  text: PropTypes.string.isRequired,
+  /**
+       * The truncation type desired. Determines where the ellipses are placed.
+       */
+  truncation: PropTypes.any,
+  /**
+       * This prop **only** applies to the `start` and `end` truncation types.
+       * It allows preserving a certain number of characters of either the
+       * starting or ending text.
+       *
+       * If the passed offset is greater than the total text length,
+       * the offset will be ignored.
+       */
+  truncationOffset: PropTypes.number,
+  /**
+       * This prop **only** applies to the `startEnd` truncation type.
+       * It allows customizing the anchor position of the displayed text,
+       * which otherwise defaults to the middle of the text string.
+       *
+       * The primary use case for this prop for is search highlighting - e.g., if
+       * a user searches for a specific word in the text, pass the index of that
+       * found word to ensure it is always visible.
+       *
+       * This behavior will intelligently detect when positions are close to the start
+       * or end of the text, and omit leading or trailing ellipses when necessary.
+       * If the passed position is greater than the total text length,
+       * the truncation will simply default to `start` instead.
+       */
+  truncationPosition: PropTypes.number,
+  /**
+       * Defaults to the horizontal ellipsis character.
+       * Can be optionally configured to use other punctuation,
+       * e.g. spaces, brackets, hyphens, asterisks, etc.
+       */
+  ellipsis: PropTypes.string,
+  /**
+       * By default, EuiTextTruncate will render a resize observer to detect the
+       * available width it has. For performance reasons (e.g. multiple truncated
+       * text items within the same container), you may opt to pass in your own
+       * container width, which will skip initializing a resize observer.
+       */
+  width: PropTypes.number,
+  /**
+       * Optional callback that fires when the default resizer observer both mounts and
+       * registers a size change. This callback will **not** fire if `width` is passed.
+       */
+  onResize: PropTypes.func,
+  /**
+       * By default, EuiTextTruncate will calculate its truncation via DOM manipulation
+       * and measurement, which has the benefit of automatically inheriting font styles.
+       * However, if this approach proves to have a significant performance impact for your
+       * usage, consider using the `canvas` API instead, which is more performant.
+       *
+       * Please note that there are minute pixel to subpixel differences between the
+       * two options due to different rendering engines.
+       */
+  measurementRenderAPI: PropTypes.oneOf(["dom", "canvas"]),
+  /**
+       * By default, EuiTextTruncate will render the truncated string directly.
+       * You can optionally pass a render prop function to the component, which
+       * allows for more flexible text rendering, e.g. adding custom markup
+       * or highlighting
+       */
+  children: PropTypes.func
+};
+var EuiTextTruncateWithWidth = function EuiTextTruncateWithWidth(_ref2) {
+  var width = _ref2.width,
+    children = _ref2.children,
+    text = _ref2.text,
+    _ref2$truncation = _ref2.truncation,
+    _truncation = _ref2$truncation === void 0 ? 'end' : _ref2$truncation,
+    _ref2$truncationOffse = _ref2.truncationOffset,
+    _truncationOffset = _ref2$truncationOffse === void 0 ? 0 : _ref2$truncationOffse,
+    truncationPosition = _ref2.truncationPosition,
+    _ref2$ellipsis = _ref2.ellipsis,
+    ellipsis = _ref2$ellipsis === void 0 ? '…' : _ref2$ellipsis,
+    containerRef = _ref2.containerRef,
+    _ref2$measurementRend = _ref2.measurementRenderAPI,
+    measurementRenderAPI = _ref2$measurementRend === void 0 ? 'dom' : _ref2$measurementRend,
+    rest = _objectWithoutProperties(_ref2, _excluded2);
+  // Note: This needs to be a state and not a ref to trigger a rerender on mount
+  var _useState = useState(null),
+    _useState2 = _slicedToArray(_useState, 2),
+    containerEl = _useState2[0],
+    setContainerEl = _useState2[1];
+  var refs = useCombinedRefs([setContainerEl, containerRef]);
+
+  // Handle exceptions where we need to override the passed props
+  var _useMemo = useMemo(function () {
+      var truncation = _truncation;
+      var truncationOffset = 0;
+      if (_truncation === 'end' || _truncation === 'start') {
+        if (0 < _truncationOffset && _truncationOffset < text.length) {
+          truncationOffset = _truncationOffset;
+        }
+      } else if (_truncation === 'startEnd' && truncationPosition != null) {
+        if (truncationPosition <= 0) {
+          truncation = 'end';
+        } else if (truncationPosition >= text.length) {
+          truncation = 'start';
+        }
+      }
+      return {
+        truncation: truncation,
+        truncationOffset: truncationOffset
+      };
+    }, [_truncation, _truncationOffset, truncationPosition, text.length]),
+    truncation = _useMemo.truncation,
+    truncationOffset = _useMemo.truncationOffset;
+  var truncatedText = useMemo(function () {
+    var truncatedText = '';
+    if (!containerEl || !width) return truncatedText;
+    var params = {
+      fullText: text,
+      ellipsis: ellipsis,
+      container: containerEl,
+      availableWidth: width
+    };
+    var utils = measurementRenderAPI === 'canvas' ? new TruncationUtilsWithCanvas(params) : new TruncationUtilsWithDOM(params);
+    if (utils.checkIfTruncationIsNeeded() === false) {
+      truncatedText = text;
+    } else if (utils.checkSufficientEllipsisWidth(truncation) === false) {
+      truncatedText = '';
+    } else {
+      switch (truncation) {
+        case 'end':
+          truncatedText = utils.truncateEnd(truncationOffset);
+          break;
+        case 'start':
+          truncatedText = utils.truncateStart(truncationOffset);
+          break;
+        case 'startEnd':
+          if (truncationPosition == null) {
+            truncatedText = utils.truncateStartEndAtMiddle();
+          } else {
+            truncatedText = utils.truncateStartEndAtPosition(truncationPosition);
+          }
+          break;
+        case 'middle':
+          truncatedText = utils.truncateMiddle();
+          break;
+      }
+    }
+    if (measurementRenderAPI === 'dom') {
+      utils.cleanup();
+    }
+    return truncatedText;
+  }, [width, text, truncation, truncationOffset, truncationPosition, ellipsis, containerEl, measurementRenderAPI]);
+  var isTruncating = truncatedText !== text;
+  return ___EmotionJSX("div", _extends({
+    css: euiTextTruncateStyles.euiTextTruncate,
+    ref: refs,
+    title: isTruncating ? text : undefined
+  }, rest), isTruncating ? ___EmotionJSX(React.Fragment, null, ___EmotionJSX("span", {
+    css: euiTextTruncateStyles.truncatedText,
+    "aria-hidden": true,
+    "data-test-subj": "truncatedText"
+  }, children ? children(truncatedText) : truncatedText), ___EmotionJSX("span", {
+    css: euiTextTruncateStyles.fullText,
+    "data-test-subj": "fullText"
+  }, text)) : ___EmotionJSX("span", {
+    "data-test-subj": "fullText"
+  }, text));
+};
+EuiTextTruncateWithWidth.propTypes = {
+  width: PropTypes.number.isRequired,
+  containerRef: PropTypes.any
+};
+var EuiTextTruncateWithResizeObserver = function EuiTextTruncateWithResizeObserver(_ref3) {
+  var _onResize = _ref3.onResize,
+    props = _objectWithoutProperties(_ref3, _excluded3);
+  var _useState3 = useState(0),
+    _useState4 = _slicedToArray(_useState3, 2),
+    width = _useState4[0],
+    setWidth = _useState4[1];
+  var onResize = useCallback(function (_ref4) {
+    var width = _ref4.width;
+    setWidth(width);
+    _onResize === null || _onResize === void 0 ? void 0 : _onResize(width);
+  }, [_onResize]);
+  return ___EmotionJSX(EuiResizeObserver, {
+    onResize: onResize
+  }, function (ref) {
+    return ___EmotionJSX(EuiTextTruncateWithWidth, _extends({
+      width: width,
+      containerRef: ref
+    }, props));
+  });
+};

package/es/components/text_truncate/text_truncate.styles.js

@@ -0,0 +1,49 @@
+function _EMOTION_STRINGIFIED_CSS_ERROR__() { return "You have tried to stringify object returned from `css` function. It isn't supposed to be used directly (e.g. as value of the `className` prop), but rather handed to emotion so it can handle it (e.g. as value of `css` prop)."; }
+/*
+ * 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.
+ */
+
+import { css } from '@emotion/react';
+export var euiTextTruncateStyles = {
+  euiTextTruncate: process.env.NODE_ENV === "production" ? {
+    name: "7o5qnz-euiTextTruncate",
+    styles: "position:relative;overflow:hidden;white-space:nowrap;label:euiTextTruncate;"
+  } : {
+    name: "7o5qnz-euiTextTruncate",
+    styles: "position:relative;overflow:hidden;white-space:nowrap;label:euiTextTruncate;",
+    toString: _EMOTION_STRINGIFIED_CSS_ERROR__
+  },
+  /**
+   * The below CSS is a hack to get double clicking and selecting the *full* text
+   * instead of the truncated text (useful for copying/pasting, and mimics how
+   * `text-overflow: ellipsis` works).
+   *
+   * Real talk: I'm lowkey amazed it works and it wouldn't surprise me if we ran into
+   * cross-browser issues with this at some point. Hopefully CSS natively implements
+   * custom text truncation some day (https://github.com/w3c/csswg-drafts/issues/3937)
+   * and there'll be no need for the entire component at that point 🙏
+   */
+  // Makes the truncated text unselectable/un-clickable
+  truncatedText: process.env.NODE_ENV === "production" ? {
+    name: "1dore6v-truncatedText",
+    styles: "user-select:none;pointer-events:none;label:truncatedText;"
+  } : {
+    name: "1dore6v-truncatedText",
+    styles: "user-select:none;pointer-events:none;label:truncatedText;",
+    toString: _EMOTION_STRINGIFIED_CSS_ERROR__
+  },
+  // Positions the full text on top of the truncated text (so that clicking targets it)
+  // and gives it a color opacity of 0 so that it's not actually visible
+  fullText: process.env.NODE_ENV === "production" ? {
+    name: "1kxt4rj-fullText",
+    styles: "position:absolute;inset:0;overflow:hidden;color:rgba(0, 0, 0, 0);@supports (-webkit-hyphens: none){text-overflow:ellipsis;};label:fullText;"
+  } : {
+    name: "1kxt4rj-fullText",
+    styles: "position:absolute;inset:0;overflow:hidden;color:rgba(0, 0, 0, 0);@supports (-webkit-hyphens: none){text-overflow:ellipsis;};label:fullText;",
+    toString: _EMOTION_STRINGIFIED_CSS_ERROR__
+  }
+};