跳转到主要内容

原生文件拖放

概述​

某些操作文件的应用程序可能希望支持操作系统的原生文件拖放功能。将文件拖动到网页内容中很常见，并且许多网站都支持此功能。Electron 此外还支持将文件和内容从网页内容拖动到操作系统世界。

为了在你的应用程序中实现此功能，你需要响应 ondragstart 事件时调用 webContents.startDrag(item) API。

示例​

一个示例，演示如何动态创建一个文件，以便将其从窗口中拖出。

Preload.js​

在 preload.js 中，使用 contextBridge 注入一个方法 window.electron.startDrag(...)，该方法将发送一个 IPC 消息到主进程。

const { contextBridge, ipcRenderer } = require('electron')

contextBridge.exposeInMainWorld('electron', {
  startDrag: (fileName) => ipcRenderer.send('ondragstart', fileName)
})

Index.html​

将一个可拖动的元素添加到 index.html 中，并引用你的渲染器脚本

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

Renderer.js​

在 renderer.js 中，设置渲染器进程来处理拖放事件，通过调用你通过 contextBridge 上面添加的方法。

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

Main.js​

在主进程 (main.js 文件) 中，扩展接收到的事件，添加被拖动文件的路径和一个图标

docs/fiddles/features/drag-and-drop (40.0.0)在 Fiddle 中打开
const { app, BrowserWindow, ipcMain } = require('electron/main')
const path = require('node:path')
const fs = require('node:fs')
const https = require('node:https')

function createWindow () {
  const win = new BrowserWindow({
    width: 800,
    height: 600,
    webPreferences: {
      preload: path.join(__dirname, 'preload.js')
    }
  })

  win.loadFile('index.html')
}

const iconName = path.join(__dirname, 'iconForDragAndDrop.png')
const icon = fs.createWriteStream(iconName)

// Create a new file to copy - you can also copy existing files.
fs.writeFileSync(path.join(__dirname, 'drag-and-drop-1.md'), '# First file to test drag and drop')
fs.writeFileSync(path.join(__dirname, 'drag-and-drop-2.md'), '# Second file to test drag and drop')

https.get('https://img.icons8.com/ios/452/drag-and-drop.png', (response) => {
  response.pipe(icon)
})

app.whenReady().then(createWindow)

ipcMain.on('ondragstart', (event, filePath) => {
  event.sender.startDrag({
    file: path.join(__dirname, filePath),
    icon: iconName
  })
})

app.on('window-all-closed', () => {
  if (process.platform !== 'darwin') {
    app.quit()
  }
})

app.on('activate', () => {
  if (BrowserWindow.getAllWindows().length === 0) {
    createWindow()
  }
})

启动 Electron 应用程序后，尝试将 BrowserWindow 中的项目拖放到你的桌面上。在本指南中，该项目是位于项目根目录中的一个 Markdown 文件

Drag and drop