@elastic/eui 116.2.0 → 116.3.0

package/optimize/lib/components/table/sticky_header/context.js

@@ -0,0 +1,41 @@
+"use strict";
+
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useEuiTableWithinStickyHeader = exports.EuiTableWithinStickyHeaderProvider = void 0;
+var _react = _interopRequireWildcard(require("react"));
+var _react2 = require("@emotion/react");
+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; }
+/*
+ * 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 EuiTableWithinStickyHeaderContext = /*#__PURE__*/(0, _react.createContext)(false);
+
+/**
+ * React context provider to detect whether a component is rendered
+ * inside <EuiTableStickyHeader> to prevent duplicated header cell renders.
+ * @internal
+ */
+var EuiTableWithinStickyHeaderProvider = exports.EuiTableWithinStickyHeaderProvider = function EuiTableWithinStickyHeaderProvider(_ref) {
+  var children = _ref.children;
+  return (0, _react2.jsx)(EuiTableWithinStickyHeaderContext.Provider, {
+    value: true
+  }, children);
+};
+
+/**
+ * Returns true if the component (usually the EuiTableHeaderCell or EuiTableHeaderCellCheckbox)
+ * is rendered inside EuiTableStickyHeader.
+ * @internal
+ */
+var useEuiTableWithinStickyHeader = exports.useEuiTableWithinStickyHeader = function useEuiTableWithinStickyHeader() {
+  return (0, _react.useContext)(EuiTableWithinStickyHeaderContext);
+};

package/optimize/lib/components/table/sticky_header/index.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "EuiTableStickyHeader", {
+  enumerable: true,
+  get: function get() {
+    return _sticky_header.EuiTableStickyHeader;
+  }
+});
+Object.defineProperty(exports, "useEuiTableWithinStickyHeader", {
+  enumerable: true,
+  get: function get() {
+    return _context.useEuiTableWithinStickyHeader;
+  }
+});
+var _sticky_header = require("./sticky_header");
+var _context = require("./context");

package/optimize/lib/components/table/sticky_header/sticky_header.js

