Skip to content

Bubble dragover and dragenter events #14

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.

Sign up for GitHub

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 4 commits into from
Sep 3, 2021
Merged

Bubble dragover and dragenter events #14

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
197649d
Surface event for file-attachment-dragged
Bestra Aug 30, 2021
312836e
[pr review] use better name for event target
Bestra Sep 1, 2021
ae31438
Bubble original event rather than a new custom one
Bestra Sep 1, 2021
e6bda71
Merge branch 'main' into bestra/file-attachment-dragged-event
koddsson Sep 3, 2021
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
11 changes: 11 additions & 0 deletions src/file-attachment-element.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,17 @@ function onDragenter(event: DragEvent) {
if (dragging) {
clearTimeout(dragging)
}

const dragEvent = new CustomEvent('file-attachment-dragged', {
bubbles: true,
cancelable: true,
detail: {
dragEvent: event,
attachmentElement: target
Copy link
Contributor

@dgreif dgreif Aug 31, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about calling this target instead? attachmentElement made me instinctually think it was the thing being dragged, rather than the element we are dragging over

Copy link
Contributor Author

@Bestra Bestra Sep 1, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a good distinction! 👍

Copy link
Contributor Author

@Bestra Bestra Sep 1, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We've now removed the custom event entirely 🎉

}
})
target.dispatchEvent(dragEvent)
Copy link
Contributor

@koddsson koddsson Sep 1, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't check if the event was cancelled. Do we need the event to be cancellable?

Copy link
Contributor Author

@Bestra Bestra Sep 1, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@koddsson that's a really good question! Even though it doesn't need to be for https://github.com/github/github/pull/190219, since this event could be used for any number of things down the road being able to preventDefault() on it and then checking if the event was cancelled might be useful. I'll set cancelable: true

Copy link
Contributor Author

@Bestra Bestra Sep 1, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, Wednesday morning 🤦. It already is cancellable. Really I could go either way. I don't think we're going to regret having it be cancellable, but in truth I don't think we'll ever need to check if it's been cancelled. Probably less is more in this case, but I'll wait to hear back.


dragging = window.setTimeout(() => target.removeAttribute('hover'), 200)

const transfer = event.dataTransfer
Expand Down
18 changes: 18 additions & 0 deletions test/test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,24 @@ describe('file-attachment', function () {
assert.equal('test.png', event.detail.attachments[0].file.name)
assert.equal(0, input.files.length)
})

it('fires a file-attachment-dragged event on dragenter', async function () {
const listener = once('file-attachment-dragged')
const dragEvent = new Event('dragenter', {bubbles: true})
input.dispatchEvent(dragEvent)
const event = await listener
assert.equal(dragEvent, event.detail.dragEvent)
assert.equal(fileAttachment, event.detail.attachmentElement)
})

it('fires a file-attachment-dragged event on dragover', async function () {
const listener = once('file-attachment-dragged')
const dragEvent = new Event('dragover', {bubbles: true})
input.dispatchEvent(dragEvent)
const event = await listener
assert.equal(dragEvent, event.detail.dragEvent)
assert.equal(fileAttachment, event.detail.attachmentElement)
})
})
})

Expand Down