Electron 无边框窗口的拖动

操作系统原生的窗口样式中规中矩,看久了却难免会有些厌烦。所以在使用 electron 创建桌面应用的时候,有时候我们希望能完全掌控窗口的样式,而隐藏掉系统提供的窗口边框和标题栏等。

通过在创建窗口的时候,指定{frame:false}{titleBarStyle: 'hidden'}(macOS only)即可达到隐藏边框的效果,甚至可以通过 {transparent:true}来指定窗口透明,创建异形的窗口呈现。具体可见官方文档,这里不再赘述。

一个值得一提的问题是窗口的拖动。因为没有标题栏,所以需要自行实现窗口的拖动区域,否则就没法移动窗口位置了。可能的实现方案有下面几种:

方案一: -webkit-app-region: drag;

官方文档里有详细说明:

默认情况下, 无框窗口是 non-draggable 的。 应用程序需要指定 `-webkit-app-region: drag` 在 CSS 中告诉Electron哪个区域是可拖拽的 (像 OS 的标准标题栏), 并且应用程序也可以使用 `-webkit-app-region: no-drag` 来排除 draggable region 中的 non-draggable 区域。 请注意, 当前只支持矩形形状。

要使整个窗口可拖拽, 您可以添加 `-webkit-app-region: drag` 作为 `body` 的样式:

<body style="-webkit-app-region: drag"></body>

请注意, 如果您已使整个窗口draggable, 则必须将按钮标记为 non-draggable, 否则用户将无法单击它们:

button {  -webkit-app-region: no-drag; }

如果你设置自定义标题栏为 draggable, 你也需要标题栏中所有的按钮都设为 non-draggable。

试下来拖拽效果很完美。但是,文档后面提到了这种方法较为致命的一个问题:

在某些平台上, 可拖拽区域将被视为 non-client frame, 因此当您右键单击它时, 系统菜单将弹出。 要使上下文菜单在所有平台上都正确运行, 您永远也不要在可拖拽区域上使用自定义上下文菜单。

不仅右键菜单,设置了这个样式的元素几乎无法响应所有的鼠标事件,包括点击、拖拽等。如果需要拖拽整个窗口,就相当尴尬了。

方案二:通过响应页面的 mousemove 事件

既然我们需要页面能够响应鼠标事件,那能不能就通过鼠标事件去解决问题呢?这是作为一名前端开发人员很容易想到的方案:通过网页的 mousemove 事件,我们可以得知当前鼠标在网页上的坐标,并与上一次的坐标进行比较,得出鼠标的位移数值。

然后,我们可以通过当前 electron 窗口上的 getPosition 方法获取窗口当前位置,加上鼠标位移得出新的位置,然后通过 setPosition 方法手动移动窗口,达到拖动的效果。

是不是看上去很美?很可惜不能高兴得太早。网页上的两次 mousemove 事件之间有一定时间间隔,这个间隔对于桌面客户端编程来说有点太长了。这就导致在性能比较差的情况下,有可能出现这样的情况:鼠标移动过快,移出了窗口的范围,而下一次 mousemove 还没来得及触发。这样窗口就跟不上鼠标,“掉下来”了……

方案三:electron-drag

在一度绝望的时候,发现了 electron-drag 这个库和它天才的想法:通过一个原生 Node.js 模块,跟踪鼠标在整个屏幕上的位移,然后手动设置窗口的位置。

这个库只在 Windows 和 macOS 下可用,不支持 Linux。因此,在不支持的平台上,需要使用方案一或者方案二进行容。

一个小插曲

在 Windows 上引用 electron-drag 时可能会抛出 Uncaught Error: A dynamic link library (DLL) initialization routine failed 的错误(macOS 上暂未遇到,不确定是否也有)。这是因为该库使用 win-mouseosx-mouse 这两个原生模块进行鼠标位置的追踪,而 electron 和系统中安装的 Node.js 程序头文件未必相同,要使用原生模块必须使用正确版本的头文件进行编译。解决方式是安装 electron-rebuild 重新编译对应的模块。Windows 下的操作如下:

electron-rebuild -f -w win-mouse

最后上代码(TypeScript):

export function makeDraggable(el: HTMLElement | string) {
    if (typeof el === 'string') { el = document.querySelector(el) as HTMLElement; }
    try {
        const drag = require('electron-drag');
        if (drag.supported) {
            drag(el);

        } else {
            makeDraggableFallback(el);
        }
    } catch (ex) {
        makeDraggableFallback(el);
    }
}

function makeDraggableFallback(el: HTMLElement) {
    // 方案一
    // el.style['-webkit-app-region'] = 'drag';

    // 方案二
    let dragging = false;
    let mouseX = 0;
    let mouseY = 0;
    el.addEventListener('mousedown', (e) => {
        dragging = true;
        const { pageX, pageY } = e;
        mouseX = pageX;
        mouseY = pageY;
    });
    window.addEventListener('mouseup', () => {
        dragging = false;
    });
    window.addEventListener('mousemove', (e: MouseEvent) => {
        if (dragging) {
            const { pageX, pageY } = e;
            const win = require('electron').remote.getCurrentWindow();
            const pos = win.getPosition();
            pos[0] = pos[0] + pageX - mouseX;
            pos[1] = pos[1] + pageY - mouseY;
            win.setPosition(pos[0], pos[1], true);
        }
    });
}
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,793评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,567评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,342评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,825评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,814评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,680评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,033评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,687评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,175评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,668评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,775评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,419评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,020评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,206评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,092评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,510评论 2 343

推荐阅读更多精彩内容

  • 本节介绍各种常见的浏览器事件。 鼠标事件 鼠标事件指与鼠标相关的事件,主要有以下一些。 click 事件,dblc...
    许先生__阅读 2,419评论 0 4
  • 开始教程之前,请允许我假设你已经有了一个常用的的编辑器(或者 IDE),系统中也安装了Node.js 和 npm,...
    程序人生_小龙阅读 49,785评论 1 38
  • 相信对于很多前端的同学来说,拖动并不陌生,网上随随便便搜一下能搜出很多关于拖动的文章,github上也有很多关于拖...
    Zoro1990阅读 1,317评论 2 2
  • 之前写过一篇浏览器事件的相关操作和事件运行的原理——JavaScript浏览器事件解析。这一篇主要写一些常用的事件...
    faremax阅读 1,601评论 0 0
  • 我时常见到你当梦在午夜安巣的时候你的身影是天空的蓝是云朵的白是湖水的绿是山川的青是我心间不曾熄灭的爱!我总在想能用...
    奔着长安去阅读 275评论 0 5