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

feat: improved dnd model #850

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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 @@ -8,6 +8,7 @@ import { DockviewGroupPanel } from '../../../dockview/dockviewGroupPanel';
import { DockviewGroupPanelModel } from '../../../dockview/dockviewGroupPanelModel';
import { Tab } from '../../../dockview/components/tab/tab';
import { IDockviewPanel } from '../../../dockview/dockviewPanel';
import { fromPartial } from '@total-typescript/shoehorn';

describe('tab', () => {
test('that empty tab has inactive-tab class', () => {
Expand Down Expand Up @@ -46,15 +47,10 @@ describe('tab', () => {
id: 'testcomponentid',
};
});
const groupviewMock = jest.fn<Partial<DockviewGroupPanelModel>, []>(
() => {
return {
canDisplayOverlay: jest.fn(),
};
}
);

const groupView = new groupviewMock() as DockviewGroupPanelModel;
const groupView = fromPartial<DockviewGroupPanelModel>({
canDisplayOverlay: jest.fn(),
});

const groupPanelMock = jest.fn<Partial<DockviewGroupPanel>, []>(() => {
return {
Expand Down Expand Up @@ -82,28 +78,23 @@ describe('tab', () => {
fireEvent.dragEnter(cut.element);
fireEvent.dragOver(cut.element);

expect(groupView.canDisplayOverlay).toBeCalled();
expect(groupView.canDisplayOverlay).toHaveBeenCalled();

expect(
cut.element.getElementsByClassName('dv-drop-target-dropzone').length
).toBe(0);
});

test('that if you drag over yourself no drop target is shown', () => {
test('that if you drag over yourself a drop target is shown', () => {
const accessorMock = jest.fn<Partial<DockviewComponent>, []>(() => {
return {
id: 'testcomponentid',
};
});
const groupviewMock = jest.fn<Partial<DockviewGroupPanelModel>, []>(
() => {
return {
canDisplayOverlay: jest.fn(),
};
}
);

const groupView = new groupviewMock() as DockviewGroupPanelModel;
const groupView = fromPartial<DockviewGroupPanelModel>({
canDisplayOverlay: jest.fn(),
});

const groupPanelMock = jest.fn<Partial<DockviewGroupPanel>, []>(() => {
return {
Expand Down Expand Up @@ -136,11 +127,11 @@ describe('tab', () => {
fireEvent.dragEnter(cut.element);
fireEvent.dragOver(cut.element);

expect(groupView.canDisplayOverlay).toBeCalledTimes(0);
expect(groupView.canDisplayOverlay).toHaveBeenCalledTimes(0);

expect(
cut.element.getElementsByClassName('dv-drop-target-dropzone').length
).toBe(0);
).toBe(1);
});

test('that if you drag over another tab a drop target is shown', () => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ import { TestPanel } from '../../dockviewGroupPanelModel.spec';
import { IDockviewPanel } from '../../../../dockview/dockviewPanel';
import { fromPartial } from '@total-typescript/shoehorn';
import { DockviewPanelApi } from '../../../../api/dockviewPanelApi';
import { DropTargetAnchorContainer } from '../../../../dnd/dropTragetAnchorContainer';
import { Droptarget } from '../../../../dnd/droptarget';

describe('tabsContainer', () => {
test('that an external event does not render a drop target and calls through to the group mode', () => {
Expand Down Expand Up @@ -73,15 +75,14 @@ describe('tabsContainer', () => {
options: {},
});

const groupviewMock = jest.fn<Partial<DockviewGroupPanelModel>, []>(
() => {
return {
canDisplayOverlay: jest.fn(),
};
}
);
const dropTargetContainer = document.createElement('div');

const groupView = new groupviewMock() as DockviewGroupPanelModel;
const groupView = fromPartial<DockviewGroupPanelModel>({
canDisplayOverlay: jest.fn(),
// dropTargetContainer: new DropTargetAnchorContainer(
// dropTargetContainer
// ),
});

const groupPanelMock = jest.fn<Partial<DockviewGroupPanel>, []>(() => {
return {
Expand Down Expand Up @@ -129,6 +130,10 @@ describe('tabsContainer', () => {
expect(
cut.element.getElementsByClassName('dv-drop-target-dropzone').length
).toBe(1);
// expect(
// dropTargetContainer.getElementsByClassName('dv-drop-target-anchor')
// .length
// ).toBe(1);
});

test('that dropping over the empty space should render a drop target', () => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -133,11 +133,11 @@ describe('dockviewComponent', () => {
},
className: 'test-a test-b',
});
expect(dockview.element.className).toBe('test-a test-b');
expect(dockview.element.className).toBe('test-a test-b dockview-theme-abyss');

dockview.updateOptions({ className: 'test-b test-c' });

expect(dockview.element.className).toBe('test-b test-c');
expect(dockview.element.className).toBe('dockview-theme-abyss test-b test-c');
});

describe('memory leakage', () => {
Expand Down Expand Up @@ -6652,36 +6652,4 @@ describe('dockviewComponent', () => {
expect(api.panels.length).toBe(3);
expect(api.groups.length).toBe(3);
});

describe('updateOptions', () => {
test('gap', () => {
const container = document.createElement('div');

const dockview = new DockviewComponent(container, {
createComponent(options) {
switch (options.name) {
case 'default':
return new PanelContentPartTest(
options.id,
options.name
);
default:
throw new Error(`unsupported`);
}
},
gap: 6,
});

expect(dockview.gap).toBe(6);

dockview.updateOptions({ gap: 10 });
expect(dockview.gap).toBe(10);

dockview.updateOptions({});
expect(dockview.gap).toBe(10);

dockview.updateOptions({ gap: 15 });
expect(dockview.gap).toBe(15);
});
});
});
Original file line number Diff line number Diff line change
Expand Up @@ -792,7 +792,7 @@ describe('dockviewGroupPanelModel', () => {
fireEvent.dragEnd(element);
});

test('that should not show drop target if dropping on self', () => {
test('that should show drop target if dropping on self', () => {
const accessor = fromPartial<DockviewComponent>({
id: 'testcomponentid',
options: {},
Expand All @@ -806,15 +806,9 @@ describe('dockviewGroupPanelModel', () => {
),
});

const groupviewMock = jest.fn<Partial<DockviewGroupPanelModel>, []>(
() => {
return {
canDisplayOverlay: jest.fn(),
};
}
);

const groupView = new groupviewMock() as DockviewGroupPanelModel;
const groupView = fromPartial<DockviewGroupPanelModel>({
canDisplayOverlay: jest.fn(),
});

const groupPanelMock = jest.fn<Partial<DockviewGroupPanel>, []>(() => {
return {
Expand Down Expand Up @@ -861,10 +855,10 @@ describe('dockviewGroupPanelModel', () => {

expect(
element.getElementsByClassName('dv-drop-target-dropzone').length
).toBe(0);
).toBe(1);
});

test('that should not allow drop when dropping on self for same component id', () => {
test('that should allow drop when dropping on self for same component id', () => {
const accessor = fromPartial<DockviewComponent>({
id: 'testcomponentid',
options: {},
Expand Down Expand Up @@ -934,7 +928,7 @@ describe('dockviewGroupPanelModel', () => {

expect(
element.getElementsByClassName('dv-drop-target-dropzone').length
).toBe(0);
).toBe(1);
});

test('that should not allow drop when not dropping for different component id', () => {
Expand Down
8 changes: 0 additions & 8 deletions packages/dockview-core/src/api/component.api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -629,10 +629,6 @@ export class DockviewApi implements CommonApi<SerializedDockview> {
return this.component.totalPanels;
}

get gap(): number {
return this.component.gap;
}

/**
* Invoked when the active group changes. May be undefined if no group is active.
*/
Expand Down Expand Up @@ -914,10 +910,6 @@ export class DockviewApi implements CommonApi<SerializedDockview> {
return this.component.addPopoutGroup(item, options);
}

setGap(gap: number | undefined): void {
this.component.updateOptions({ gap });
}

updateOptions(options: Partial<DockviewComponentOptions>) {
this.component.updateOptions(options);
}
Expand Down
6 changes: 4 additions & 2 deletions packages/dockview-core/src/dnd/abstractDragHandler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -67,15 +67,17 @@ export abstract class DragHandler extends CompositeDisposable {
* For example: in react-dnd if dataTransfer.types is not set then the dragStart event will be cancelled
* through .preventDefault(). Since this is applied globally to all drag events this would break dockviews
* dnd logic. You can see the code at
* https://github.com/react-dnd/react-dnd/blob/main/packages/backend-html5/src/HTML5BackendImpl.ts#L542
P * https://github.com/react-dnd/react-dnd/blob/main/packages/backend-html5/src/HTML5BackendImpl.ts#L542
*/
event.dataTransfer.setData('text/plain', '');
}
}
}),
addDisposableListener(this.el, 'dragend', () => {
this.pointerEventsDisposable.dispose();
this.dataDisposable.dispose();
setTimeout(() => {
this.dataDisposable.dispose(); // allow the data to be read by other handlers before disposing
}, 0);
})
);
}
Expand Down
78 changes: 78 additions & 0 deletions packages/dockview-core/src/dnd/dropTragetAnchorContainer.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
import { CompositeDisposable, Disposable } from '../lifecycle';
import { DropTargetTargetModel } from './droptarget';

export class DropTargetAnchorContainer extends CompositeDisposable {
private _model:
| { root: HTMLElement; overlay: HTMLElement; changed: boolean }
| undefined;

private _outline: HTMLElement | undefined;

get model(): DropTargetTargetModel {
return {
clear: () => {
if (this._model) {
this._model.root.parentElement?.removeChild(
this._model.root
);
}
this._model = undefined;
},
exists: () => {
return !!this._model;
},
getElements: (event?: DragEvent, outline?: HTMLElement) => {
const changed = this._outline !== outline;
this._outline = outline;

if (this._model) {
this._model.changed = changed;
return this._model;
}

const container = this.createContainer();
const anchor = this.createAnchor();

this._model = { root: container, overlay: anchor, changed };

container.appendChild(anchor);
this.element.appendChild(container);

if (event?.target instanceof HTMLElement) {
const targetBox = event.target.getBoundingClientRect();
const box = this.element.getBoundingClientRect();

anchor.style.left = `${targetBox.left - box.left}px`;
anchor.style.top = `${targetBox.top - box.top}px`;
}

return this._model;
},
};
}

constructor(readonly element: HTMLElement) {
super();

this.addDisposables(
Disposable.from(() => {
this.model.clear();
})
);
}

private createContainer(): HTMLElement {
const el = document.createElement('div');
el.className = 'dv-drop-target-container';

return el;
}

private createAnchor(): HTMLElement {
const el = document.createElement('div');
el.className = 'dv-drop-target-anchor';
el.style.visibility = 'hidden';

return el;
}
}
34 changes: 31 additions & 3 deletions packages/dockview-core/src/dnd/droptarget.scss
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
.dv-drop-target {
position: relative;
--dv-transition-duration: 70ms;

> .dv-drop-target-dropzone {
position: absolute;
Expand All @@ -15,10 +16,13 @@
box-sizing: border-box;
height: 100%;
width: 100%;
border: var(--dv-drag-over-border);
background-color: var(--dv-drag-over-background-color);
transition: top 70ms ease-out, left 70ms ease-out,
width 70ms ease-out, height 70ms ease-out,
opacity 0.15s ease-out;
transition: top var(--dv-transition-duration) ease-out,
left var(--dv-transition-duration) ease-out,
width var(--dv-transition-duration) ease-out,
height var(--dv-transition-duration) ease-out,
opacity var(--dv-transition-duration) ease-out;
will-change: transform;
pointer-events: none;

Expand Down Expand Up @@ -48,3 +52,27 @@
}
}
}

.dv-drop-target-container {
position: absolute;
z-index: 9999;
top: 0px;
left: 0px;
height: 100%;
width: 100%;
pointer-events: none;
overflow: hidden;
--dv-transition-duration: 300ms;

.dv-drop-target-anchor {
position: relative;
border: var(--dv-drag-over-border);
transition: opacity var(--dv-transition-duration) ease-in,
top var(--dv-transition-duration) ease-out,
left var(--dv-transition-duration) ease-out,
width var(--dv-transition-duration) ease-out,
height var(--dv-transition-duration) ease-out;
background-color: var(--dv-drag-over-background-color);
opacity: 1;
}
}
Loading
Loading