Skip to content

[Dropzone] Enable file replacement via "drag-and-drop" #2154

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

Merged
merged 1 commit into from
Oct 7, 2024
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
4 changes: 4 additions & 0 deletions src/Dropzone/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# CHANGELOG

## 2.20

- Enable file replacement via "drag-and-drop"

## 2.13.2

- Revert "Change JavaScript package to `type: module`"
Expand Down
2 changes: 2 additions & 0 deletions src/Dropzone/assets/dist/controller.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,7 @@ export default class extends Controller {
clear(): void;
onInputChange(event: any): void;
_populateImagePreview(file: Blob): void;
onDragEnter(): void;
onDragLeave(event: any): void;
private dispatchEvent;
}
19 changes: 19 additions & 0 deletions src/Dropzone/assets/dist/controller.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,22 @@ class default_1 extends Controller {
initialize() {
this.clear = this.clear.bind(this);
this.onInputChange = this.onInputChange.bind(this);
this.onDragEnter = this.onDragEnter.bind(this);
this.onDragLeave = this.onDragLeave.bind(this);
}
connect() {
this.clear();
this.previewClearButtonTarget.addEventListener('click', this.clear);
this.inputTarget.addEventListener('change', this.onInputChange);
this.element.addEventListener('dragenter', this.onDragEnter);
this.element.addEventListener('dragleave', this.onDragLeave);
this.dispatchEvent('connect');
}
disconnect() {
this.previewClearButtonTarget.removeEventListener('click', this.clear);
this.inputTarget.removeEventListener('change', this.onInputChange);
this.element.removeEventListener('dragenter', this.onDragEnter);
this.element.removeEventListener('dragleave', this.onDragLeave);
}
clear() {
this.inputTarget.value = '';
Expand Down Expand Up @@ -51,6 +57,19 @@ class default_1 extends Controller {
});
reader.readAsDataURL(file);
}
onDragEnter() {
this.inputTarget.style.display = 'block';
this.placeholderTarget.style.display = 'block';
this.previewTarget.style.display = 'none';
}
onDragLeave(event) {
event.preventDefault();
if (!this.element.contains(event.relatedTarget)) {
this.inputTarget.style.display = 'none';
this.placeholderTarget.style.display = 'none';
this.previewTarget.style.display = 'block';
}
}
dispatchEvent(name, payload = {}) {
this.dispatch(name, { detail: payload, prefix: 'dropzone' });
}
Expand Down
27 changes: 27 additions & 0 deletions src/Dropzone/assets/src/controller.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ export default class extends Controller {
initialize() {
this.clear = this.clear.bind(this);
this.onInputChange = this.onInputChange.bind(this);
this.onDragEnter = this.onDragEnter.bind(this);
this.onDragLeave = this.onDragLeave.bind(this);
}

connect() {
Expand All @@ -34,12 +36,20 @@ export default class extends Controller {
// Listen on input change and display preview
this.inputTarget.addEventListener('change', this.onInputChange);

// Add dragenter event listener
this.element.addEventListener('dragenter', this.onDragEnter);

// Add dragleave event listener
this.element.addEventListener('dragleave', this.onDragLeave);

this.dispatchEvent('connect');
}

disconnect() {
this.previewClearButtonTarget.removeEventListener('click', this.clear);
this.inputTarget.removeEventListener('change', this.onInputChange);
this.element.removeEventListener('dragenter', this.onDragEnter);
this.element.removeEventListener('dragleave', this.onDragLeave);
}

clear() {
Expand Down Expand Up @@ -93,6 +103,23 @@ export default class extends Controller {
reader.readAsDataURL(file);
}

onDragEnter() {
this.inputTarget.style.display = 'block';
this.placeholderTarget.style.display = 'block';
this.previewTarget.style.display = 'none';
}

onDragLeave(event: any) {
event.preventDefault();

// Check if we really leave the main drag area
if (!this.element.contains(event.relatedTarget as Node)) {
this.inputTarget.style.display = 'none';
this.placeholderTarget.style.display = 'none';
this.previewTarget.style.display = 'block';
}
}

private dispatchEvent(name: string, payload: any = {}) {
this.dispatch(name, { detail: payload, prefix: 'dropzone' });
}
Expand Down
23 changes: 23 additions & 0 deletions src/Dropzone/assets/test/controller.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -130,4 +130,27 @@ describe('DropzoneController', () => {
expect(dispatched).not.toBeNull();
expect(dispatched.detail).toStrictEqual(file);
});

it('on drag', async () => {
startStimulus();

// Simulate dragenter event
const dragEnterEvent = new Event('dragenter');
getByTestId(container, 'container').dispatchEvent(dragEnterEvent);

// Check that the input and placeholder are visible, and preview hidden
await waitFor(() => expect(getByTestId(container, 'input')).toHaveStyle({ display: 'block' }));
await waitFor(() => expect(getByTestId(container, 'placeholder')).toHaveStyle({ display: 'block' }));
await waitFor(() => expect(getByTestId(container, 'preview')).toHaveStyle({ display: 'none' }));

// Simulate dragleave event with relatedTarget set to outside the dropzone
const dragLeaveEvent = new Event('dragleave', { bubbles: true });
Object.defineProperty(dragLeaveEvent, 'relatedTarget', { value: document.body });
getByTestId(container, 'container').dispatchEvent(dragLeaveEvent);

// Check that the input and placeholder are hidden, and preview shown
await waitFor(() => expect(getByTestId(container, 'input')).toHaveStyle({ display: 'none' }));
await waitFor(() => expect(getByTestId(container, 'placeholder')).toHaveStyle({ display: 'none' }));
await waitFor(() => expect(getByTestId(container, 'preview')).toHaveStyle({ display: 'block' }));
});
});