@@ -0,0 +1,156 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.EuiTableStickyHeader = void 0;
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _react = _interopRequireWildcard(require("react"));
+var _provider = require("../store/provider");
+var _table_header = require("../table_header");
+var _context = require("./context");
+var _services = require("../../../services");
+var _table = require("../table.styles");
+var _sticky_header = require("./sticky_header.styles");
+var _global_styling = require("../../../global_styling");
+var _const = require("../const");
+var _react2 = require("@emotion/react");
+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; }
+/*
+ * 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.
+ */
+
+/**
+ * @internal
+ */
+
+var EuiTableStickyHeader = exports.EuiTableStickyHeader = function EuiTableStickyHeader(_ref) {
+  var tableRef = _ref.tableRef,
+    tableWrapperRef = _ref.tableWrapperRef,
+    compressed = _ref.compressed,
+    scrollableInline = _ref.scrollableInline,
+    isResponsive = _ref.isResponsive;
+  var store = (0, _provider.useEuiTableColumnDataStore)();
+  var columnElements = (0, _react.useRef)(new Map());
+  var stickyTableWrapperRef = (0, _react.useRef)(null);
+  var stickyTableRef = (0, _react.useRef)(null);
+  var _useState = (0, _react.useState)(function () {
+      return Array.from(store.getColumns().entries());
+    }),
+    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+    columns = _useState2[0],
+    setColumns = _useState2[1];
+  var originalStyles = (0, _services.useEuiMemoizedStyles)(_table.euiTableStyles);
+  var styles = (0, _services.useEuiMemoizedStyles)(_sticky_header.euiTableStickyHeaderStyles);
+
+  /**
+   * Get a callback ref to handle the column element ref
+   */
+  var getColumnRef = (0, _react.useCallback)(function (id) {
+    return function (element) {
+      if (element) {
+        columnElements.current.set(id, element);
+      } else {
+        columnElements.current.delete(id);
+      }
+    };
+  }, []);
+  (0, _react.useEffect)(function () {
+    var unsubscribe = store.subscribe(function (columns) {
+      setColumns(Array.from(columns.entries()));
+    });
+    var unsubscribeColumnWidths = store.subscribeToColumnWidths(function (columns) {
+      columns.forEach(function (width, name) {
+        var element = columnElements.current.get(name);
+        if (element) {
+          element.style.width = "".concat(width, "px");
+        }
+      });
+    });
+    return function () {
+      unsubscribe();
+      unsubscribeColumnWidths();
+    };
+  }, [store]);
+
+  // When columns change, apply column widths after render
+  (0, _react.useLayoutEffect)(function () {
+    store.getColumnWidths().forEach(function (width, name) {
+      var element = columnElements.current.get(name);
+      if (element) {
+        element.style.width = "".concat(width, "px");
+      }
+    });
+  }, [store, columns]);
+  (0, _react.useEffect)(function () {
+    if (!scrollableInline || !tableWrapperRef.current || !stickyTableRef.current || !tableRef.current) {
+      return;
+    }
+    var tableWrapper = tableWrapperRef.current;
+    var handleScroll = function handleScroll() {
+      if (stickyTableWrapperRef.current) {
+        stickyTableWrapperRef.current.scrollLeft = tableWrapper.scrollLeft;
+      }
+    };
+    var handleResize = function handleResize(entries) {
+      var element = entries[0].target;
+      if (!element) {
+        return;
+      }
+      if (stickyTableRef.current) {
+        stickyTableRef.current.style.minWidth = "".concat(element.clientWidth, "px");
+      }
+    };
+
+    // Initial width sync
+    stickyTableRef.current.style.minWidth = "".concat(tableRef.current.getBoundingClientRect().width, "px");
+
+    // Use ResizeObserver to keep table width in sync
+    var resizeObserver = new ResizeObserver(handleResize);
+    resizeObserver.observe(tableRef.current);
+    tableWrapper.addEventListener('scroll', handleScroll, {
+      passive: true
+    });
+    return function () {
+      tableWrapper.removeEventListener('scroll', handleScroll);
+      resizeObserver.disconnect();
+    };
+  }, [scrollableInline, tableRef, tableWrapperRef]);
+  var tableStyles = [originalStyles.euiTable, scrollableInline && originalStyles.euiTableScrollableInline, (!compressed || isResponsive) && originalStyles.uncompressed, compressed && !isResponsive && originalStyles.compressed,
+  // Forced fixed layout since all column widths come synced from the main table
+  originalStyles.layout.fixed, originalStyles.hasBackground, styles.table];
+  if (isResponsive) {
+    return null;
+  }
+  return (0, _react2.jsx)(_context.EuiTableWithinStickyHeaderProvider, null, (0, _react2.jsx)("div", {
+    css: styles.wrapper,
+    "aria-hidden": "true"
+  }, (0, _react2.jsx)("div", {
+    css: [
+    // This CSS container is needed to feed `<EuiTableHeaderCell>`
+    // with `sticky` prop set the necessary scroll state
+    (0, _global_styling.euiContainerCSS)('normal', _const.EUI_TABLE_CSS_CONTAINER_NAME, true), styles.innerWrapper, ";label:EuiTableStickyHeader;"],
+    ref: stickyTableWrapperRef
+  }, (0, _react2.jsx)("table", {
+    css: tableStyles,
+    ref: stickyTableRef
+  }, (0, _react2.jsx)(_table_header.EuiTableHeader, {
+    css: styles.header
+  }, columns.map(function (_ref2, index) {
+    var _data$renderHeaderCel, _data$renderHeaderCel2;
+    var _ref3 = (0, _slicedToArray2.default)(_ref2, 2),
+      name = _ref3[0],
+      data = _ref3[1];
+    return (_data$renderHeaderCel = (_data$renderHeaderCel2 = data.renderHeaderCellRef).current) === null || _data$renderHeaderCel === void 0 ? void 0 : _data$renderHeaderCel.call(_data$renderHeaderCel2, {
+      ref: getColumnRef(name),
+      key: "".concat(name, "-").concat(index)
+    });
+  }))))));
+};

package/optimize/lib/components/table/sticky_header/sticky_header.styles.js

@@ -0,0 +1,47 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.euiTableStickyHeaderStyles = void 0;
+var _react = require("@emotion/react");
+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.
+ */
+var _ref = process.env.NODE_ENV === "production" ? {
+  name: "1uk19xy-table",
+  styles: "pointer-events:auto;label:table;"
+} : {
+  name: "1uk19xy-table",
+  styles: "pointer-events:auto;label:table;",
+  toString: _EMOTION_STRINGIFIED_CSS_ERROR__
+};
+var _ref2 = process.env.NODE_ENV === "production" ? {
+  name: "15dchac-innerWrapper",
+  styles: "overflow-inline:hidden;label:innerWrapper;"
+} : {
+  name: "15dchac-innerWrapper",
+  styles: "overflow-inline:hidden;label:innerWrapper;",
+  toString: _EMOTION_STRINGIFIED_CSS_ERROR__
+};
+var _ref3 = process.env.NODE_ENV === "production" ? {
+  name: "4w3rcu-wrapper",
+  styles: "position:sticky;inset-block-start:var(--euiTableStickyHeaderOffsetTop, 0);z-index:var(--euiTableStickyHeaderZIndex, 1);block-size:0;overflow-block:visible;label:wrapper;"
+} : {
+  name: "4w3rcu-wrapper",
+  styles: "position:sticky;inset-block-start:var(--euiTableStickyHeaderOffsetTop, 0);z-index:var(--euiTableStickyHeaderZIndex, 1);block-size:0;overflow-block:visible;label:wrapper;",
+  toString: _EMOTION_STRINGIFIED_CSS_ERROR__
+};
+var euiTableStickyHeaderStyles = exports.euiTableStickyHeaderStyles = function euiTableStickyHeaderStyles(_ref4) {
+  var euiTheme = _ref4.euiTheme;
+  return {
+    wrapper: _ref3,
+    innerWrapper: _ref2,
+    table: _ref,
+    header: /*#__PURE__*/(0, _react.css)("th::after{content:'';display:block;inline-size:100%;block-size:", euiTheme.border.width.thin, ";background-color:", euiTheme.border.color, ";};label:header;")
+  };
+};

