@elastic/eui
Version:
Elastic UI Component Library
258 lines (246 loc) • 14.2 kB
JavaScript
;
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
var _typeof = require("@babel/runtime/helpers/typeof");
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.useScrollCellIntoView = exports.useScrollBars = exports.useScroll = void 0;
var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
var _react = _interopRequireWildcard(require("react"));
var _data_grid_cell_popover = require("../body/data_grid_cell_popover");
var _focus = require("./focus");
var _react2 = require("@emotion/react");
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; }
/*
* 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.
*/
/**
* The primary goal of this scroll logic is to ensure keyboard navigation works accessibly,
* but there are other scenarios where it applies (e.g. clicking partially-visible cells)
* or is useful for (e.g. manually scrolling to cell that is currently out of viewport
* while accounting for headers/footers/scrollbars)
*/
var useScroll = function useScroll(args) {
var _useScrollCellIntoVie = useScrollCellIntoView(args),
scrollCellIntoView = _useScrollCellIntoVie.scrollCellIntoView;
var _useContext = (0, _react.useContext)(_focus.DataGridFocusContext),
focusedCell = _useContext.focusedCell;
(0, _react.useEffect)(function () {
if (focusedCell) {
scrollCellIntoView({
rowIndex: focusedCell[1],
colIndex: focusedCell[0]
});
}
}, [focusedCell, scrollCellIntoView]);
var _useContext2 = (0, _react.useContext)(_data_grid_cell_popover.DataGridCellPopoverContext),
popoverIsOpen = _useContext2.popoverIsOpen,
cellLocation = _useContext2.cellLocation;
(0, _react.useEffect)(function () {
if (popoverIsOpen) {
scrollCellIntoView({
rowIndex: cellLocation.rowIndex,
colIndex: cellLocation.colIndex
});
}
}, [popoverIsOpen, cellLocation, scrollCellIntoView]);
return {
scrollCellIntoView: scrollCellIntoView
};
};
/**
* Ensures that the passed cell is always fully in view by using cell position
* checks and scroll adjustments/workarounds.
*/
exports.useScroll = useScroll;
var useScrollCellIntoView = function useScrollCellIntoView(_ref) {
var gridRef = _ref.gridRef,
outerGridRef = _ref.outerGridRef,
hasGridScrolling = _ref.hasGridScrolling,
headerRowHeight = _ref.headerRowHeight,
footerRowHeight = _ref.footerRowHeight,
visibleRowCount = _ref.visibleRowCount,
hasStickyFooter = _ref.hasStickyFooter;
var scrollCellIntoView = (0, _react.useCallback)(
/*#__PURE__*/
// Note: in order for this UX to work correctly with react-window's APIs,
// the `rowIndex` arg expected is actually our internal `visibleRowIndex`,
// not the `rowIndex` from the raw unsorted/unpaginated user data
function () {
var _ref2 = (0, _asyncToGenerator2.default)(function (_ref3) {
var rowIndex = _ref3.rowIndex,
colIndex = _ref3.colIndex;
return /*#__PURE__*/_regenerator.default.mark(function _callee() {
var _adjustedScrollLeft;
var getCell, cell, cellIsInView, _outerGridRef$current, scrollTop, scrollLeft, adjustedScrollTop, adjustedScrollLeft, cellRightPos, rightScrollBound, rightWidthOutOfView, cellLeftPos, leftScrollBound, leftWidthOutOfView, isStickyHeader, isStickyFooter, _adjustedScrollTop, parentRow, cellBottomPos, bottomScrollBound, bottomHeightOutOfView, cellTopPos, topScrollBound, topHeightOutOfView, _adjustedScrollLeft2, _adjustedScrollTop2;
return _regenerator.default.wrap(function _callee$(_context) {
while (1) switch (_context.prev = _context.next) {
case 0:
if (!(!gridRef.current || !outerGridRef.current)) {
_context.next = 2;
break;
}
return _context.abrupt("return");
case 2:
if (hasGridScrolling) {
_context.next = 4;
break;
}
return _context.abrupt("return");
case 4:
// Obtain the outermost wrapper of the current cell in view in order to
// get scroll position/height/width calculations and determine what level
// of scroll adjustment the cell needs
getCell = function getCell() {
return outerGridRef.current.querySelector("[data-gridcell-column-index=\"".concat(colIndex, "\"][data-gridcell-visible-row-index=\"").concat(rowIndex, "\"]"));
};
cell = getCell(); // If the cell is completely out of view, we need to use react-window's
// scrollToItem API to get it virtualized and rendered.
cellIsInView = !!getCell();
if (cellIsInView) {
_context.next = 12;
break;
}
gridRef.current.scrollToItem({
rowIndex: rowIndex,
columnIndex: colIndex
});
_context.next = 11;
return new Promise(requestAnimationFrame);
case 11:
// The cell does not immediately render - we need to wait an async tick
cell = getCell();
case 12:
if (cell) {
_context.next = 14;
break;
}
return _context.abrupt("return");
case 14:
// If for some reason we can't find a valid cell, short-circuit
// We now manually adjust scroll positioning around the cell to ensure it's
// fully in view on all sides. A couple of notes on this:
// 1. We're avoiding relying on react-window's scrollToItem for this because it also
// does not account for sticky items (see https://github.com/bvaughn/react-window/issues/586)
// 2. The current scroll position we're using as a base comes from either by
// `scrollToItem` or native .focus()'s automatic scroll behavior. This gets us
// halfway there, but doesn't guarantee the *full* cell in view, or account for
// sticky positioned rows or OS scrollbars, hence these workarounds
_outerGridRef$current = outerGridRef.current, scrollTop = _outerGridRef$current.scrollTop, scrollLeft = _outerGridRef$current.scrollLeft;
// Check if the cell's right side is outside the current scrolling bounds
cellRightPos = cell.offsetLeft + cell.offsetWidth;
rightScrollBound = scrollLeft + outerGridRef.current.clientWidth; // Note: We specifically want clientWidth and not offsetWidth here to account for scrollbars
rightWidthOutOfView = cellRightPos - rightScrollBound;
if (rightWidthOutOfView > 0) {
adjustedScrollLeft = scrollLeft + rightWidthOutOfView;
}
// Check if the cell's left side is outside the current scrolling bounds
cellLeftPos = cell.offsetLeft;
leftScrollBound = (_adjustedScrollLeft = adjustedScrollLeft) !== null && _adjustedScrollLeft !== void 0 ? _adjustedScrollLeft : scrollLeft;
leftWidthOutOfView = leftScrollBound - cellLeftPos;
if (leftWidthOutOfView > 0) {
// Note: This overrides the right side being out of bounds, as we want to prefer
// showing the top-left corner of items if a cell is larger than the grid container
adjustedScrollLeft = cellLeftPos;
}
// Skip top/bottom scroll adjustments for sticky headers & footers
// since they should always be in view vertically
isStickyHeader = rowIndex === -1;
isStickyFooter = hasStickyFooter && rowIndex === visibleRowCount;
if (!isStickyHeader && !isStickyFooter) {
parentRow = cell.parentNode; // Check if the cell's bottom side is outside the current scrolling bounds
cellBottomPos = parentRow.offsetTop + cell.offsetHeight;
bottomScrollBound = scrollTop + outerGridRef.current.clientHeight; // Note: We specifically want clientHeight and not offsetHeight here to account for scrollbars
if (hasStickyFooter) bottomScrollBound -= footerRowHeight; // Sticky footer is not always present
bottomHeightOutOfView = cellBottomPos - bottomScrollBound;
if (bottomHeightOutOfView > 0) {
adjustedScrollTop = scrollTop + bottomHeightOutOfView;
}
// Check if the cell's top side is outside the current scrolling bounds
cellTopPos = parentRow.offsetTop;
topScrollBound = (_adjustedScrollTop = adjustedScrollTop) !== null && _adjustedScrollTop !== void 0 ? _adjustedScrollTop : scrollTop + headerRowHeight; // Sticky header is always present
topHeightOutOfView = topScrollBound - cellTopPos;
if (topHeightOutOfView > 0) {
// Note: This overrides the bottom side being out of bounds, as we want to prefer
// showing the top-left corner of items if a cell is larger than the grid container
adjustedScrollTop = cellTopPos - headerRowHeight;
}
}
// Check for undefined specifically (because 0 is a valid scroll position)
// to avoid unnecessarily calling scrollTo or hijacking scroll
if (adjustedScrollTop !== undefined || adjustedScrollLeft !== undefined) {
gridRef.current.scrollTo({
scrollLeft: (_adjustedScrollLeft2 = adjustedScrollLeft) !== null && _adjustedScrollLeft2 !== void 0 ? _adjustedScrollLeft2 : scrollLeft,
scrollTop: (_adjustedScrollTop2 = adjustedScrollTop) !== null && _adjustedScrollTop2 !== void 0 ? _adjustedScrollTop2 : scrollTop
});
}
case 27:
case "end":
return _context.stop();
}
}, _callee);
})();
});
return function (_x) {
return _ref2.apply(this, arguments);
};
}(), [gridRef, outerGridRef, hasGridScrolling, headerRowHeight, footerRowHeight, visibleRowCount, hasStickyFooter]);
return {
scrollCellIntoView: scrollCellIntoView
};
};
/**
* Checks whether the current grid scrolls and/or has scrollbars
*/
exports.useScrollCellIntoView = useScrollCellIntoView;
var useScrollBars = function useScrollBars(outerGridRef) {
var borderStyle = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'all';
// https://stackoverflow.com/a/40568748/4294462
var scrollBarHeight = outerGridRef.current ? outerGridRef.current.offsetHeight - outerGridRef.current.clientHeight : 0;
var scrollBarWidth = outerGridRef.current ? outerGridRef.current.offsetWidth - outerGridRef.current.clientWidth : 0;
// https://stackoverflow.com/a/5038256
// Note that it is possible (MacOS) for a grid to scroll but not have scrollbar widths/heights
var hasHorizontalScroll = outerGridRef.current ? outerGridRef.current.scrollWidth > outerGridRef.current.clientWidth : false;
var hasVerticalScroll = outerGridRef.current ? outerGridRef.current.scrollHeight > outerGridRef.current.clientHeight : false;
// If the grid scrolls or has scrollbars, we add custom border overlays
// (since borders are normally set by cells) to ensure our grid body has
// ending borders regardless of scroll position
var scrollBorderOverlay = (0, _react.useMemo)(function () {
if (!hasHorizontalScroll && !hasVerticalScroll) {
return null; // Nothing to render if the grid doesn't scroll
}
if (borderStyle === 'none') {
return null; // Nothing to render if the grid doesn't use borders
}
return (0, _react2.jsx)("div", {
className: "euiDataGrid__scrollOverlay",
role: "presentation"
}, scrollBarHeight > 0 && (0, _react2.jsx)("div", {
className: "euiDataGrid__scrollBarOverlayBottom",
style: {
bottom: scrollBarHeight,
right: 0
}
}), scrollBarWidth > 0 && (0, _react2.jsx)("div", {
className: "euiDataGrid__scrollBarOverlayRight",
style: {
bottom: scrollBarHeight,
right: scrollBarWidth
}
}));
}, [hasHorizontalScroll, hasVerticalScroll, scrollBarHeight, scrollBarWidth, borderStyle]);
return {
scrollBarHeight: scrollBarHeight,
scrollBarWidth: scrollBarWidth,
hasVerticalScroll: hasVerticalScroll,
hasHorizontalScroll: hasHorizontalScroll,
scrollBorderOverlay: scrollBorderOverlay
};
};
exports.useScrollBars = useScrollBars;