textarea中使用TAB --- 使用javascript触发一个键盘输入事件

代码借鉴自MDNstackoverflow
想写一个markdown在线编辑器,使用textarea作为编辑器,但在使用Tab键时出了问题
2019-5-7 更新,在思否上得到了网友的帮助,问题完美解决

0. 问题

  • 使用tab键会将当前的焦点从textarea中移出
  • 移出后,原textarea中也不会输入缩进

1. 关于焦点

  • 按下TAB的焦点移出,是该键盘事件的默认行为,只要阻止默认行为即可

2. 输入

  • 阻止默认行为后,虽然焦点不会切换了,但是不会输入缩进
  • 思路 :
  1. 手动在光标所在位置插入两个空格
    • 难点在于如何获取光标当前的位置,并在该位置插入空格
    • 暂时没有再深入考虑
  2. 使用js触发两次键盘事件,输入两个空格
    • 第一个想到的是使用jquerytrigger(),但想使用原生的方式
    • 在网上找到的都是已经过时的方法,使用createEvent()来创建事件,使用initKeyEvent()来设置该键盘事件的触发按键
    • 上面的方法都已经过时,MDN上提供了新的替代方法,大概思路差不多,手动创建一个事件,并使用js方法来触发该事件

3.1. 一个简单的示例

<button onclick="alert('u got it')">click me</button>

<script>
  let btn = document.querySelector('button');
  let e = new MouseEvent('click',{
    view : window,
    bubbles : true,
    cancelable : true
  });
  btn.dispatchEvent(e);
</script>
  • 相对于过时的createEvent()方法不同的是,现在的方法需要在创建事件时,就确定该事件的事件类型(键盘事件或者鼠标事件),并且,事件的初始化可以在创建事件的时候就通过第二个参数来确定
  • 关于创建鼠标事件键盘事件的参数,都可以在MDN中查到,不再赘述

3.2. 回到最初的问题

let text = document.querySelector('textarea');

text.onkeydown = ()=>{
  if(event.key === "Tab"){
    event.preventDefault();
    const ke = new KeyboardEvent("keydown", {
      bubbles: true, cancelable: true, keyCode: 32
    });
    text.dispatchEvent(ke);
  }
  if(event.keyCode === 32){
    alert('got insert');
  }
}   
  • 写出这样一段代码,确实可以弹窗,表示已经触发了按下空格的事件,但却并不会有空格出现。
  • 问题应该是键盘按下事件,并不等于输入事件,尝试触发输入事件?
let text = document.querySelector('textarea');
text.oninput = ()=>{
  console.log(event);
}
text.onkeydown = ()=>{
  if(event.key === "Tab"){
    event.preventDefault();
    const ke = new InputEvent("input", {
      data : "sss"
    });
    text.dispatchEvent(ke);
  }
}  
text.oninput = ()=>{
  console.log('got insert');
}
  • 改了改代码,还是一样,能够监听到input事件,但是仍然没有相应的输入,换个思路?

4. 回到第一个思路

上一个思路遇到了瓶颈,换回最初的思路试试

4.1. 先获取当前的光标位置

4.2. 插入字符串

  • 但通过上面这两个属性,需要自己拼接字符串,newStr = strBefore + "Tab" + strAfter,
  • 找到了这个方法,可以替换选中区域的字符串为指定的字符串
    MDN --- setRangeText()
  • 尝试一下
let text = document.querySelector('textarea');
text.onkeydown = ()=>{
  if(event.key === "Tab"){
    event.preventDefault();
    text.setRangeText("  ");  // 输入两个空格作为tab
    text.selectionStart += 2;  // 输入后将光标后移
  }
}

5. 不完美解决

功能稍作完善,问题解决

let text = document.querySelector('textarea');

text.onkeydown = ()=>{
  if(event.key === "Tab"){    //  单行或者多行缩进
    event.preventDefault();
    let selectionStart = text.selectionStart;
    let selectionEnd = text.selectionEnd;   
    if(selectionEnd !== selectionStart){
      let textValue = text.value;
      let strBefore = textValue.slice(0,selectionStart);
      let lineStart = strBefore.lastIndexOf('\n') + 1;
      text.setRangeText('  ',lineStart,lineStart);
      strBetween = textValue.slice(selectionStart,selectionEnd);
      text.setRangeText(strBetween.replace('\n','\n  '));
    }
    else{    // 写入一个tab
      text.setRangeText("  ");
      text.selectionStart += 2;
    }
  }
}
  • 上面代码虽然实现了我想要的功能,但是有一点问题,使用tab之后,因为是使用js代码插入的字符,不能使用Ctrl+z来撤销,尤其是多行缩进后,使用撤销时,很影响用户体验
  • 我自己暂时想不到解决的办法,如果有谁有好的建议,欢迎提出来帮我完善这个功能,感激不尽

6. 完美解决

  • 在思否上提了个问题,得到了完美的解决方案,问题在这 --- 思否
  • 使用execCommand()进行的操作可以使用Ctrl+z来撤销,正是我要的结果
  • 修改后的代码如下:
function onKeyPress(){
  if(event.code !== "Tab") return true;

  event.preventDefault();

  let start = this.selectionStart;
  let end = this.selectionEnd;
  if(start === end){
    document.execCommand('insertText',false,"  ");
  }
  else{
    let strBefore = this.value.slice(0,start);
    let curLineStart = strBefore.includes('\n')?strBefore.lastIndexOf('\n')+1 : 0;
    let strBetween = this.value.slice(curLineStart,end+1);
    let newStr = "  " + strBetween.replace(/\n/g,'\n  ');
    let lineBreakCount = strBetween.split('\n').length;
    let newStart = start + 2;
    let newEnd = end + (lineBreakCount + 1)*2;

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