package/optimize/lib/components/table/store/provider.js

@@ -0,0 +1,46 @@
+"use strict";
+
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useEuiTableColumnDataStore = exports.EuiTableStoreProvider = void 0;
+var _react = _interopRequireWildcard(require("react"));
+var _store = require("./store");
+var _react2 = require("@emotion/react");
+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; }
+/*
+ * 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 EuiTableStoreContext = /*#__PURE__*/(0, _react.createContext)(null);
+
+/**
+ * @internal
+ */
+var EuiTableStoreProvider = exports.EuiTableStoreProvider = function EuiTableStoreProvider(_ref) {
+  var children = _ref.children;
+  var store = (0, _react.useRef)(null);
+  if (!store.current) {
+    store.current = (0, _store.createEuiTableStore)();
+  }
+  return (0, _react2.jsx)(EuiTableStoreContext.Provider, {
+    value: store.current
+  }, children);
+};
+
+/**
+ * @internal
+ */
+var useEuiTableColumnDataStore = exports.useEuiTableColumnDataStore = function useEuiTableColumnDataStore() {
+  var store = (0, _react.useContext)(EuiTableStoreContext);
+  if (!store) {
+    throw new Error('[useEuiTableColumnDataStore] Store context not found. This hook must be used within EuiTable!');
+  }
+  return store;
+};

package/optimize/lib/components/table/store/store.js

@@ -0,0 +1,87 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createEuiTableStore = void 0;
+var _publisher = require("../../../utils/publisher");
+/*
+ * 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.
+ */
+
+/**
+ * @internal
+ */
+
+/**
+ * @internal
+ */
+
+/**
+ * EuiTable store that helps with column and width synchronization between
+ * the original table and the "virtual" sticky header table.
+ *
+ * This store is currently only used for these synchronization purposes, but
+ * that may extend as we implement resizable columns.
+ * If that's not implemented by the time per-axis `position: sticky`
+ * is supported in all browsers natively, this can be removed.
+ * @internal
+ */
+
+var createEuiTableStore = exports.createEuiTableStore = function createEuiTableStore() {
+  var columns = new Map();
+  var columnsPublisher = (0, _publisher.createPublisher)();
+  var columnWidths = new Map();
+  var columnWidthsPublisher = (0, _publisher.createPublisher)();
+  var registerColumn = function registerColumn(id, data) {
+    var _data$currentWidth;
+    if (columns.has(id)) {
+      throw new Error("[EuiTableStore] Column '".concat(id, "' already registered"));
+    }
+    columns.set(id, data);
+    // Initialize column in the columnWidths map to keep both maps in sync
+    columnWidths.set(id, (_data$currentWidth = data.currentWidth) !== null && _data$currentWidth !== void 0 ? _data$currentWidth : 0);
+    columnsPublisher.notify(columns);
+    return function () {
+      columns.delete(id);
+      columnWidths.delete(id);
+      columnsPublisher.notify(columns);
+    };
+  };
+  var updateColumn = function updateColumn(id, data) {
+    var currentData = columns.get(id);
+    if (!currentData) {
+      throw new Error("[EuiTableStore] Column '".concat(id, "' not found"));
+    }
+    columns.set(id, data);
+    columnsPublisher.notify(columns);
+  };
+  var updateColumnWidth = function updateColumnWidth(id, width) {
+    var currentWidth = columnWidths.get(id);
+    if (currentWidth === undefined) {
+      throw new Error("[EuiTableStore] No width stored for column '".concat(id, "'"));
+    }
+    if (currentWidth === width) {
+      return;
+    }
+    columnWidths.set(id, width);
+    columnWidthsPublisher.notify(columnWidths);
+  };
+  return {
+    registerColumn: registerColumn,
+    updateColumn: updateColumn,
+    updateColumnWidth: updateColumnWidth,
+    subscribe: columnsPublisher.subscribe,
+    subscribeToColumnWidths: columnWidthsPublisher.subscribe,
+    getColumns: function getColumns() {
+      return columns;
+    },
+    getColumnWidths: function getColumnWidths() {
+      return columnWidths;
+    }
+  };
+};

