|
1 | | -## Selection |
| 1 | +# Selection |
2 | 2 |
|
3 | 3 | There is a [PR](https://github.com/Autodesk/react-base-table/pull/39) to add selection feature, but I don't want to merge it with [good reasons](https://github.com/Autodesk/react-base-table/pull/39#pullrequestreview-241987600), so I'd like to share a recipe here for reference |
4 | 4 |
|
| 5 | +## Recipe |
| 6 | + |
| 7 | +```jsx |
| 8 | +const StyledTable = styled(BaseTable)` |
| 9 | + .row-selected { |
| 10 | + background-color: #e3e3e3; |
| 11 | + } |
| 12 | +`; |
| 13 | + |
| 14 | +class SelectionCell extends React.PureComponent { |
| 15 | + _handleChange = e => { |
| 16 | + const { rowData, rowIndex, column } = this.props; |
| 17 | + const { onChange } = column; |
| 18 | + |
| 19 | + onChange({ selected: e.target.checked, rowData, rowIndex }); |
| 20 | + }; |
| 21 | + |
| 22 | + render() { |
| 23 | + const { rowData, column } = this.props; |
| 24 | + const { selectedRowKeys, rowKey } = column; |
| 25 | + const checked = selectedRowKeys.includes(rowData[rowKey]); |
| 26 | + |
| 27 | + return <input type="checkbox" checked={checked} onChange={this._handleChange} />; |
| 28 | + } |
| 29 | +} |
| 30 | + |
| 31 | +class SelectableTable extends React.PureComponent { |
| 32 | + constructor(props) { |
| 33 | + super(props); |
| 34 | + |
| 35 | + const { selectedRowKeys, defaultSelectedRowKeys, expandedRowKeys, defaultExpandedRowKeys } = props; |
| 36 | + this.state = { |
| 37 | + selectedRowKeys: (selectedRowKeys !== undefined ? selectedRowKeys : defaultSelectedRowKeys) || [], |
| 38 | + expandedRowKeys: (expandedRowKeys !== undefined ? expandedRowKeys : defaultExpandedRowKeys) || [], |
| 39 | + }; |
| 40 | + } |
| 41 | + |
| 42 | + /** |
| 43 | + * Set `selectedRowKeys` manually. |
| 44 | + * This method is available only if `selectedRowKeys` is uncontrolled. |
| 45 | + * |
| 46 | + * @param {array} selectedRowKeys |
| 47 | + */ |
| 48 | + setSelectedRowKeys(selectedRowKeys) { |
| 49 | + // if `selectedRowKeys` is controlled |
| 50 | + if (this.props.selectedRowKeys !== undefined) return; |
| 51 | + |
| 52 | + this.setState({ |
| 53 | + selectedRowKeys: cloneArray(selectedRowKeys), |
| 54 | + }); |
| 55 | + } |
| 56 | + |
| 57 | + /** |
| 58 | + * See BaseTable#setExpandedRowKeys |
| 59 | + */ |
| 60 | + setExpandedRowKeys(expandedRowKeys) { |
| 61 | + // if `expandedRowKeys` is controlled |
| 62 | + if (this.props.expandedRowKeys !== undefined) return; |
| 63 | + |
| 64 | + this.setState({ |
| 65 | + expandedRowKeys: cloneArray(expandedRowKeys), |
| 66 | + }); |
| 67 | + } |
| 68 | + |
| 69 | + /* some other custom methods and proxy methods */ |
| 70 | + |
| 71 | + /** |
| 72 | + * Remove rowKeys from inner state manually, it's useful to purge dirty state after rows removed. |
| 73 | + * This method is available only if `selectedRowKeys` or `expandedRowKeys` is uncontrolled. |
| 74 | + * |
| 75 | + * @param {array} rowKeys |
| 76 | + */ |
| 77 | + removeRowKeysFromState(rowKeys) { |
| 78 | + if (!Array.isArray(rowKeys)) return; |
| 79 | + |
| 80 | + const state = {}; |
| 81 | + if (this.props.selectedRowKeys === undefined && this.state.selectedRowKeys.length > 0) { |
| 82 | + state.selectedRowKeys = this.state.selectedRowKeys.filter(key => !rowKeys.includes(key)); |
| 83 | + } |
| 84 | + if (this.props.expandedRowKeys === undefined && this.state.expandedRowKeys.length > 0) { |
| 85 | + state.expandedRowKeys = this.state.expandedRowKeys.filter(key => !rowKeys.includes(key)); |
| 86 | + } |
| 87 | + if (state.selectedRowKeys || state.expandedRowKeys) { |
| 88 | + this.setState(state); |
| 89 | + } |
| 90 | + } |
| 91 | + |
| 92 | + _handleSelectChange = ({ selected, rowData, rowIndex }) => { |
| 93 | + const selectedRowKeys = [...this.state.selectedRowKeys]; |
| 94 | + const key = rowData[this.props.rowKey]; |
| 95 | + |
| 96 | + if (selected) { |
| 97 | + if (!selectedRowKeys.includes(key)) selectedRowKeys.push(key); |
| 98 | + } else { |
| 99 | + const index = selectedRowKeys.indexOf(key); |
| 100 | + if (index > -1) { |
| 101 | + selectedRowKeys.splice(index, 1); |
| 102 | + } |
| 103 | + } |
| 104 | + |
| 105 | + // if `selectedRowKeys` is uncontrolled, update internal state |
| 106 | + if (this.props.selectedRowKeys === undefined) { |
| 107 | + this.setState({ selectedRowKeys }); |
| 108 | + } |
| 109 | + this.props.onRowSelect({ selected, rowData, rowIndex }); |
| 110 | + this.props.onSelectedRowsChange(selectedRowKeys); |
| 111 | + }; |
| 112 | + |
| 113 | + _rowClassName = ({ rowData, rowIndex }) => { |
| 114 | + const { rowClassName, rowKey } = this.props; |
| 115 | + const { selectedRowKeys } = this.state; |
| 116 | + |
| 117 | + const rowClass = rowClassName ? callOrReturn(rowClassName, { rowData, rowIndex }) : ''; |
| 118 | + const key = rowData[rowKey]; |
| 119 | + |
| 120 | + return [rowClass, selectedRowKeys.includes(key) && 'row-selected'].filter(Boolean).concat(' '); |
| 121 | + }; |
| 122 | + |
| 123 | + render() { |
| 124 | + const { columns, children, selectable, selectionColumnProps, ...rest } = this.props; |
| 125 | + const { selectedRowKeys } = this.state; |
| 126 | + |
| 127 | + // you'd better memoize this operation |
| 128 | + let _columns = columns || normalizeColumns(children); |
| 129 | + if (selectable) { |
| 130 | + const selectionColumn = { |
| 131 | + width: 40, |
| 132 | + flexShrink: 0, |
| 133 | + resizable: false, |
| 134 | + frozen: Column.FrozenDirection.LEFT, |
| 135 | + cellRenderer: SelectionCell, |
| 136 | + ...selectionColumnProps, |
| 137 | + key: '__selection__', |
| 138 | + rowKey: this.props.rowKey, |
| 139 | + selectedRowKeys: selectedRowKeys, |
| 140 | + onChange: this._handleSelectChange, |
| 141 | + }; |
| 142 | + _columns = [selectionColumn, ..._columns]; |
| 143 | + } |
| 144 | + |
| 145 | + return <StyledTable {...rest} columns={_columns} rowClassName={this._rowClassName} />; |
| 146 | + } |
| 147 | +} |
| 148 | + |
| 149 | +SelectableTable.defaultProps = { |
| 150 | + ...BaseTable.defaultProps, |
| 151 | + onRowSelect: noop, |
| 152 | + onSelectedRowsChange: noop, |
| 153 | +}; |
| 154 | +``` |
| 155 | + |
| 156 | +## Playground |
| 157 | + |
5 | 158 | ```jsx live editorHeight=400 |
6 | 159 | const StyledTable = styled(BaseTable)` |
7 | 160 | .row-selected { |
|
0 commit comments