问小白 wenxiaobai
资讯
历史
科技
环境与自然
成长
游戏
财经
文学与艺术
美食
健康
家居
文化
情感
汽车
三农
军事
旅行
运动
教育
生活
星座命理

CSS文本自定义高亮API详解与实战

创作时间:
作者:
@小白创作中心

CSS文本自定义高亮API详解与实战

引用
1
来源
1.
https://www.zhangxinxu.com/wordpress/2024/07/css-custom-highlight-api/

CSS Custom Highlight API是一个新的Web标准,它允许开发者通过JavaScript创建文本高亮效果,并使用CSS伪元素::highlight()来设置高亮样式。这个API在现代浏览器中已经得到了广泛支持,可以用于实现搜索高亮、代码高亮等多种应用场景。本文将详细介绍如何使用这个API实现文本高亮效果,并通过一个隐藏手机号码的案例进行演示。

一、前言

本周实操一下CSS Custom Highlight API。首先,Firefox浏览器最近也支持了上述API,至此,现代浏览器完成了大统一,可以学起来了。

这个API虽然以CSS开头,但是要实际应用,需要对JavaScript有一定积累的开发人员才能驾驭。不过好的是什么呢,其几个经典的应用场景,例如搜索高亮(MDN文档有案例,见下图1),或者源代码高亮(这里有案例,见下图2),相关的JS代码都是固定的,大家直接复制粘贴就可以使用了。

历史经验告诉我,外面的站点都不靠谱,过个5年10年的,这些地址都不能访问了,所以,我做了个备份地址,以备不时之需。

分别参见:

  • CSS Highlight API文本高亮搜索demo
  • CSS Custom Highlight API实现代码高亮demo

OK,下面开始正式介绍如何自DIY一个文本高亮效果。

二、文本高亮四步骤

实现CSS纯文本高亮需要下面四步:

  1. 创建Range对象(使用JS);
  2. 使用第一步创建的range创建Highlight对象(使用JS);
  3. 使用HighlightRegistry方法注册上一步创建的Highlight对象(使用JS);
  4. 使用::highlight()伪元素让设置注册的文本选区样式(使用CSS);

由此可见,CSS自定义文本高亮API其实是JavaScript代码完成了大部分的工作。下面通过一个具体的案例演示如何通过上面的4步操作,实现文本高亮效果,让我想个与众不同的应用场景,嗯……那就页面上手机号码不明文显示效果吧。

HTML如下:

<p id="p">如有疑问可以WX加13208033621或者15812345678咨询。</p>

目标实现效果为:

则可以如下4步处理。

1. 创建range

使用new Range()语句构建,然后设置range的起止位置。

// 文本字符内容
const str = p.textContent;
// 手机号起始索引值
const arrIndex = str.match(/1\d{10}/g).map(tel => str.indexOf(tel));
// 创建range数组
const arrRange = arrIndex.map(start => {
 const range = new Range();
 range.setStart(p.firstChild, start + 3);
 range.setEnd(p.firstChild, start + 7);
 return range;
});

2. 创建Highlight对象

new Highlight()方法的语法如下:

const highlight = new Highlight(range1, range2, ...);

因此,我们可以这么处理:

// 定义高亮
const highlight = new Highlight(...arrRange.flat());

3. 注册高亮

这个简单,也是一行代码的事情:

// 注册高亮
CSS.highlights.set("tel-highlight", highlight);

4. CSS应用高亮

轮到伪元素::highlight()出马了,参数就是上面第3步注册的高亮名称:

::highlight(tel-highlight) {
 background-color: currentColor;
}

此时,就可以看到如图所示的展示效果了,手机号中间4个数字变成了色块,不可见了。

眼见为实,您可以狠狠地点击这里:CSS HighLight API隐藏部分手机号码demo

三、一些补充说明和结语

补充说明:

  • 实际开发中的range创建要比上面的示例复杂,因为高亮的元素中会有N多元素和节点混杂在一起,需要使用更加复杂的遍历算法,具体可以参考本文一开始提供的两个示例。
  • ::highlight()伪元素是不支持CSS变量的,例如:
::highlight(highlight) {
 --color: red;
 color: var(--color);
}

是不会让文字颜色高亮为红色的。

  • ::highlight()伪元素只支持部分CSS属性,包括:
  • 文本颜色 color
  • 背景颜色 background-color
  • 文本装饰线 text-decoration
  • 文本阴影 text-shadow
  • 文本描边 -webkit-text-stroke
  • 文本填充 -webkit-text-fill-color

也就是我们无法让高亮的文本字号发生变化(可以使用size-adjust),但是可以给文字加阴影、波浪线、描边等。

  • 高亮的文本是无法响应事件的,只能用来纯样式变化处理。如果有响应行为的需求,还是使用传统的标签包裹的方式实现。
© 2023 北京元石科技有限公司 ◎ 京公网安备 11010802042949号