package/optimize/lib/components/table/table.js

@@ -18,8 +18,10 @@ var _component_defaults = require("../provider/component_defaults");
 var _global_styling = require("../../global_styling");
 var _const = require("./const");
 var _sticky_scrollbar = require("./sticky_scrollbar");
+var _sticky_header = require("./sticky_header/sticky_header");
+var _provider = require("./store/provider");
 var _react2 = require("@emotion/react");
-var _excluded = ["children", "className", "compressed", "tableLayout", "hasBackground", "responsiveBreakpoint", "scrollableInline", "stickyScrollbar"];
+var _excluded = ["children", "className", "compressed", "tableLayout", "hasBackground", "responsiveBreakpoint", "scrollableInline", "stickyScrollbar", "stickyHeader"];
 /*
  * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
  * or more contributor license agreements. Licensed under the Elastic License
@@ -53,20 +55,30 @@ var EuiTable = exports.EuiTable = function EuiTable(originalProps) {
     scrollableInline = _usePropsWithComponen4 === void 0 ? false : _usePropsWithComponen4,
     _usePropsWithComponen5 = _usePropsWithComponen.stickyScrollbar,
     stickyScrollbar = _usePropsWithComponen5 === void 0 ? false : _usePropsWithComponen5,
+    _usePropsWithComponen6 = _usePropsWithComponen.stickyHeader,
+    stickyHeader = _usePropsWithComponen6 === void 0 ? false : _usePropsWithComponen6,
     rest = (0, _objectWithoutProperties2.default)(_usePropsWithComponen, _excluded);
   var tableWrapperRef = (0, _react.useRef)(null);
+  var tableRef = (0, _react.useRef)(null);
   var isResponsive = (0, _responsive_context.useIsEuiTableResponsive)(responsiveBreakpoint);
   var classes = (0, _classnames.default)('euiTable', className);
   var styles = (0, _services.useEuiMemoizedStyles)(_table.euiTableStyles);
   var tableStyles = [styles.euiTable, scrollableInline && styles.euiTableScrollableInline, styles.layout[tableLayout], (!compressed || isResponsive) && styles.uncompressed, compressed && !isResponsive && styles.compressed, hasBackground && styles.hasBackground, isResponsive ? styles.mobile : styles.desktop];
   var cssStyles = [(0, _global_styling.euiContainerCSS)('normal', _const.EUI_TABLE_CSS_CONTAINER_NAME, true), scrollableInline && styles.scrollableWrapper];
-  return (0, _react2.jsx)(_react.default.Fragment, null, (0, _react2.jsx)("div", {
+  return (0, _react2.jsx)(_provider.EuiTableStoreProvider, null, stickyHeader && (0, _react2.jsx)(_sticky_header.EuiTableStickyHeader, {
+    scrollableInline: scrollableInline,
+    tableRef: tableRef,
+    tableWrapperRef: tableWrapperRef,
+    compressed: compressed,
+    isResponsive: isResponsive
+  }), (0, _react2.jsx)("div", {
     css: cssStyles,
     ref: tableWrapperRef
   }, (0, _react2.jsx)("table", (0, _extends2.default)({
     tabIndex: -1,
     css: tableStyles,
-    className: classes
+    className: classes,
+    ref: tableRef
   }, rest), (0, _react2.jsx)(_responsive_context.EuiTableIsResponsiveContext.Provider, {
     value: isResponsive
   }, (0, _react2.jsx)(_table_context.EuiTableVariantContext.Provider, {

package/optimize/lib/components/table/table.styles.js

@@ -42,11 +42,11 @@ var euiTableVariables = exports.euiTableVariables = function euiTableVariables(_
   };
 };
 var _ref = process.env.NODE_ENV === "production" ? {
-  name: "mqw298-scrollableWrapper",
-  styles: "overflow-inline:auto;label:scrollableWrapper;"
+  name: "l8gzfy-scrollableWrapper",
+  styles: "overflow-inline:auto;overscroll-behavior-inline:none;label:scrollableWrapper;"
 } : {
-  name: "mqw298-scrollableWrapper",
-  styles: "overflow-inline:auto;label:scrollableWrapper;",
+  name: "l8gzfy-scrollableWrapper",
+  styles: "overflow-inline:auto;overscroll-behavior-inline:none;label:scrollableWrapper;",
   toString: _EMOTION_STRINGIFIED_CSS_ERROR__
 };
 var _ref2 = process.env.NODE_ENV === "production" ? {