Native File Drag & Drop

Overview

Certain kinds of applications that manipulate files might want to support the operating system’s native file drag & drop feature. Dragging files into web content is common and supported by many websites. Electron additionally supports dragging files and content out from web content into the operating system’s world.

To implement this feature in your app, you need to call the webContents.startDrag(item) API in response to the ondragstart event.

Example

An example demonstrating how you can create a file on the fly to be dragged out of the window.

Preload.js

In preload.js use the contextBridge to inject a method window.electron.startDrag(...) that will send an IPC message to the main process.

  1. const { contextBridge, ipcRenderer } = require('electron')
  3. contextBridge.exposeInMainWorld('electron', {
  4.   startDrag: (fileName) => {
  5.     ipcRenderer.send('ondragstart', path.join(process.cwd(), fileName))
  6.   }
  7. })

Index.html

Add a draggable element to index.html, and reference your renderer script:

  1. <div style="border:2px solid black;border-radius:3px;padding:5px;display:inline-block" draggable="true" id="drag">Drag me</div>
  2. <script src="renderer.js"></script>

Renderer.js

In renderer.js set up the renderer process to handle drag events by calling the method you added via the contextBridge above.

  1. document.getElementById('drag').ondragstart = (event) => {
  2.   event.preventDefault()
  3.   window.electron.startDrag('drag-and-drop.md')
  4. }

Main.js

In the Main process (main.js file), expand the received event with a path to the file that is being dragged and an icon:

docs/fiddles/features/drag-and-drop (23.0.0)Open in Fiddle

  • main.js
  • preload.js
  • index.html
  • renderer.js
  1. const { app, BrowserWindow, ipcMain, nativeImage, NativeImage } = require('electron')
  2. const path = require('path')
  3. const fs = require('fs')
  4. const https = require('https')
  6. function createWindow() {
  7.   const win = new BrowserWindow({
  8.     width: 800,
  9.     height: 600,
  10.     webPreferences: {
  11.       preload: path.join(__dirname, 'preload.js')
  12.     }
  13.   })
  15.   win.loadFile('index.html')
  16. }
  18. const iconName = path.join(__dirname, 'iconForDragAndDrop.png');
  19. const icon = fs.createWriteStream(iconName);
  21. // Create a new file to copy - you can also copy existing files.
  22. fs.writeFileSync(path.join(__dirname, 'drag-and-drop-1.md'), '# First file to test drag and drop')
  23. fs.writeFileSync(path.join(__dirname, 'drag-and-drop-2.md'), '# Second file to test drag and drop')
  25. https.get('https://img.icons8.com/ios/452/drag-and-drop.png', (response) => {
  26.   response.pipe(icon);
  27. });
  29. app.whenReady().then(createWindow)
  31. ipcMain.on('ondragstart', (event, filePath) => {
  32.   event.sender.startDrag({
  33.     file: path.join(__dirname, filePath),
  34.     icon: iconName,
  35.   })
  36. })
  38. app.on('window-all-closed', () => {
  39.   if (process.platform !== 'darwin') {
  40.     app.quit()
  41.   }
  42. })
  44. app.on('activate', () => {
  45.   if (BrowserWindow.getAllWindows().length === 0) {
  46.     createWindow()
  47.   }
  48. })
  1. const { contextBridge, ipcRenderer } = require('electron')
  3. contextBridge.exposeInMainWorld('electron', {
  4.   startDrag: (fileName) => {
  5.     ipcRenderer.send('ondragstart', fileName)
  6.   }
  7. })
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4.     <meta charset="UTF-8">
  5.     <title>Hello World!</title>
  6.     <meta http-equiv="Content-Security-Policy" content="script-src 'self' 'unsafe-inline';" />
  7. </head>
  8. <body>
  9.     <h1>Hello World!</h1>
  10.     <p>Drag the boxes below to somewhere in your OS (Finder/Explorer, Desktop, etc.) to copy an example markdown file.</p>
  11.     <div style="border:2px solid black;border-radius:3px;padding:5px;display:inline-block" draggable="true" id="drag1">Drag me - File 1</div>
  12.     <div style="border:2px solid black;border-radius:3px;padding:5px;display:inline-block" draggable="true" id="drag2">Drag me - File 2</div>
  13.     <script src="renderer.js"></script>
  14. </body>
  15. </html>
  1. document.getElementById('drag1').ondragstart = (event) => {
  2.   event.preventDefault()
  3.   window.electron.startDrag('drag-and-drop-1.md')
  4. }
  6. document.getElementById('drag2').ondragstart = (event) => {
  7.   event.preventDefault()
  8.   window.electron.startDrag('drag-and-drop-2.md')
  9. }

After launching the Electron application, try dragging and dropping the item from the BrowserWindow onto your desktop. In this guide, the item is a Markdown file located in the root of the project:

Drag and drop