✨ 它提供了一组可交互操作的工具来注释网页内容 ✨🖍️
js-mark是一个JavaScript库，用于在浏览器。他是一个可以在任何网页做标记的前端库, 它提供了一组可交互操作的工具来注释网页内容。 支持标记文本和 持久化存储与还原
如果进行简单的演示，可以打开http://webviews.cn/js-mark/选中文本进行标注
npm install js-mark
使用静态文件,把dist/js-mark.js静态文件直接放到项目中
import JsMark from "js-mark";
const jsMark = new jsMark(opts:OPTS)创建一个新的jsMark实例,opts 会合并至默认配置 (如下所示).
interface OPTS {
el:Element，
options:{
isCover:boolean
}
}配置说明：
| 参数名 | 类型 | 描述 | 是否必须 | 默认值 |
|---|---|---|---|---|
| el | Document | 标记的根节点元素 | 是 | null |
| options | Object | 配置项(详细如下) | 否 | null |
options配置说明：
| 参数名 | 类型 | 描述 | 是否必须 | 默认值 |
|---|---|---|---|---|
| isCover | Boolean | 标记内容是否可以覆盖 | 否 | true |
| ignoreClass | string[] | 忽略的class，添加后不会被标注 | 否 | [] |
当鼠标选中根节点下的文本或从后台获取数据使用jsMark.renderStore渲染已标注节点时会触发此方法，该方法回调返回一个Selected已选中对象
interface Selected {
textNodes: Text[]; //选中的所有文本节点
text: string; //选中的文本
offset: number; //选中文本相对于根结点的偏移量
hasStoreRender: boolean; //是否来自renderStore方法渲染，一般用于从数据库拿到数据运用jsMark.renderStore方法判断首次渲染
}
jsMark.onSelected = function (res:Selected) {};标注已经选中的文本，一般用在jsMark.onSelected回调方法内，接受三个参数
//定义
interface RangeNodes{
textNodes: Text[]; //选中的所有文本节点,onSelected返回值的res.textNodes
className: string; //需要标注的文本节点样式类
uuid?: string; //标注文本节点的唯一id，会绑定到节点身上的data-selector属性，此id可用于清除当前标注节点，可选，不传会自动生成
storeRenderOther?:any; //来自jsMark.renderStore方法的用户自定义参数
}
function repaintRange(opts:RangeNodes):{
uid:number,
offsetLeft:number, //返回距离标记的根节点元素el的偏移量（前提是offsetParent可以命中此节点），否则相对于el的offsetParent进行计算
offsetRight:number,
}{...}
//调用示例
jsMark.onSelected = function (res) {
jsMark.repaintRange({
textNodes:res.textNodes
});
};点击已经标注的内容后，会触发jsMark.onClick方法,回掉方法接受一个uid为标签上唯一的一个id，可用于清除单个标注
jsMark.onClick = function (uid:string) {};//定义
interface SelectInfo{
offset: number; //选中文本相对于根结点的偏移量
text: string; //选中的文本
storeRenderOther?:any; //用户自定义参数
}
function renderStore(obj: SelectInfo[]): void {...}
//调用
jsMark.renderStore([{text:"测试",offset:20}])通过jsMark.findWord查找文档中所有的可标注文本位置，返回相对于跟节点的偏移量
//定义
declare type Nullable<T> = T | null;
interface Selected {
offset: number; //偏移量
text: string; //文本信息
}
function findWord(word:string):Nullable<Selected[]>{...}
//调用
jsMark.findWord("标注文本");清除标签上data-selector属性为唯一uid的标签标注
jsMark.deleteMark(uid);jsMark.clearMarkAll();jsMark.destroy();当删除节点后，如果你不希望你的文本节点被拆离，可以调用此方法来格式化容器内的代码
jsMark.beautifyHTML();| IE | Firefox | Chrome | Safari | Opera |
|---|---|---|---|---|
| 10 | 52 | 15 | 5.1 | 15 |