-
Notifications
You must be signed in to change notification settings - Fork 289
/
columnStateHelper.js
232 lines (203 loc) · 6.37 KB
/
columnStateHelper.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
/**
* Copyright Schrodinger, LLC
* 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 columnStateHelper
*/
'use strict';
import isNil from 'lodash/isNil';
import clamp from 'lodash/clamp';
import emptyFunction from '../vendor_upstream/core/emptyFunction';
import columnWidths from '../selectors/columnWidths';
const DRAG_SCROLL_SPEED = 15;
const DRAG_SCROLL_BUFFER = 100;
/**
* Initialize scrollX state
* TODO (jordan) Audit this method for cases where deep values are not properly cloned
*
* @param {!Object} state
* @param {!Object} props
* @param {Object} oldProps
* @return {!Object}
*/
function initialize(state, props, oldProps) {
const { scrollLeft, scrollToColumn } = props;
let { columnResizingData, isColumnResizing, scrollX } = state;
if (
scrollLeft !== undefined &&
(!oldProps || scrollLeft !== oldProps.scrollLeft)
) {
scrollX = scrollLeft;
}
scrollX = scrollTo(state, props, oldProps.scrollToColumn, scrollX);
const { maxScrollX } = columnWidths(state);
scrollX = clamp(scrollX, 0, maxScrollX);
// isColumnResizing should be overwritten by value from props if available
isColumnResizing =
props.isColumnResizing !== undefined
? props.isColumnResizing
: isColumnResizing;
columnResizingData = isColumnResizing ? columnResizingData : {};
return Object.assign({}, state, {
columnResizingData,
isColumnResizing,
maxScrollX,
scrollX,
});
}
/**
* @param {!Object} state
* @param {{
* scrollToColumn: number,
* width: number,
* }} props
* @param {number} oldScrollToColumn
* @param {number} scrollX
* @return {number} The new scrollX
*/
function scrollTo(state, props, oldScrollToColumn, scrollX) {
const { scrollToColumn } = props;
if (isNil(scrollToColumn)) {
return scrollX;
}
const {
availableScrollWidth,
fixedColumns,
scrollableColumns,
} = columnWidths(state);
const fixedColumnsCount = fixedColumns.length;
const scrollableColumnsCount = scrollableColumns.length;
const noScrollableColumns = scrollableColumnsCount === 0;
const scrollToUnchanged = scrollToColumn === oldScrollToColumn;
const selectedColumnFixed = scrollToColumn < fixedColumnsCount;
const selectedColumnFixedRight =
scrollToColumn >= fixedColumnsCount + scrollableColumnsCount;
if (
scrollToUnchanged ||
selectedColumnFixed ||
selectedColumnFixedRight ||
noScrollableColumns
) {
return scrollX;
}
// Convert column index (0 indexed) to scrollable index (0 indexed)
// and clamp to max scrollable index
const clampedColumnIndex = Math.min(
scrollToColumn - fixedColumnsCount,
scrollableColumns.length - 1
);
// Compute the width of all columns to the left of the column
let previousWidth = 0;
for (let columnIdx = 0; columnIdx < clampedColumnIndex; ++columnIdx) {
previousWidth += scrollableColumns[columnIdx].width;
}
// Get width of specified column
const selectedColumnWidth = scrollableColumns[clampedColumnIndex].width;
// Compute the scroll position which sets the column on the right of the viewport
// Must scroll at least far enough for end of column (previousWidth + selectedColumnWidth)
// to be in viewport.
const minScrollPosition =
previousWidth + selectedColumnWidth - availableScrollWidth;
// Handle offscreen to the left
// If scrolled less than minimum amount, scroll to minimum amount
// so column on right of viewport
if (scrollX < minScrollPosition) {
return minScrollPosition;
}
// Handle offscreen to the right
// If scrolled more than previous columns, at least part of column will be offscreen to left
// Scroll so column is flush with left edge of viewport
if (scrollX > previousWidth) {
return previousWidth;
}
return scrollX;
}
/**
* This is called when a cell that is in the header of a column has its
* resizer knob clicked on. It displays the resizer and puts in the correct
* location on the table.
*/
function resizeColumn(state, resizeData) {
let {
cellMinWidth,
cellMaxWidth,
cellWidth,
columnKey,
combinedWidth,
clientX,
clientY,
leftOffset,
} = resizeData;
return Object.assign({}, state, {
isColumnResizing: true,
columnResizingData: {
left: leftOffset + combinedWidth - cellWidth,
width: cellWidth,
minWidth: cellMinWidth,
maxWidth: cellMaxWidth,
initialEvent: {
clientX: clientX,
clientY: clientY,
preventDefault: emptyFunction,
},
key: columnKey,
},
});
}
function reorderColumn(state, reorderData) {
let { columnKey, left, scrollStart, width } = reorderData;
const { fixedColumns } = columnWidths(state);
const isFixed = fixedColumns.some(function (column) {
return column.columnKey === columnKey;
});
return Object.assign({}, state, {
isColumnReordering: true,
columnReorderingData: {
cancelReorder: false,
dragDistance: 0,
isFixed: isFixed,
scrollStart: scrollStart,
columnKey: columnKey,
columnWidth: width,
originalLeft: left,
columnBefore: undefined,
columnAfter: undefined,
},
});
}
function reorderColumnMove(state, deltaX) {
const { isFixed, originalLeft, scrollStart } = state.columnReorderingData;
let { maxScrollX, scrollX } = state;
if (!isFixed) {
// Relative dragX position on scroll
const dragX = originalLeft - scrollStart + deltaX;
const { availableScrollWidth } = columnWidths(state);
deltaX += scrollX - scrollStart;
// Scroll the table left or right if we drag near the edges of the table
if (dragX > availableScrollWidth - DRAG_SCROLL_BUFFER) {
scrollX = Math.min(scrollX + DRAG_SCROLL_SPEED, maxScrollX);
} else if (dragX <= DRAG_SCROLL_BUFFER) {
scrollX = Math.max(scrollX - DRAG_SCROLL_SPEED, 0);
}
}
// NOTE (jordan) Need to clone this object when use pureRendering
const reorderingData = Object.assign({}, state.columnReorderingData, {
dragDistance: deltaX,
columnBefore: undefined,
columnAfter: undefined,
});
return Object.assign({}, state, {
scrollX: scrollX,
columnReorderingData: reorderingData,
});
}
export default {
initialize,
reorderColumn,
reorderColumnMove,
resizeColumn,
};