fixed-data-table
Version:
A React table component designed to allow presenting thousands of rows of data.
178 lines (159 loc) • 6.03 kB
JavaScript
/**
* Copyright (c) 2015, Facebook, Inc.
* All rights reserved.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree. An additional grant
* of patent rights can be found in the PATENTS file in the same directory.
*
* @providesModule FixedDataTableColumnNew.react
* @typechecks
*/
'use strict';
var React = require('./React');
var createReactClass = require('create-react-class');
var PropTypes = require('prop-types');
/**
* Component that defines the attributes of table column.
*/
var FixedDataTableColumn = createReactClass({
statics: {
__TableColumn__: true
},
propTypes: {
/**
* The horizontal alignment of the table cell content.
*/
align: PropTypes.oneOf(['left', 'center', 'right']),
/**
* Controls if the column is fixed when scrolling in the X axis.
*/
fixed: PropTypes.bool,
/**
* The header cell for this column.
* This can either be a string a React element, or a function that generates
* a React Element. Passing in a string will render a default header cell
* with that string. By default, the React element passed in can expect to
* receive the following props:
*
* ```
* props: {
* columnKey: string // (of the column, if given)
* height: number // (supplied from the Table or rowHeightGetter)
* width: number // (supplied from the Column)
* }
* ```
*
* Because you are passing in your own React element, you can feel free to
* pass in whatever props you may want or need.
*
* If you pass in a function, you will receive the same props object as the
* first argument.
*/
header: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
/**
* This is the body cell that will be cloned for this column.
* This can either be a string a React element, or a function that generates
* a React Element. Passing in a string will render a default header cell
* with that string. By default, the React element passed in can expect to
* receive the following props:
*
* ```
* props: {
* rowIndex; number // (the row index of the cell)
* columnKey: string // (of the column, if given)
* height: number // (supplied from the Table or rowHeightGetter)
* width: number // (supplied from the Column)
* }
* ```
*
* Because you are passing in your own React element, you can feel free to
* pass in whatever props you may want or need.
*
* If you pass in a function, you will receive the same props object as the
* first argument.
*/
cell: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
/**
* This is the footer cell for this column.
* This can either be a string a React element, or a function that generates
* a React Element. Passing in a string will render a default header cell
* with that string. By default, the React element passed in can expect to
* receive the following props:
*
* ```
* props: {
* columnKey: string // (of the column, if given)
* height: number // (supplied from the Table or rowHeightGetter)
* width: number // (supplied from the Column)
* }
* ```
*
* Because you are passing in your own React element, you can feel free to
* pass in whatever props you may want or need.
*
* If you pass in a function, you will receive the same props object as the
* first argument.
*/
footer: PropTypes.oneOfType([PropTypes.node, PropTypes.func]),
/**
* This is used to uniquely identify the column, and is not required unless
* you a resizing columns. This will be the key given in the
* `onColumnResizeEndCallback` on the Table.
*/
columnKey: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
/**
* The pixel width of the column.
*/
width: PropTypes.number.isRequired,
/**
* If this is a resizable column this is its minimum pixel width.
*/
minWidth: PropTypes.number,
/**
* If this is a resizable column this is its maximum pixel width.
*/
maxWidth: PropTypes.number,
/**
* The grow factor relative to other columns. Same as the flex-grow API
* from http://www.w3.org/TR/css3-flexbox/. Basically, take any available
* extra width and distribute it proportionally according to all columns'
* flexGrow values. Defaults to zero (no-flexing).
*/
flexGrow: PropTypes.number,
/**
* Whether the column can be resized with the
* FixedDataTableColumnResizeHandle. Please note that if a column
* has a flex grow, once you resize the column this will be set to 0.
*
* This property only provides the UI for the column resizing. If this
* is set to true, you will need to set the onColumnResizeEndCallback table
* property and render your columns appropriately.
*/
isResizable: PropTypes.bool,
/**
* Whether cells in this column can be removed from document when outside
* of viewport as a result of horizontal scrolling.
* Setting this property to true allows the table to not render cells in
* particular column that are outside of viewport for visible rows. This
* allows to create table with many columns and not have vertical scrolling
* performance drop.
* Setting the property to false will keep previous behaviour and keep
* cell rendered if the row it belongs to is visible.
*/
allowCellsRecycling: PropTypes.bool
},
getDefaultProps: function getDefaultProps() /*object*/{
return {
allowCellsRecycling: false,
fixed: false
};
},
render: function render() {
if (process.env.NODE_ENV !== 'production') {
throw new Error('Component <FixedDataTableColumn /> should never render');
}
return null;
}
});
module.exports = FixedDataTableColumn;