Use hook for drag and drop #5062
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,98 +1,66 @@ | ||
| import { PlotsSection } from 'dvc/src/plots/webview/contract' | ||
| import React from 'react' | ||
| import cx from 'classnames' | ||
| import styles from './styles.module.scss' | ||
| import { DragAndDropPlot } from './DragAndDropPlot' | ||
| import { plotDataStore } from './plotDataStore' | ||
| import { VirtualizedGrid } from '../../shared/components/virtualizedGrid/VirtualizedGrid' | ||
| import { OnDrop } from '../../shared/hooks/useDragAndDrop' | ||
|
|
||
| interface DragAndDropGridProps { | ||
| order: string[] | ||
| setOrder: (order: string[]) => void | ||
| groupId: string | ||
| nbItemsPerRow: number | ||
| useVirtualizedGrid?: boolean | ||
| parentDraggedOver?: boolean | ||
| multiView?: boolean | ||
| sectionKey: PlotsSection | ||
| onDrop?: OnDrop | ||
| } | ||
|
|
||
| export const DragAndDropGrid: React.FC<DragAndDropGridProps> = ({ | ||
| order, | ||
| setOrder, | ||
| groupId, | ||
| nbItemsPerRow, | ||
| useVirtualizedGrid, | ||
| parentDraggedOver, | ||
| multiView, | ||
| sectionKey, | ||
| onDrop | ||
| }) => { | ||
| const plotClassName = cx(styles.plot, styles.dragAndDropPlot, { | ||
| [styles.multiViewPlot]: multiView | ||
| }) | ||
| const items = order.map((plot: string, i: number) => { | ||
| const colSpan = | ||
| (multiView && | ||
| plotDataStore[PlotsSection.TEMPLATE_PLOTS][plot]?.revisions?.length) || | ||
| 1 | ||
|
|
||
| return ( | ||
| <DragAndDropPlot | ||
| key={plot} | ||
| id={plot} | ||
| data-testid={`plot_${plot}`} | ||
| plot={plot} | ||
| sectionKey={sectionKey} | ||
| className={plotClassName} | ||
| colSpan={colSpan} | ||
| group={groupId} | ||
| isParentDraggedOver={parentDraggedOver} | ||
| setOrder={setOrder} | ||
| order={order} | ||
| isLast={i === order.length - 1} | ||
| afterOnDrop={onDrop} | ||
| /> | ||
| ) | ||
| }) | ||
|
|
||
| return useVirtualizedGrid ? ( | ||
| <VirtualizedGrid nbItemsPerRow={nbItemsPerRow}>{items}</VirtualizedGrid> | ||
| ) : ( | ||
| <>{items}</> | ||
| ) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,62 +1,121 @@ | ||
| import cx from 'classnames' | ||
| import React, { | ||
| DragEvent, | ||
| HTMLAttributes, | ||
| createRef, | ||
| useEffect, | ||
| useRef | ||
| } from 'react' | ||
| import { useDispatch } from 'react-redux' | ||
| import { PlotsSection } from 'dvc/src/plots/webview/contract' | ||
| import styles from './styles.module.scss' | ||
| import { changeDragAndDropMode } from './util' | ||
| import { DropTarget } from './DropTarget' | ||
| import { GripIcon } from '../../shared/components/dragDrop/GripIcon' | ||
| import { Icon } from '../../shared/components/Icon' | ||
| import { GraphLine } from '../../shared/components/icons' | ||
| import { withScale } from '../../util/styles' | ||
| import { OnDrop, useDragAndDrop } from '../../shared/hooks/useDragAndDrop' | ||
| import { useGetTitles } from '../hooks/useGetTitles' | ||
| import { DragDropItemWithTarget } from '../../shared/components/dragDrop/DragDropItemWithTarget' | ||
|
|
||
| interface DragAndDropPlotProps extends HTMLAttributes<HTMLDivElement> { | ||
| plot: string | ||
| group: string | ||
| sectionKey: PlotsSection | ||
| colSpan: number | ||
| isParentDraggedOver?: boolean | ||
| setOrder: (order: string[]) => void | ||
| order: string[] | ||
| isLast?: boolean | ||
| afterOnDrop?: OnDrop | ||
| } | ||
|
|
||
| export const DragAndDropPlot: React.FC<DragAndDropPlotProps> = ({ | ||
| plot, | ||
| sectionKey, | ||
| colSpan, | ||
| group, | ||
| isParentDraggedOver, | ||
| setOrder, | ||
| order, | ||
| isLast, | ||
| afterOnDrop, | ||
| ...props | ||
| }) => { | ||
| const dispatch = useDispatch() | ||
| const dragAndDropTimeout = useRef(0) | ||
| const ref = createRef<HTMLDivElement>() | ||
| const titles = useGetTitles(sectionKey, plot) | ||
| const title = titles?.title || '' | ||
| const subtitle = titles?.subtitle || '' | ||
|
|
||
| const handleDragEnd = () => changeDragAndDropMode(sectionKey, dispatch, true) | ||
|
|
||
| const { isAfter, target, onDragStart, ...dragAndDropProps } = useDragAndDrop({ | ||
| dropTarget: <DropTarget />, | ||
| group, | ||
| id: plot, | ||
| isLast, | ||
| isParentDraggedOver, | ||
| onDragEnd: handleDragEnd, | ||
| onDrop: afterOnDrop, | ||
| order, | ||
| setOrder, | ||
| style: withScale(colSpan) | ||
| }) | ||
|
|
||
| useEffect(() => { | ||
| return () => { | ||
| clearTimeout(dragAndDropTimeout.current) | ||
| } | ||
| }, []) | ||
|
|
||
| const handleDragStart = (e: DragEvent<HTMLElement>) => { | ||
| onDragStart(e) | ||
| // Because the dragged element is being created while being dragged for plots in grids, there is a problem where | ||
| // the dragend event is not being associated with the element. Re-adding the event makes sure it's being called. | ||
| ref.current?.addEventListener('dragend', dragAndDropProps.onDragEnd) | ||
| } | ||
|
|
||
| const handleEndOfDragAndDrop = () => { | ||
| // This makes sure every onDrop and onDragEnd events have been called before switching to normal mode | ||
| dragAndDropTimeout.current = window.setTimeout(() => { | ||
| handleDragEnd() | ||
| }, 100) | ||
| } | ||
|
|
||
| return ( | ||
| <DragDropItemWithTarget | ||
| isAfter={isAfter} | ||
| dropTarget={target || null} | ||
| draggable={<div />} | ||
| > | ||
| <div | ||
| {...props} | ||
| {...dragAndDropProps} | ||
| onDragStart={handleDragStart} | ||
| ref={ref} | ||
| > | ||
| { | ||
| // eslint-disable-next-line jsx-a11y/no-static-element-interactions | ||
| <div onMouseUp={handleEndOfDragAndDrop}> | ||
| <GripIcon className={styles.plotGripIcon} /> | ||
| </div> | ||
| } | ||
| <div className={styles.dragAndDropPlotContent}> | ||
| <h2 className={styles.dragAndDropPlotTitle}>{title}</h2> | ||
| {subtitle && ( | ||
| <h3 className={styles.dragAndDropPlotSubtitle}>{subtitle}</h3> | ||
| )} | ||
| <Icon | ||
| icon={GraphLine} | ||
| className={cx(styles.dropIcon, styles.onPlotDropIcon)} | ||
| width={70} | ||
| height={70} | ||
| /> | ||
| </div> | ||
| </div> | ||
| </DragDropItemWithTarget> | ||
| ) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's the reasoning for adding this? I'm not seeing any new files with this syntax 🤔
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
useDragAndDrop.tsxthere is somejsxin that file