import React, { PureComponent } from 'react'; import PropTypes from 'prop-types'; import Sheet from './Sheet'; import Row from './Row'; import Cell from './Cell'; import DataCell from './DataCell'; import DataEditor from './DataEditor'; import ValueViewer from './ValueViewer'; import { TAB_KEY, ENTER_KEY, DELETE_KEY, ESCAPE_KEY, BACKSPACE_KEY, LEFT_KEY, UP_KEY, DOWN_KEY, RIGHT_KEY, } from './keys'; const isEmpty = obj => Object.keys(obj).length === 0; const range = (start, end) => { const array = []; const inc = end - start > 0; for (let i = start; inc ? i <= end : i >= end; inc ? i++ : i--) { inc ? array.push(i) : array.unshift(i); } return array; }; const defaultParsePaste = str => { return str.split(/\r\n|\n|\r/).map(row => row.split('\t')); }; export default class DataSheet extends PureComponent { constructor(props) { super(props); this.onMouseDown = this.onMouseDown.bind(this); this.onMouseUp = this.onMouseUp.bind(this); this.onMouseOver = this.onMouseOver.bind(this); this.onDoubleClick = this.onDoubleClick.bind(this); this.onContextMenu = this.onContextMenu.bind(this); this.handleNavigate = this.handleNavigate.bind(this); this.handleKey = this.handleKey.bind(this).bind(this); this.handleCut = this.handleCut.bind(this); this.handleCopy = this.handleCopy.bind(this); this.handlePaste = this.handlePaste.bind(this); this.pageClick = this.pageClick.bind(this); this.onChange = this.onChange.bind(this); this.onRevert = this.onRevert.bind(this); this.isSelected = this.isSelected.bind(this); this.isEditing = this.isEditing.bind(this); this.isClearing = this.isClearing.bind(this); this.handleComponentKey = this.handleComponentKey.bind(this); this.handleKeyboardCellMovement = this.handleKeyboardCellMovement.bind(this); this.defaultState = { start: {}, end: {}, selecting: false, forceEdit: false, editing: {}, clear: {}, }; this.state = this.defaultState; this.removeAllListeners = this.removeAllListeners.bind(this); this.handleIEClipboardEvents = this.handleIEClipboardEvents.bind(this); } removeAllListeners() { document.removeEventListener('mousedown', this.pageClick); document.removeEventListener('mouseup', this.onMouseUp); document.removeEventListener('cut', this.handleCut); document.removeEventListener('copy', this.handleCopy); document.removeEventListener('paste', this.handlePaste); document.removeEventListener('keydown', this.handleIEClipboardEvents); } componentDidMount() { // Add listener scoped to the DataSheet that catches otherwise unhandled // keyboard events when displaying components this.dgDom && this.dgDom.addEventListener('keydown', this.handleComponentKey); } componentWillUnmount() { this.dgDom && this.dgDom.removeEventListener('keydown', this.handleComponentKey); this.removeAllListeners(); } isSelectionControlled() { return 'selected' in this.props; } getState() { let state = this.state; if (this.isSelectionControlled()) { let { start, end } = this.props.selected || {}; start = start || this.defaultState.start; end = end || this.defaultState.end; state = { ...state, start, end }; } return state; } _setState(state) { const { editModeChanged } = this.props; if (editModeChanged && state.editing) { const wasEditing = !isEmpty(this.state.editing); const wilBeEditing = !isEmpty(state.editing); if (wasEditing != wilBeEditing) { editModeChanged(wilBeEditing); } } if (this.isSelectionControlled() && ('start' in state || 'end' in state)) { let { start, end, ...rest } = state; let { selected, onSelect } = this.props; selected = selected || {}; if (!start) { start = 'start' in selected ? selected.start : this.defaultState.start; } if (!end) { end = 'end' in selected ? selected.end : this.defaultState.end; } onSelect && onSelect({ start, end }); this.setState(rest); } else { this.setState(state); } } pageClick(e) { if (this.props.disablePageClick) return; const element = this.dgDom; if (!element.contains(e.target)) { this.setState(this.defaultState); this.removeAllListeners(); } } handleCut(e) { if (isEmpty(this.state.editing)) { e.preventDefault(); this.handleCopy(e); const { start, end } = this.getState(); this.clearSelectedCells(start, end); } } handleIEClipboardEvents(e) { if (e.ctrlKey) { if (e.keyCode === 67) { // C - copy this.handleCopy(e); } else if (e.keyCode === 88) { // X - cut this.handleCut(e); } else if (e.keyCode === 86 || e.which === 86) { // P - patse this.handlePaste(e); } } } handleCopy(e) { if (isEmpty(this.state.editing)) { e.preventDefault(); const { dataRenderer, valueRenderer, data } = this.props; const { start, end } = this.getState(); if (this.props.handleCopy) { this.props.handleCopy({ event: e, dataRenderer, valueRenderer, data, start, end, range, }); } else { const text = range(start.i, end.i) .map(i => range(start.j, end.j) .map(j => { const cell = data[i][j]; const value = dataRenderer ? dataRenderer(cell, i, j) : null; if ( value === '' || value === null || typeof value === 'undefined' ) { return valueRenderer(cell, i, j); } return value; }) .join('\t'), ) .join('\n'); if (window.clipboardData && window.clipboardData.setData) { window.clipboardData.setData('Text', text); } else { e.clipboardData.setData('text/plain', text); } } } } handlePaste(e) { if (isEmpty(this.state.editing)) { let { start, end } = this.getState(); start = { i: Math.min(start.i, end.i), j: Math.min(start.j, end.j) }; end = { i: Math.max(start.i, end.i), j: Math.max(start.j, end.j) }; const parse = this.props.parsePaste || defaultParsePaste; const changes = []; let pasteData = []; if (window.clipboardData && window.clipboardData.getData) { // IE pasteData = parse(window.clipboardData.getData('Text')); } else if (e.clipboardData && e.clipboardData.getData) { pasteData = parse(e.clipboardData.getData('text/plain')); } // in order of preference const { data, onCellsChanged, onPaste, onChange } = this.props; if (onCellsChanged) { const additions = []; pasteData.forEach((row, i) => { row.forEach((value, j) => { end = { i: start.i + i, j: start.j + j }; const cell = data[end.i] && data[end.i][end.j]; if (!cell) { additions.push({ row: end.i, col: end.j, value }); } else if (!cell.readOnly) { changes.push({ cell, row: end.i, col: end.j, value }); } }); }); if (additions.length) { onCellsChanged(changes, additions); } else { onCellsChanged(changes); } } else if (onPaste) { pasteData.forEach((row, i) => { const rowData = []; row.forEach((pastedData, j) => { end = { i: start.i + i, j: start.j + j }; const cell = data[end.i] && data[end.i][end.j]; rowData.push({ cell: cell, data: pastedData }); }); changes.push(rowData); }); onPaste(changes); } else if (onChange) { pasteData.forEach((row, i) => { row.forEach((value, j) => { end = { i: start.i + i, j: start.j + j }; const cell = data[end.i] && data[end.i][end.j]; if (cell && !cell.readOnly) { onChange(cell, end.i, end.j, value); } }); }); } this._setState({ end }); } } handleKeyboardCellMovement(e, commit = false) { const { start, editing } = this.getState(); const { data } = this.props; const isEditing = editing && !isEmpty(editing); const currentCell = data[start.i] && data[start.i][start.j]; if (isEditing && !commit) { return false; } const hasComponent = currentCell && currentCell.component; const keyCode = e.which || e.keyCode; if (hasComponent && isEditing) { e.preventDefault(); return; } if (keyCode === TAB_KEY) { this.handleNavigate(e, { i: 0, j: e.shiftKey ? -1 : 1 }, true); } else if (keyCode === RIGHT_KEY) { this.handleNavigate(e, { i: 0, j: 1 }); } else if (keyCode === LEFT_KEY) { this.handleNavigate(e, { i: 0, j: -1 }); } else if (keyCode === UP_KEY) { this.handleNavigate(e, { i: -1, j: 0 }); } else if (keyCode === DOWN_KEY) { this.handleNavigate(e, { i: 1, j: 0 }); } else if (commit && keyCode === ENTER_KEY) { this.handleNavigate(e, { i: e.shiftKey ? -1 : 1, j: 0 }); } } handleKey(e) { if (e.isPropagationStopped && e.isPropagationStopped()) { return; } const keyCode = e.which || e.keyCode; const { start, end, editing } = this.getState(); const isEditing = editing && !isEmpty(editing); const noCellsSelected = !start || isEmpty(start); const ctrlKeyPressed = e.ctrlKey || e.metaKey; const deleteKeysPressed = keyCode === DELETE_KEY || keyCode === BACKSPACE_KEY; const enterKeyPressed = keyCode === ENTER_KEY; const numbersPressed = keyCode >= 48 && keyCode <= 57; const lettersPressed = keyCode >= 65 && keyCode <= 90; const latin1Supplement = keyCode >= 160 && keyCode <= 255; const numPadKeysPressed = keyCode >= 96 && keyCode <= 105; const currentCell = !noCellsSelected && this.props.data[start.i][start.j]; const equationKeysPressed = [ 187 /* equal */, 189 /* substract */, 190 /* period */, 107 /* add */, 109 /* decimal point */, 110, ].indexOf(keyCode) > -1; if (noCellsSelected || ctrlKeyPressed) { return true; } if (!isEditing) { this.handleKeyboardCellMovement(e); if (deleteKeysPressed) { e.preventDefault(); this.clearSelectedCells(start, end); } else if (currentCell && !currentCell.readOnly) { if (enterKeyPressed) { this._setState({ editing: start, clear: {}, forceEdit: true }); e.preventDefault(); } else if ( numbersPressed || numPadKeysPressed || lettersPressed || latin1Supplement || equationKeysPressed ) { // empty out cell if user starts typing without pressing enter this._setState({ editing: start, clear: start, forceEdit: false }); } } } } getSelectedCells(data, start, end) { let selected = []; range(start.i, end.i).map(row => { range(start.j, end.j).map(col => { if (data[row] && data[row][col]) { selected.push({ cell: data[row][col], row, col }); } }); }); return selected; } clearSelectedCells(start, end) { const { data, onCellsChanged, onChange } = this.props; const cells = this.getSelectedCells(data, start, end) .filter(cell => !cell.cell.readOnly) .map(cell => ({ ...cell, value: '' })); if (onCellsChanged) { onCellsChanged(cells); this.onRevert(); } else if (onChange) { // ugly solution brought to you by https://reactjs.org/docs/react-component.html#setstate // setState in a loop is unreliable setTimeout(() => { cells.forEach(({ cell, row, col, value }) => { onChange(cell, row, col, value); }); this.onRevert(); }, 0); } } updateLocationSingleCell(location) { this._setState({ start: location, end: location, editing: {}, }); } updateLocationMultipleCells(offsets) { const { start, end } = this.getState(); const { data } = this.props; const oldStartLocation = { i: start.i, j: start.j }; const newEndLocation = { i: end.i + offsets.i, j: Math.min(data[0].length - 1, Math.max(0, end.j + offsets.j)), }; this._setState({ start: oldStartLocation, end: newEndLocation, editing: {}, }); } searchForNextSelectablePos(isCellNavigable, data, start, offsets, jumpRow) { const previousRow = location => ({ i: location.i - 1, j: data[0].length - 1, }); const nextRow = location => ({ i: location.i + 1, j: 0 }); const advanceOffset = location => ({ i: location.i + offsets.i, j: location.j + offsets.j, }); const isCellDefined = ({ i, j }) => data[i] && typeof data[i][j] !== 'undefined'; let newLocation = advanceOffset(start); while ( isCellDefined(newLocation) && !isCellNavigable( data[newLocation.i][newLocation.j], newLocation.i, newLocation.j, ) ) { newLocation = advanceOffset(newLocation); } if (!isCellDefined(newLocation)) { if (!jumpRow) { return null; } if (offsets.j < 0) { newLocation = previousRow(newLocation); } else { newLocation = nextRow(newLocation); } } if ( isCellDefined(newLocation) && !isCellNavigable( data[newLocation.i][newLocation.j], newLocation.i, newLocation.j, ) ) { return this.searchForNextSelectablePos( isCellNavigable, data, newLocation, offsets, jumpRow, ); } else if (isCellDefined(newLocation)) { return newLocation; } else { return null; } } handleNavigate(e, offsets, jumpRow) { if (offsets && (offsets.i || offsets.j)) { const { data } = this.props; const { start } = this.getState(); const multiSelect = e.shiftKey && !jumpRow; const isCellNavigable = this.props.isCellNavigable ? this.props.isCellNavigable : () => true; if (multiSelect) { this.updateLocationMultipleCells(offsets); } else { const newLocation = this.searchForNextSelectablePos( isCellNavigable, data, start, offsets, jumpRow, ); if (newLocation) { this.updateLocationSingleCell(newLocation); } } e.preventDefault(); } } handleComponentKey(e) { // handles keyboard events when editing components const keyCode = e.which || e.keyCode; if (![ENTER_KEY, ESCAPE_KEY, TAB_KEY].includes(keyCode)) { return; } const { editing } = this.state; const { data } = this.props; const isEditing = !isEmpty(editing); if (isEditing) { const currentCell = data[editing.i][editing.j]; const offset = e.shiftKey ? -1 : 1; if (currentCell && currentCell.component && !currentCell.forceComponent) { e.preventDefault(); let func = this.onRevert; // ESCAPE_KEY if (keyCode === ENTER_KEY) { func = () => this.handleNavigate(e, { i: offset, j: 0 }); } else if (keyCode === TAB_KEY) { func = () => this.handleNavigate(e, { i: 0, j: offset }, true); } // setTimeout makes sure that component is done handling the event before we take over setTimeout(() => { func(); this.dgDom && this.dgDom.focus({ preventScroll: true }); }, 1); } } } onContextMenu(evt, i, j) { let cell = this.props.data[i][j]; if (this.props.onContextMenu) { this.props.onContextMenu(evt, cell, i, j); } } onDoubleClick(i, j) { let cell = this.props.data[i][j]; if (!cell.readOnly) { this._setState({ editing: { i: i, j: j }, forceEdit: true, clear: {} }); } } onMouseDown(i, j, e) { const isNowEditingSameCell = !isEmpty(this.state.editing) && this.state.editing.i === i && this.state.editing.j === j; let editing = isEmpty(this.state.editing) || this.state.editing.i !== i || this.state.editing.j !== j ? {} : this.state.editing; this._setState({ selecting: !isNowEditingSameCell, start: e.shiftKey ? this.getState().start : { i, j }, end: { i, j }, editing: editing, forceEdit: !!isNowEditingSameCell, }); var ua = window.navigator.userAgent; var isIE = /MSIE|Trident/.test(ua); // Listen for Ctrl + V in case of IE if (isIE) { document.addEventListener('keydown', this.handleIEClipboardEvents); } // Keep listening to mouse if user releases the mouse (dragging outside) document.addEventListener('mouseup', this.onMouseUp); // Listen for any outside mouse clicks document.addEventListener('mousedown', this.pageClick); // Cut, copy and paste event handlers document.addEventListener('cut', this.handleCut); document.addEventListener('copy', this.handleCopy); document.addEventListener('paste', this.handlePaste); } onMouseOver(i, j) { if (this.state.selecting && isEmpty(this.state.editing)) { this._setState({ end: { i, j } }); } } onMouseUp() { this._setState({ selecting: false }); document.removeEventListener('mouseup', this.onMouseUp); } onChange(row, col, value) { const { onChange, onCellsChanged, data } = this.props; if (onCellsChanged) { onCellsChanged([{ cell: data[row][col], row, col, value }]); } else if (onChange) { onChange(data[row][col], row, col, value); } this.onRevert(); } onRevert() { this._setState({ editing: {} }); // setTimeout makes sure that component is done handling the new state before we take over setTimeout(() => { this.dgDom && this.dgDom.focus({ preventScroll: true }); }, 1); } componentDidUpdate(prevProps, prevState) { let { start, end } = this.state; let prevEnd = prevState.end; if ( !isEmpty(end) && !(end.i === prevEnd.i && end.j === prevEnd.j) && !this.isSelectionControlled() ) { this.props.onSelect && this.props.onSelect({ start, end }); } } isSelectedRow(rowIndex) { const { start, end } = this.getState(); const startY = start.i; const endY = end.i; if (startY <= endY) { return rowIndex >= startY && rowIndex <= endY; } else { return rowIndex <= startY && rowIndex >= endY; } } isSelected(i, j) { const { start, end } = this.getState(); const posX = j >= start.j && j <= end.j; const negX = j <= start.j && j >= end.j; const posY = i >= start.i && i <= end.i; const negY = i <= start.i && i >= end.i; return (posX && posY) || (negX && posY) || (negX && negY) || (posX && negY); } isEditing(i, j) { return this.state.editing.i === i && this.state.editing.j === j; } isClearing(i, j) { return this.state.clear.i === i && this.state.clear.j === j; } render() { const { sheetRenderer: SheetRenderer, rowRenderer: RowRenderer, cellRenderer, dataRenderer, valueRenderer, dataEditor, valueViewer, attributesRenderer, className, overflow, data, keyFn, } = this.props; const { forceEdit } = this.state; return ( { this.dgDom = r; }} tabIndex="0" className="data-grid-container" onKeyDown={this.handleKey} > a) .join(' ')} > {data.map((row, i) => ( {row.map((cell, j) => { const isEditing = this.isEditing(i, j); return ( ); })} ))} ); } } DataSheet.propTypes = { data: PropTypes.array.isRequired, className: PropTypes.string, disablePageClick: PropTypes.bool, overflow: PropTypes.oneOf(['wrap', 'nowrap', 'clip']), onChange: PropTypes.func, onCellsChanged: PropTypes.func, onContextMenu: PropTypes.func, onSelect: PropTypes.func, isCellNavigable: PropTypes.func, selected: PropTypes.shape({ start: PropTypes.shape({ i: PropTypes.number, j: PropTypes.number, }), end: PropTypes.shape({ i: PropTypes.number, j: PropTypes.number, }), }), valueRenderer: PropTypes.func.isRequired, dataRenderer: PropTypes.func, sheetRenderer: PropTypes.func.isRequired, rowRenderer: PropTypes.func.isRequired, cellRenderer: PropTypes.func.isRequired, valueViewer: PropTypes.func, dataEditor: PropTypes.func, parsePaste: PropTypes.func, attributesRenderer: PropTypes.func, keyFn: PropTypes.func, handleCopy: PropTypes.func, editModeChanged: PropTypes.func, }; DataSheet.defaultProps = { sheetRenderer: Sheet, rowRenderer: Row, cellRenderer: Cell, valueViewer: ValueViewer, dataEditor: DataEditor, };