前端-热键开发

最近开发热键功能,有所感悟。
从产品的角度思考,希望客户可以操作简单一点,通过上下左右方向键可以聚焦不同的元素,方便用户操作。
从技术的角度思考

  • 问题1 键盘事件的监听
  • 问题2 这个是一个全局的行为
  • 问题3 我需要找到当前聚焦元素距离上 下 左 右最近的元素,并且聚焦。
首先问题1

因为键盘原生的左右是用来调整input 聚焦位置的,所以优先考虑组合件比如option+上。
github上找到mousetrap 键盘快捷键库。

问题2

全局行为的话,可以在main.ts里面注册。可以实现一个hooks。

问题3

这个也是最重要的。
逻辑: 触发键盘按钮找到所有的可以聚焦的元素,算出每个元素距离上 左的距离。拿到当前聚焦的元素。如果是左右键 直接在所有可以聚焦的list里面找到当前聚焦的元素,左键就是他的上一个,右键就是他的下一个。上下键的逻辑比较复杂,如果是上 ,需要找到距离聚焦元素最近的所有元素,如果只有一个直接聚焦,如果是多个,继续判断left,距离最近的所有元素每个元素的left - 聚焦元素的left取绝对值。取到最小值的下标,选中这个下标对应el元素即可。下也同理。只是判断的是 bottom 而已。
代码如下

import Mousetrap from "mousetrap";
import "@/utils/mousetrap/index";

type EleArr = {
  el: HTMLElement;
  top: number;
  left: number;
};

const useHotKeys = async () => {
  let eleArr: EleArr[] = [];

  function setEleArr() {
    eleArr = [];
    let dom = document.body.classList.contains("el-popup-parent--hidden")
      ? Array.from(document.body.querySelectorAll("#app>.el-overlay")).at(-1)
      : document.querySelector(".el-main");
    if (!dom) {
      return;
    }
    const focusableElements = dom.querySelectorAll("a[href], input, select, textarea");
    focusableElements.forEach(element => {
      const rect = element.getBoundingClientRect();
      if (rect.top || rect.left) {
        eleArr.push({
          el: element as HTMLElement,
          top: rect.top + window.scrollY + (element.classList.contains("el-select__input") ? -7 : 0),
          left: rect.left + window.scrollX
        });
      }
    });
  }

  function getFocusedEle() {
    return document.activeElement as HTMLElement;
  }

  function operateKeys(type) {
    if (!eleArr.length) {
      return;
    }
    const el = getFocusedEle();
    if (el) {
      const eleIndex = eleArr.map(item => item.el).indexOf(el);
      let activeEle = eleArr.at(eleIndex);
      switch (type) {
        case "left":
          eleArr.at(eleIndex - 1)!.el.focus();
          break;
        case "right":
          let index = eleIndex + 1 >= eleArr.length ? 0 : eleIndex + 1;
          eleArr.at(index)!.el.focus();
          break;
        case "up":
          if (activeEle) {
            // 先找到在上它上面的所有元素
            const underList = eleArr.filter(item => item.top < activeEle!.top);
            if (underList.length) {
              let mapTop = underList.map(item => item.top);
              let maxTopItem = underList[mapTop.indexOf(Math.max(...mapTop))];
              const recentlyEleList = eleArr.filter(item => item.top == maxTopItem!.top);
              if (recentlyEleList.length == 1) {
                recentlyEleList[0].el.focus();
                break;
              }
              const numList = recentlyEleList.map(item => {
                return Math.abs(item.left - activeEle!.left);
              });
              const minIndex = numList.indexOf(Math.min(...numList));
              if (minIndex != -1) {
                recentlyEleList[minIndex].el.focus();
              }
            }
          }
          break;
        case "down":
          if (activeEle) {
            // 先找到在它下面的所有元素
            const underList = eleArr.filter(item => item.top > activeEle!.top);
            if (underList.length) {
              const recentlyEleList = eleArr.filter(item => item.top == underList.at(0)!.top);
              if (recentlyEleList.length == 1) {
                recentlyEleList[0].el.focus();
                break;
              }
              const numList = recentlyEleList.map(item => {
                return Math.abs(item.left - activeEle!.left);
              });
              const minIndex = numList.indexOf(Math.min(...numList));
              if (minIndex != -1) {
                recentlyEleList[minIndex].el.focus();
              }
            }
          }
          break;
        default:
          console.warn("无效的指令");
          break;
      }
      // let elLeft = el.getBoundingClientRect().left + window.scrollX;
      // let elTop = el.getBoundingClientRect().top + window.scrollX;
    } else {
      if (eleArr.length) {
        eleArr[0].el.focus();
      }
    }
  }

  const toNext = () => {
    setEleArr();
    operateKeys("down");
  };

  const toPrev = () => {
    setEleArr();
    operateKeys("up");
  };

  const toLeft = () => {
    setEleArr();
    operateKeys("left");
  };

  const toRight = () => {
    setEleArr();
    console.log(eleArr);
    operateKeys("right");
  };

  return { toNext, toPrev, toLeft, toRight };
};

// 添加键盘事件
export const addKeyBoard = async () => {
  const { toLeft, toRight, toNext, toPrev } = await useHotKeys();
  Mousetrap.bindGlobal("option+up", () => {
    toPrev();
    return false;
  });
  Mousetrap.bindGlobal("option+down", () => {
    toNext();
    return false;
  });
  Mousetrap.bindGlobal("option+left", () => {
    toLeft();
    return false;
  });
  Mousetrap.bindGlobal("option+right", () => {
    toRight();
    return false;
  });
};

以上js在main.ts 里面引入addKeyBoard方法调用即可
解释

因为还有弹框所以判断了
let dom = document.body.classList.contains("el-popup-parent--hidden")
      ? Array.from(document.body.querySelectorAll("#app>.el-overlay")).at(-1)
      : document.querySelector(".el-main");
因为mousetrap在input里面实现键盘事件,需要安装插件。可以在官网找到。
import Mousetrap from "mousetrap";
import "@/utils/mousetrap/index";


// @/utils/mousetrap/index  内容
(function (a) {
  let c = {},
    d = a.prototype.stopCallback;
  a.prototype.stopCallback = function (e, b, a, f) {
    return this.paused ? !0 : c[a] || c[f] ? !1 : d.call(this, e, b, a);
  };
  a.prototype.bindGlobal = function (a, b, d) {
    this.bind(a, b, d);
    if (a instanceof Array) for (b = 0; b < a.length; b++) c[a[b]] = !0;
    else c[a] = !0;
  };
  a.init();
})(Mousetrap);

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

推荐阅读更多精彩内容