【前端开发实例】HTML 检索内容关键字 JS 高亮显示 -（二）

程序员文章站 2022-05-28 22:30:05

...

Question. 问题

在开发过程中，我们会遇到需要高亮显示的文本，无论是新闻、产品还是案例的检索，对于检索到的内容，都会产生这样的需求，一种好的处理方式就是通过 JS 实现。先来看看 PC 端的百度和移动端的微信的检索结果：

Solution. 解决

我们先来看一段简化的 JS 来实现关键字高亮显示的功能：

function setHeightKeyWord(keyword) {
    /* 获取需要处理的关键字 */
    var tempHTML = $("#text").html();
    /* 关键字替换文本 该文本设置有高亮颜色 */
    var replaceText = "<font style='color:red;'>$1</font>";
    /* 关键字正则匹配规则 */
    var r = new RegExp("(" + keyword + ")", "ig");
    /* 将匹配到的关键字替换成我们预设的文本 */
    tempHTML = tempHTML.replace(r, replaceText);
    /* 将文本显示到浏览器上 */
    $("#text").html(tempHTML);
}

思路很简单，就是通过正则将匹配到的关键字替换成我们预设的 HTML 片段，这个 HTML 片段通过 CSS 实现文本变色。

调用：

<body style="line-height: 40px;">
    <div>关键字: <input type="text" name="keyword" id="keyword">
        <button id="btn">高亮</button>
    </div>
    <div id="text">高亮显示文章中的关键字。</div>
</body>

<script type="text/javascript">
$(function() {
    $("#btn").click(function() {
        var $keyword = $("#keyword").val();
        setHeightKeyWord($keyword)
    });
});
</script>

【前端开发实例】HTML 检索内容关键字 JS 高亮显示 -（二）

将关键字输入到 input 框中，就能将这个关键字高亮显示。

Extension. 扩展

这是从 javascript 对html内容的关键字高亮显示中转载过来的一个不错的封装，一个对多个关键字用不同颜色高亮显示的 JS 代码：

/** 
 * 高亮显示关键字, 构造函数 
 * @param {} colors 颜色数组，其中每个元素是一个 '背景色,前景色' 组合 
 */  
var Highlighter = function(colors) {  
 this.colors = colors;  
 if (this.colors == null) {  
  //默认颜色  
  this.colors = ['#ffff00,#000000','#dae9d1,#000000','#eabcf4,#000000',  
  '#c8e5ef,#000000','#f3e3cb, #000000', '#e7cfe0,#000000',  
  '#c5d1f1,#000000','#deeee4, #000000','#b55ed2,#000000',   
  '#dcb7a0,#333333', '#7983ab,#000000', '#6894b5, #000000'];  
 }  
}  

/** 
 * 高亮显示关键字 
 * @param {} node    html element 
 * @param {} keywords  关键字， 多个关键字可以通过空格隔开， 其中每个关键字会以一种颜色显式 
 *  
 * 用法： 
 * var hl = new Highlighter(); 
 * hl.highlight(document.body, '这个 世界 需要 和平'); 
 */  
Highlighter.prototype.highlight = function(node, keywords) {  
 if (!keywords || !node || !node.nodeType || node.nodeType != 1)  
  return;  

 keywords = this.parsewords(keywords);  
 if (keywords == null)  
  return;  

 for (var i = 0; i < keywords.length; i++) {  
  this.colorword(node, keywords[i]);  
 }  
}  

/** 
 * 对所有#text的node进行查找，如果有关键字则进行着色 
 * @param {} node 节点 
 * @param {} keyword 关键字结构体，包含了关键字、前景色、背景色 
 */  
Highlighter.prototype.colorword = function(node, keyword) {  
 for (var i = 0; i < node.childNodes.length; i++) {  
  var childNode = node.childNodes[i];  

  if (childNode.nodeType == 3) {  
   //childNode is #text  
   var re = new RegExp(keyword.word, 'i');  
   if (childNode.data.search(re) == -1) continue;  
   re = new RegExp('(' + keyword.word + ')', 'gi');  
   var forkNode = document.createElement('span');  
   forkNode.innerHTML = childNode.data.replace(re, '<span style="background-color:'+keyword.bgColor+';color:'+keyword.foreColor+'" mce_style="background-color:'+keyword.bgColor+';color:'+keyword.foreColor+'">$1</span>');  
   node.replaceChild(forkNode, childNode);  
  }  
  else if (childNode.nodeType == 1) {  
   //childNode is element  
   this.colorword(childNode, keyword);  
  }  
 }  
}  

/** 
 * 将空格分隔开的关键字转换成对象数组 
 * @param {} keywords 
 * @return {} 
 */  
Highlighter.prototype.parsewords = function(keywords) {  
 keywords = keywords.replace(//s+/g, ' ');  
 keywords = keywords.split(' ');  
 if (keywords == null || keywords.length == 0)  
  return null;  

 var results = [];  
 for (var i = 0; i < keywords.length; i++) {  
  var keyword = {};  
  var color = this.colors[i % this.colors.length].split(',');  
  keyword.word = keywords[i];  
  keyword.bgColor = color[0];  
  keyword.foreColor = color[1];  
  results.push(keyword);  
 }  
 return results;  
}  

/** 
 * 按照字符串长度，由长到短进行排序 
 * @param {} list 字符串数组 
 */  
Highlighter.prototype.sort = function(list) {  
 list.sort(function(e1, e2) {  
  return e1.length < e2.length;  
 });  
}

调用：

var hl = new Highlighter();  
hl.highlight(document.body, '文本1 文本2 文本3');

【前端开发实例】HTML 检索内容 关键字 JS 高亮显示 -（二）

Question. 问题

Solution. 解决

Extension. 扩展

【前端开发实例】HTML 检索内容 关键字 JS 高亮显示 -（二）

【前端开发实例】HTML 检索内容关键字 JS 高亮显示 -（二）

【前端开发实例】HTML 检索内容关键字 JS 高亮显示 -（二）