react-virtualized
Version:
React components for efficiently rendering large, scrollable lists and tabular data
346 lines (286 loc) • 12.8 kB
JavaScript
"use strict";
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
var _interopRequireWildcard = require("@babel/runtime/helpers/interopRequireWildcard");
Object.defineProperty(exports, "__esModule", {
value: true
});
exports["default"] = void 0;
var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
var _getPrototypeOf3 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
var _assertThisInitialized2 = _interopRequireDefault(require("@babel/runtime/helpers/assertThisInitialized"));
var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
var _Grid = _interopRequireWildcard(require("../Grid"));
var React = _interopRequireWildcard(require("react"));
var _clsx = _interopRequireDefault(require("clsx"));
var _types = require("./types");
var _propTypes = _interopRequireDefault(require("prop-types"));
var _class, _temp;
var List = (_temp = _class =
/*#__PURE__*/
function (_React$PureComponent) {
(0, _inherits2["default"])(List, _React$PureComponent);
function List() {
var _getPrototypeOf2;
var _this;
(0, _classCallCheck2["default"])(this, List);
for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
args[_key] = arguments[_key];
}
_this = (0, _possibleConstructorReturn2["default"])(this, (_getPrototypeOf2 = (0, _getPrototypeOf3["default"])(List)).call.apply(_getPrototypeOf2, [this].concat(args)));
(0, _defineProperty2["default"])((0, _assertThisInitialized2["default"])(_this), "Grid", void 0);
(0, _defineProperty2["default"])((0, _assertThisInitialized2["default"])(_this), "_cellRenderer", function (_ref) {
var parent = _ref.parent,
rowIndex = _ref.rowIndex,
style = _ref.style,
isScrolling = _ref.isScrolling,
isVisible = _ref.isVisible,
key = _ref.key;
var rowRenderer = _this.props.rowRenderer; // TRICKY The style object is sometimes cached by Grid.
// This prevents new style objects from bypassing shallowCompare().
// However as of React 16, style props are auto-frozen (at least in dev mode)
// Check to make sure we can still modify the style before proceeding.
// https://github.com/facebook/react/commit/977357765b44af8ff0cfea327866861073095c12#commitcomment-20648713
var widthDescriptor = Object.getOwnPropertyDescriptor(style, 'width');
if (widthDescriptor && widthDescriptor.writable) {
// By default, List cells should be 100% width.
// This prevents them from flowing under a scrollbar (if present).
style.width = '100%';
}
return rowRenderer({
index: rowIndex,
style: style,
isScrolling: isScrolling,
isVisible: isVisible,
key: key,
parent: parent
});
});
(0, _defineProperty2["default"])((0, _assertThisInitialized2["default"])(_this), "_setRef", function (ref) {
_this.Grid = ref;
});
(0, _defineProperty2["default"])((0, _assertThisInitialized2["default"])(_this), "_onScroll", function (_ref2) {
var clientHeight = _ref2.clientHeight,
scrollHeight = _ref2.scrollHeight,
scrollTop = _ref2.scrollTop;
var onScroll = _this.props.onScroll;
onScroll({
clientHeight: clientHeight,
scrollHeight: scrollHeight,
scrollTop: scrollTop
});
});
(0, _defineProperty2["default"])((0, _assertThisInitialized2["default"])(_this), "_onSectionRendered", function (_ref3) {
var rowOverscanStartIndex = _ref3.rowOverscanStartIndex,
rowOverscanStopIndex = _ref3.rowOverscanStopIndex,
rowStartIndex = _ref3.rowStartIndex,
rowStopIndex = _ref3.rowStopIndex;
var onRowsRendered = _this.props.onRowsRendered;
onRowsRendered({
overscanStartIndex: rowOverscanStartIndex,
overscanStopIndex: rowOverscanStopIndex,
startIndex: rowStartIndex,
stopIndex: rowStopIndex
});
});
return _this;
}
(0, _createClass2["default"])(List, [{
key: "forceUpdateGrid",
value: function forceUpdateGrid() {
if (this.Grid) {
this.Grid.forceUpdate();
}
}
/** See Grid#getOffsetForCell */
}, {
key: "getOffsetForRow",
value: function getOffsetForRow(_ref4) {
var alignment = _ref4.alignment,
index = _ref4.index;
if (this.Grid) {
var _this$Grid$getOffsetF = this.Grid.getOffsetForCell({
alignment: alignment,
rowIndex: index,
columnIndex: 0
}),
scrollTop = _this$Grid$getOffsetF.scrollTop;
return scrollTop;
}
return 0;
}
/** CellMeasurer compatibility */
}, {
key: "invalidateCellSizeAfterRender",
value: function invalidateCellSizeAfterRender(_ref5) {
var columnIndex = _ref5.columnIndex,
rowIndex = _ref5.rowIndex;
if (this.Grid) {
this.Grid.invalidateCellSizeAfterRender({
rowIndex: rowIndex,
columnIndex: columnIndex
});
}
}
/** See Grid#measureAllCells */
}, {
key: "measureAllRows",
value: function measureAllRows() {
if (this.Grid) {
this.Grid.measureAllCells();
}
}
/** CellMeasurer compatibility */
}, {
key: "recomputeGridSize",
value: function recomputeGridSize() {
var _ref6 = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {},
_ref6$columnIndex = _ref6.columnIndex,
columnIndex = _ref6$columnIndex === void 0 ? 0 : _ref6$columnIndex,
_ref6$rowIndex = _ref6.rowIndex,
rowIndex = _ref6$rowIndex === void 0 ? 0 : _ref6$rowIndex;
if (this.Grid) {
this.Grid.recomputeGridSize({
rowIndex: rowIndex,
columnIndex: columnIndex
});
}
}
/** See Grid#recomputeGridSize */
}, {
key: "recomputeRowHeights",
value: function recomputeRowHeights() {
var index = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0;
if (this.Grid) {
this.Grid.recomputeGridSize({
rowIndex: index,
columnIndex: 0
});
}
}
/** See Grid#scrollToPosition */
}, {
key: "scrollToPosition",
value: function scrollToPosition() {
var scrollTop = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0;
if (this.Grid) {
this.Grid.scrollToPosition({
scrollTop: scrollTop
});
}
}
/** See Grid#scrollToCell */
}, {
key: "scrollToRow",
value: function scrollToRow() {
var index = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 0;
if (this.Grid) {
this.Grid.scrollToCell({
columnIndex: 0,
rowIndex: index
});
}
}
}, {
key: "render",
value: function render() {
var _this$props = this.props,
className = _this$props.className,
noRowsRenderer = _this$props.noRowsRenderer,
scrollToIndex = _this$props.scrollToIndex,
width = _this$props.width;
var classNames = (0, _clsx["default"])('ReactVirtualized__List', className);
return React.createElement(_Grid["default"], (0, _extends2["default"])({}, this.props, {
autoContainerWidth: true,
cellRenderer: this._cellRenderer,
className: classNames,
columnWidth: width,
columnCount: 1,
noContentRenderer: noRowsRenderer,
onScroll: this._onScroll,
onSectionRendered: this._onSectionRendered,
ref: this._setRef,
scrollToRow: scrollToIndex
}));
}
}]);
return List;
}(React.PureComponent), (0, _defineProperty2["default"])(_class, "propTypes", process.env.NODE_ENV === 'production' ? null : {
"aria-label": _propTypes["default"].string,
/**
* Removes fixed height from the scrollingContainer so that the total height
* of rows can stretch the window. Intended for use with WindowScroller
*/
"autoHeight": _propTypes["default"].bool.isRequired,
/** Optional CSS class name */
"className": _propTypes["default"].string,
/**
* Used to estimate the total height of a List before all of its rows have actually been measured.
* The estimated total height is adjusted as rows are rendered.
*/
"estimatedRowSize": _propTypes["default"].number.isRequired,
/** Height constraint for list (determines how many actual rows are rendered) */
"height": _propTypes["default"].number.isRequired,
/** Optional renderer to be used in place of rows when rowCount is 0 */
"noRowsRenderer": function noRowsRenderer() {
return (typeof _Grid.bpfrpt_proptype_NoContentRenderer === "function" ? _Grid.bpfrpt_proptype_NoContentRenderer.isRequired ? _Grid.bpfrpt_proptype_NoContentRenderer.isRequired : _Grid.bpfrpt_proptype_NoContentRenderer : _propTypes["default"].shape(_Grid.bpfrpt_proptype_NoContentRenderer).isRequired).apply(this, arguments);
},
/** Callback invoked with information about the slice of rows that were just rendered. */
"onRowsRendered": _propTypes["default"].func.isRequired,
/**
* Callback invoked whenever the scroll offset changes within the inner scrollable region.
* This callback can be used to sync scrolling between lists, tables, or grids.
*/
"onScroll": _propTypes["default"].func.isRequired,
/** See Grid#overscanIndicesGetter */
"overscanIndicesGetter": function overscanIndicesGetter() {
return (typeof _Grid.bpfrpt_proptype_OverscanIndicesGetter === "function" ? _Grid.bpfrpt_proptype_OverscanIndicesGetter.isRequired ? _Grid.bpfrpt_proptype_OverscanIndicesGetter.isRequired : _Grid.bpfrpt_proptype_OverscanIndicesGetter : _propTypes["default"].shape(_Grid.bpfrpt_proptype_OverscanIndicesGetter).isRequired).apply(this, arguments);
},
/**
* Number of rows to render above/below the visible bounds of the list.
* These rows can help for smoother scrolling on touch devices.
*/
"overscanRowCount": _propTypes["default"].number.isRequired,
/** Either a fixed row height (number) or a function that returns the height of a row given its index. */
"rowHeight": function rowHeight() {
return (typeof _Grid.bpfrpt_proptype_CellSize === "function" ? _Grid.bpfrpt_proptype_CellSize.isRequired ? _Grid.bpfrpt_proptype_CellSize.isRequired : _Grid.bpfrpt_proptype_CellSize : _propTypes["default"].shape(_Grid.bpfrpt_proptype_CellSize).isRequired).apply(this, arguments);
},
/** Responsible for rendering a row given an index; ({ index: number }): node */
"rowRenderer": function rowRenderer() {
return (typeof _types.bpfrpt_proptype_RowRenderer === "function" ? _types.bpfrpt_proptype_RowRenderer.isRequired ? _types.bpfrpt_proptype_RowRenderer.isRequired : _types.bpfrpt_proptype_RowRenderer : _propTypes["default"].shape(_types.bpfrpt_proptype_RowRenderer).isRequired).apply(this, arguments);
},
/** Number of rows in list. */
"rowCount": _propTypes["default"].number.isRequired,
/** See Grid#scrollToAlignment */
"scrollToAlignment": function scrollToAlignment() {
return (typeof _Grid.bpfrpt_proptype_Alignment === "function" ? _Grid.bpfrpt_proptype_Alignment.isRequired ? _Grid.bpfrpt_proptype_Alignment.isRequired : _Grid.bpfrpt_proptype_Alignment : _propTypes["default"].shape(_Grid.bpfrpt_proptype_Alignment).isRequired).apply(this, arguments);
},
/** Row index to ensure visible (by forcefully scrolling if necessary) */
"scrollToIndex": _propTypes["default"].number.isRequired,
/** Vertical offset. */
"scrollTop": _propTypes["default"].number,
/** Optional inline style */
"style": _propTypes["default"].object.isRequired,
/** Tab index for focus */
"tabIndex": _propTypes["default"].number,
/** Width of list */
"width": _propTypes["default"].number.isRequired
}), _temp);
exports["default"] = List;
(0, _defineProperty2["default"])(List, "defaultProps", {
autoHeight: false,
estimatedRowSize: 30,
onScroll: function onScroll() {},
noRowsRenderer: function noRowsRenderer() {
return null;
},
onRowsRendered: function onRowsRendered() {},
overscanIndicesGetter: _Grid.accessibilityOverscanIndicesGetter,
overscanRowCount: 10,
scrollToAlignment: 'auto',
scrollToIndex: -1,
style: {}
});