html-replacer v0.1.7

html-replacer工具类库

1. 安装

   npm i html-replacer
   或者
   yarn add html-replacer

2. 模块引入

   引入整个库
   import htmlReplacer from 'html-replacer'
   或者单独引入个别方法
   import {highlight} from 'html-replacer'

3. api

   • highlight 高亮

     /**
      * 执行高亮操作
      * @param targetStr     目标字符串
      * @param highlighters  高亮关键词集合或对象   example:[{word: "bus", color: "red"}] 或者 {word: "bus", color: "red"}
      * @return string       执行高亮后的字符串
      */
     highlight(targetStr, highlighters)

   • highdense 高密

     /**
      * 执行聚焦操作
      * @param container     外层容器
      * @param className     需要高密的样式名，默认为hl-start
      * @return Object       高密Object<相对高度百分比, 颜色集合>
      */
     highdense(container, className)

   • mark 标记

     /**
      * 执行mark标记
      * @param {HTMLElement} root         根节点
      * @param {Markers} markers          标记对象或集合
      * @param options                    配置项
      */
      mark(root, markers, options)

   • createMarker 生成标记对象

     /**
      * 生成标记信息对象
      * @param {HTMLElement} root        根节点
      * @param {Range} range             鼠标拖动选中区域对象
      * @return {Marker}                 标记对象
      */
     createMarker(root, range)

   • unmark 取消标记

     /**
      * 删除标记
      * @param {string} id               标记唯一标识
      */
     unmark(id)