HTML高亮关键字的实现代码


Posted in HTML / CSS onOctober 22, 2018

本以为一个 innerHTML replace 就能实现的简单操作,却遇到了许多的问题。本文就记录这些问题和最终的完美解决办法, 希望能对有同样遭遇的小伙伴有所帮助。只对结果感兴趣的,忽略过程,直接跳过看结果吧~

常用做法:正则替换

思路:要想高亮元素,那么需要将关键字提取出来用标签包裹,然后对标签进行样式调整。使用 innerHTML,或 outHTML, 而不能使用 innerText,outText。

const regex = new RegExp(keyword,"g")
element.innerHTML = element.innerHTML.replace(regex,"<b class="a">"+keyword+"</b>")
element.classList.add("highlight")

这样做存在的隐患有如下:

  • keyword 如果是 ()\ 等正则对象的关键字将会构建正则对象失败。(可以通过转义解决)
  • keyword 如果是一些 HTML 标签如 div 将会对 innerHTML 进行错误的替换
  • keyword 如果和一些DOM属性名、值相同,也会导致异常替换。如下当 keyword 为 test 时,会将 class 名也错误的替换掉:
<div id="parent">
    <div class="test">test</div>
  </div>

关键字父节点 element 通过 class 来进行背景染色处理,对原始DOM有一定程度污染,可能对 element 再次定位造成影响。(作为插件希望尽可能少改变原始DOM)

正则优化一:仅处理位于标签内的元素

var formatKeyword = text.replace(/[-\/\\^$*+?.()|[\]{}]/g, '\\$&') // 转义处理keyword包含的特殊字符,如 /.
var finder = new RegExp(">.*?"++".*?<") // 提取位于标签内的文本,避免误操作 class、id 等

element.innerHTML = element.innerHTML.replace(finder,function(matched){
        return matched.replace(text,"<br>"+text+</br>)
})// 对提取的标签内文本进行关键字替换

以能解决大多数问题,但依旧存在的问题是,只要标签属性存在类似 < 符号,将会打破匹配规则导致正则提取内容错误, HTML5 dataset 可以自定义任意内容,故这些特殊字符是无法避免的。

<div dataset="p>d">替换</div>

正则优化二:清除可能影响的标签

<div id="keyword">keyword</div>
  =》将闭合标签用变量替换
  [replaced1]keyword[replaced2]//闭合标签内 id="keyword" 不会被处理
  =》
  [replaced1]<b>keyword</b>[replaced2]
  =》将暂存变量 replaced 替换为原先标签
  <div id="keyword"><b>keyword</b></div>

这种思路及源码从这里来, 但存在问题是:

  • 如果 [replaced1] 包含 keyword, 那么替换时将发生异常
  • 最重要的,当标签值中包含 <> 符号时,此方法也不能正确的提取标签

总之在经过了N多尝试之后,通过正则都没能有效的处理各种情况。然后换了个思路,不通过字符串的方式,通过节点处理。element.childNodes 可以最有效的清理标签内的干扰信息。

[完美解决方案]通过 DOM 节点处理

<div id="parent">
    keyword 1
  <span id="child">
    keyword 2
  </span>
 </div>

通过 parent.childNodes 得到所有子节点。child 节点可以通过 innerText.replce(keyword,result) 的方式替换得到想要的高亮效果,如下: <span id="child"><b>keyword</b> 2</span> (递归处理:当child节点不含子节点时进行replace操作)。

但是 keyword 1 是属于文本节点,只能修改文本内容,无法增加 HTML,更无法单独控制其样式。而文本节点也不能转换为普通节点,这也是最苦恼的事情。

最后~,本文的重点来了,因为这个功能,让我第一次认真接触到了文本节点这个东西。从这里发现了Text,使用切割文本节点并替换的方式实现高亮。

源码以及还原高亮见源码

const reg = new RegExp(keyword.replace(/[-\/\\^$*+?.()|[\]{}]/g, '\\$&'))
highlight = function (node,reg){
    if (node.nodeType == 3) {  //只处理文本节点
        const match = node.data.match(new RegExp(reg));
        if (match) {
          const highlightEl = document.createElement("b");
          highlightEl.dataset.highlight="y"
          const wordNode = node.splitText(match.index)
          wordNode.splitText(match[0].length); // 切割成前 关键词 后三个Text 节点
          const wordNew = document.createTextNode(wordNode.data);
          highlightEl.appendChild(wordNew);//highlight 节点构建成功
          wordNode.parentNode.replaceChild(highlightEl, wordNode);// 替换该文本节点
        }
    } else if (node.nodeType == 1 && node.dataset.highlight!="y"
    ) {
        for (var i = 0; i < node.childNodes.length; i++) {
            highlight(node.childNodes[i], reg);
            i++
        }
    }  
}

