Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update table drag and drop implementation #2566

Merged
merged 6 commits into from
Oct 18, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ export const MergedHeaderGroups: React.FC<{
onDragUpdate: DragFunction
onDragStart: DragFunction
onDragEnd: DragFunction
onDrop: DragFunction
setExpColumnNeedsShadow: (needsShadow: boolean) => void
root: HTMLElement | null
}> = ({
Expand All @@ -22,6 +23,7 @@ export const MergedHeaderGroups: React.FC<{
onDragUpdate,
onDragEnd,
onDragStart,
onDrop,
root,
setExpColumnNeedsShadow
}) => {
Expand All @@ -40,7 +42,8 @@ export const MergedHeaderGroups: React.FC<{
columns={columns}
onDragEnter={onDragUpdate}
onDragStart={onDragStart}
onDrop={onDragEnd}
onDragEnd={onDragEnd}
onDrop={onDrop}
root={root}
/>
))}
Expand Down
7 changes: 4 additions & 3 deletions webview/src/experiments/components/table/Table.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -427,7 +427,7 @@ describe('Table', () => {
let headers = await getHeaders()

expect(headers.indexOf('threshold')).toBeGreaterThan(
headers.indexOf('loss')
headers.indexOf('accuracy')
)
expect(headers.indexOf('test')).toBeGreaterThan(
headers.indexOf('accuracy')
Expand All @@ -441,12 +441,13 @@ describe('Table', () => {

headers = await getHeaders()

expect(headers.indexOf('loss')).toBeGreaterThan(
expect(headers.indexOf('accuracy')).toBeGreaterThan(
headers.indexOf('threshold')
)

const [, startingNode] = screen.getAllByText('summary.json')
dragAndDrop(
screen.getByText('summary.json'),
startingNode,
getDraggableHeaderFromText('test'),
DragEnterDirection.AUTO
)
Expand Down
7 changes: 5 additions & 2 deletions webview/src/experiments/components/table/Table.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import React, { useRef, useState } from 'react'
import React, { useRef, useState, CSSProperties } from 'react'
import { useSelector } from 'react-redux'
import cx from 'classnames'
import styles from './styles.module.scss'
Expand Down Expand Up @@ -61,7 +61,10 @@ export const Table: React.FC<InstanceProp> = ({ instance }) => {
)

return (
<div className={styles.tableContainer}>
<div
className={styles.tableContainer}
style={{ '--table-head-height': `${tableHeadHeight}px` } as CSSProperties}
>
<div
{...getTableProps({
className: cx(
Expand Down
5 changes: 1 addition & 4 deletions webview/src/experiments/components/table/TableBody.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import React, { CSSProperties } from 'react'
import React from 'react'
import cx from 'classnames'
import { useInView } from 'react-intersection-observer'
import styles from './styles.module.scss'
Expand All @@ -21,9 +21,6 @@ const WorkspaceRowGroupWrapper: React.FC<

return (
<div
style={
{ '--table-head-height': `${tableHeaderHeight}px` } as CSSProperties
}
ref={ref}
{...instance.getTableBodyProps({
className: cx(
Expand Down
49 changes: 32 additions & 17 deletions webview/src/experiments/components/table/TableHead.tsx
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
import { Experiment } from 'dvc/src/experiments/webview/contract'
import React, { DragEvent, useRef, useEffect } from 'react'
import { useSelector } from 'react-redux'
import { useSelector, useDispatch } from 'react-redux'
import { HeaderGroup, TableInstance } from 'react-table'
import { MessageFromWebviewType } from 'dvc/src/webview/contract'
import styles from './styles.module.scss'
import { MergedHeaderGroups } from './MergeHeaderGroups'
import { Indicators } from './Indicators'
import { setDropTarget } from './headerDropTargetSlice'
import { useColumnOrder } from '../../hooks/useColumnOrder'
import { ExperimentsState } from '../../store'
import { sendMessage } from '../../../shared/vscode'
import { leafColumnIds, reorderColumnIds } from '../../util/columns'
import { DragFunction } from '../../../shared/components/dragDrop/Draggable'
import { getSelectedForPlotsCount } from '../../util/rows'

interface TableHeadProps {
instance: TableInstance<Experiment>
root: HTMLElement | null
Expand All @@ -34,7 +36,12 @@ export const TableHead = ({
const columns = useSelector(
(state: ExperimentsState) => state.tableData.columns
)
const headerDropTargetId = useSelector(
(state: ExperimentsState) => state.headerDropTarget
)
const dispatch = useDispatch()
const orderedColumns = useColumnOrder(columns, columnOrder)

const allHeaders: HeaderGroup<Experiment>[] = []
for (const headerGroup of headerGroups) {
allHeaders.push(...headerGroup.headers)
Expand Down Expand Up @@ -73,26 +80,33 @@ export const TableHead = ({
}

const onDragUpdate = (e: DragEvent<HTMLElement>) => {
const displacer = draggingIds.current
displacer &&
findDisplacedHeader(e.currentTarget.id, displacedHeader => {
const displaced = leafColumnIds(displacedHeader)
if (!displaced.some(id => displacer.includes(id))) {
fullColumnOrder.current &&
setColumnOrder(
reorderColumnIds(fullColumnOrder.current, displacer, displaced)
)
}
})
findDisplacedHeader(e.currentTarget.id, displacedHeader => {
const displaced = leafColumnIds(displacedHeader)
dispatch(setDropTarget(displaced[displaced.length - 1]))
})
}

const onDragEnd = () => {
draggingIds.current = undefined
fullColumnOrder.current = undefined
sendMessage({
payload: columnOrder,
type: MessageFromWebviewType.REORDER_COLUMNS
})
draggingIds.current = undefined
dispatch(setDropTarget(''))
}

const onDrop = () => {
const fullOrder = fullColumnOrder.current
const displacer = draggingIds.current
let newOrder: string[] = []

if (fullOrder && displacer) {
newOrder = reorderColumnIds(fullOrder, displacer, [headerDropTargetId])

setColumnOrder(newOrder)
sendMessage({
payload: newOrder,
type: MessageFromWebviewType.REORDER_COLUMNS
})
onDragEnd()
}
}

const selectedForPlotsCount = getSelectedForPlotsCount(rows)
Expand All @@ -110,6 +124,7 @@ export const TableHead = ({
onDragStart={onDragStart}
onDragUpdate={onDragUpdate}
onDragEnd={onDragEnd}
onDrop={onDrop}
root={root}
setExpColumnNeedsShadow={setExpColumnNeedsShadow}
/>
Expand Down
3 changes: 3 additions & 0 deletions webview/src/experiments/components/table/TableHeader.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ interface TableHeaderProps {
columns: HeaderGroup<Experiment>[]
orderedColumns: Column[]
onDragEnter: DragFunction
onDragEnd: DragFunction
onDragStart: DragFunction
onDrop: DragFunction
setExpColumnNeedsShadow: (needsShadow: boolean) => void
Expand All @@ -42,6 +43,7 @@ export const TableHeader: React.FC<TableHeaderProps> = ({
columns,
orderedColumns,
onDragEnter,
onDragEnd,
onDragStart,
onDrop,
root,
Expand Down Expand Up @@ -100,6 +102,7 @@ export const TableHeader: React.FC<TableHeaderProps> = ({
sortEnabled={isSortable}
hasFilter={hasFilter}
onDragEnter={onDragEnter}
onDragEnd={onDragEnd}
onDragStart={onDragStart}
onDrop={onDrop}
menuDisabled={!isSortable && column.group !== ColumnType.PARAMS}
Expand Down
15 changes: 15 additions & 0 deletions webview/src/experiments/components/table/TableHeaderCell.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import {
ColumnType
} from 'dvc/src/experiments/webview/contract'
import React, { useEffect } from 'react'
import { useSelector } from 'react-redux'
import { HeaderGroup } from 'react-table'
import cx from 'classnames'
import { useInView } from 'react-intersection-observer'
Expand All @@ -17,6 +18,7 @@ import {
} from '../../util/columns'
import { ContextMenu } from '../../../shared/components/contextMenu/ContextMenu'
import { DragFunction } from '../../../shared/components/dragDrop/Draggable'
import { ExperimentsState } from '../../store'

const calcResizerHeight = (
isPlaceholder: boolean,
Expand Down Expand Up @@ -86,6 +88,7 @@ export const TableHeaderCell: React.FC<{
menuDisabled?: boolean
menuContent?: React.ReactNode
onDragEnter: DragFunction
onDragEnd: DragFunction
onDragStart: DragFunction
onDrop: DragFunction
setExpColumnNeedsShadow: (needsShadow: boolean) => void
Expand All @@ -100,15 +103,20 @@ export const TableHeaderCell: React.FC<{
menuContent,
menuDisabled,
onDragEnter,
onDragEnd,
onDragStart,
onDrop,
root,
setExpColumnNeedsShadow
}) => {
const [menuSuppressed, setMenuSuppressed] = React.useState<boolean>(false)
const headerDropTargetId = useSelector(
(state: ExperimentsState) => state.headerDropTarget
)
const isDraggable = !column.placeholderOf && column.id !== 'id'

const isPlaceholder = !!column.placeholderOf

const canResize = column.canResize && !isPlaceholder
const resizerHeight = calcResizerHeight(
isPlaceholder,
Expand All @@ -127,6 +135,7 @@ export const TableHeaderCell: React.FC<{
menuSuppressed={menuSuppressed}
onDragEnter={onDragEnter}
onDragStart={onDragStart}
onDragEnd={onDragEnd}
onDrop={onDrop}
canResize={canResize}
setMenuSuppressed={setMenuSuppressed}
Expand Down Expand Up @@ -159,6 +168,12 @@ export const TableHeaderCell: React.FC<{
) : (
cellContents
)}
<div
className={cx(
styles.dropTarget,
headerDropTargetId === column.id && styles.active
)}
/>
</div>
</ContextMenu>
)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ export const ColumnDragHandle: React.FC<{
onDragEnter: DragFunction
onDragStart: DragFunction
onDrop: DragFunction
}> = ({ disabled, column, onDragEnter, onDragStart, onDrop }) => {
onDragEnd: DragFunction
}> = ({ disabled, column, onDragEnter, onDragStart, onDragEnd, onDrop }) => {
const DropTarget = <span>{column?.name}</span>

return (
Expand All @@ -51,6 +52,7 @@ export const ColumnDragHandle: React.FC<{
dropTarget={DropTarget}
onDragEnter={onDragEnter}
onDragStart={onDragStart}
onDragEnd={onDragEnd}
onDrop={onDrop}
>
<span>{column?.render('Header')}</span>
Expand All @@ -67,6 +69,7 @@ export const TableHeaderCellContents: React.FC<{
isDraggable: boolean
menuSuppressed: boolean
onDragEnter: DragFunction
onDragEnd: DragFunction
onDragStart: DragFunction
onDrop: DragFunction
canResize: boolean
Expand All @@ -80,6 +83,7 @@ export const TableHeaderCellContents: React.FC<{
isDraggable,
menuSuppressed,
onDragEnter,
onDragEnd,
onDragStart,
onDrop,
canResize,
Expand All @@ -106,6 +110,7 @@ export const TableHeaderCellContents: React.FC<{
onDragEnter={onDragEnter}
onDragStart={onDragStart}
onDrop={onDrop}
onDragEnd={onDragEnd}
/>
{canResize && (
<div
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { createSlice, PayloadAction } from '@reduxjs/toolkit'

export const headerDropTargetSlice = createSlice({
initialState: '',
name: 'headerDropTarget',
reducers: {
setDropTarget: (_, action: PayloadAction<string>) => {
return action.payload || ''
}
}
})

export const { setDropTarget } = headerDropTargetSlice.actions

export default headerDropTargetSlice.reducer
16 changes: 16 additions & 0 deletions webview/src/experiments/components/table/styles.module.scss
Original file line number Diff line number Diff line change
Expand Up @@ -461,6 +461,22 @@ $bullet-size: calc(var(--design-unit) * 4px);
.th {
height: auto;
background-color: $header-bg-color;

.dropTarget {
position: absolute;
right: -3px;
bottom: 0;
width: 3px;
z-index: -1;
height: var(--table-head-height);
background-color: $header-resizer-color;
z-index: 1;
display: none;

&.active {
display: block;
}
}
}
.td {
height: auto;
Expand Down
2 changes: 2 additions & 0 deletions webview/src/experiments/store.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
import { configureStore } from '@reduxjs/toolkit'
import tableDataReducer from './components/table/tableDataSlice'
import headersReducer from './components/table/headersSlice'
import headerDropTargetReducer from './components/table/headerDropTargetSlice'
import dragAndDropReducer from '../shared/components/dragDrop/dragDropSlice'

export const experimentsReducers = {
dragAndDrop: dragAndDropReducer,
headerDropTarget: headerDropTargetReducer,
headers: headersReducer,
tableData: tableDataReducer
}
Expand Down
6 changes: 3 additions & 3 deletions webview/src/experiments/util/columns.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ describe('reorderColumnIds()', () => {
'id_1'
])
expect(reorderColumnIds(twoColumnIds, ['id_2'], ['id_1'])).toStrictEqual([
'id_2',
'id_1'
'id_1',
'id_2'
])

const threeColumnIds = [...twoColumnIds, 'id_3']
Expand All @@ -41,6 +41,6 @@ describe('reorderColumnIds()', () => {
).toStrictEqual(['id_3', 'id_1', 'id_2'])
expect(
reorderColumnIds(threeColumnIds, ['id_2', 'id_3'], ['id_1'])
).toStrictEqual(['id_2', 'id_3', 'id_1'])
).toStrictEqual(['id_1', 'id_2', 'id_3'])
})
})
3 changes: 2 additions & 1 deletion webview/src/experiments/util/columns.ts
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,11 @@ export const reorderColumnIds = (
...columnIds.slice(displacedIndex + displaced.length)
]
}

return [
...columnIds.slice(0, displacedIndex),
...displacer,
...displaced,
...displacer,
...columnIds.slice(displacedIndex + displaced.length, displacerIndex),
...columnIds.slice(displacerIndex + displacer.length)
]
Expand Down
Loading