最后,留个彩蛋,以上方法也是存在一个小 bug 的,有兴趣可以去发现一下。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

HTML / CSS 相关文章推荐
深入理解css属性的选择对动画性能的影响
Apr 20 HTML / CSS
CSS3 创建网页动画实现弹跳球动效果
Oct 30 HTML / CSS
CSS3 实现发光边框特效
Nov 11 HTML / CSS
基于Modernizr 让网站进行优雅降级的分析
Apr 21 HTML / CSS
html5弹跳球示例代码
Jul 23 HTML / CSS
html5+svg学习指南之SVG基础知识
Dec 17 HTML / CSS
调用HTML5的Canvas API绘制图形的快速入门指南
Jun 17 HTML / CSS
HTML5、Select下拉框右边加图标的实现代码(增进用户体验)
Oct 16 HTML / CSS
配置H5的滚动条样式的示例代码
Mar 09 HTML / CSS
HTML5实现视频弹幕功能
Aug 09 HTML / CSS
HTML table 表格边框的实现思路
Oct 12 HTML / CSS
html2canvas生成的图片偏移不完整的解决方法
May 19 HTML / CSS
详解rem 适配布局
Oct 31 #HTML / CSS
H5 canvas中width、height和style的宽高区别详解
Nov 02 #HTML / CSS
使用HTML5 IndexDB存储图像和文件的示例
Nov 05 #HTML / CSS
canvas像素画板的实现代码
Nov 21 #HTML / CSS
详解使用canvas保存网页为pdf文件支持跨域
Nov 23 #HTML / CSS
websocket+sockjs+stompjs详解及实例代码
Nov 30 #HTML / CSS
HTML5中通过li-canvas轻松实现单图、多图、圆角图绘制,单行文字、多行文字等
Nov 30 #HTML / CSS
You might like
第五节 克隆 [5]
2006/10/09 PHP
php返回相对时间(如:20分钟前,3天前)的方法
2015/04/14 PHP
PHP如何实现Unicode和Utf-8编码相互转换
2015/07/29 PHP
fsockopen pfsockopen函数被禁用,SMTP发送邮件不正常的解决方法
2015/09/20 PHP
javascript showModalDialog模态对话框使用说明
2009/12/31 Javascript
jquery last-child 列表最后一项的样式
2010/01/22 Javascript
javascript跨域刷新实现代码
2011/01/01 Javascript
js几秒以后倒计时跳转示例
2013/12/26 Javascript
移动节点的jquery代码
2014/01/13 Javascript
简单选项卡 js和jquery制作方法分享
2014/02/26 Javascript
angularJS结合canvas画图例子
2015/02/09 Javascript
Javascript中的高阶函数介绍
2015/03/15 Javascript
详解Node.js模块间共享数据库连接的方法
2016/05/24 Javascript
静态页面html中跳转传值的JS处理技巧
2016/06/22 Javascript
Vue.js每天必学之组件与组件间的通信
2016/09/08 Javascript
JavaScript中使用webuploader实现上传视频功能(demo)
2017/04/10 Javascript
layui导航栏实现代码
2017/05/19 Javascript
JS逻辑运算符短路操作实例分析
2018/07/09 Javascript
Vue.js 十五分钟入门图文教程
2018/09/12 Javascript
浅谈webpack devtool里的7种SourceMap模式
2019/01/14 Javascript
JavaScript使用表单元素验证表单的示例代码
2019/08/20 Javascript
Node使用Nodemailer发送邮件的方法实现
2020/02/24 Javascript
vue实现给div绑定keyup的enter事件
2020/07/31 Javascript
js实现纯前端压缩图片
2020/11/16 Javascript
[01:08:56]DOTA2-DPC中国联赛 正赛 Magma vs LBZS BO3 第一场 2月7日
2021/03/11 DOTA
基于python 爬虫爬到含空格的url的处理方法
2018/05/11 Python
python自动化报告的输出用例详解
2018/05/30 Python
Python利用matplotlib做图中图及次坐标轴的实例
2019/07/08 Python
基于HTML5 的人脸识别活体认证的实现方法
2016/06/22 HTML / CSS
美国巧克力喷泉品牌:Sephra
2019/05/05 全球购物
锐步英国官网:Reebok英国
2019/11/29 全球购物
全球领先的中国制造商品在线批发平台:DHgate
2020/01/28 全球购物
如何写毕业求职自荐信
2013/11/06 职场文书
个人总结与自我评价2015
2015/03/11 职场文书
学校工会工作总结2015
2015/05/19 职场文书
详解Mysql和Oracle之间的误区
2021/05/18 MySQL