lk-text-select-highlight 1.0.6 → 1.0.7

package/README-cn.md

@@ -43,33 +43,27 @@ document.addEventListener('mouseup', () => {
 
 ## API
 
-### new TextHighlighter(options)
+### 构造函数
 
-使用以下选项初始化新的 TextHighlighter 实例：
+`new TextHighlighter(options)`
 
-- `className`: 高亮元素的CSS类名 (默认: 'highlighted-text')
-- `color`: 高亮背景颜色 (默认: '#ffff00')
-- `container`: 限制文本选择高亮的DOM元素 (默认: document.body)
-- `strictMode`: 如果为true，则防止在包含目标className元素的选择上进行高亮 (默认: false)
-- `caseSensitive`: 搜索是否区分大小写 (默认: true)
+创建一个新的 TextHighlighter 实例。
 
-### highlighter.highlightSelection()
+#### 选项
 
-高亮页面上当前选中的文本。
+- `className`: 高亮元素的CSS类名 (默认值: `"highlighted-text"`)
+- `color`: 高亮背景色 (默认值: `"#ffff00"`)
+- `container`: 限制文本选择/高亮的DOM元素 (默认值: `document.body`)
+- `strictMode`: 防止高亮包含目标className元素的选择 (默认值: `false`)
+- `caseSensitive`: 搜索是否区分大小写 (默认值: `true`)
 
-### highlighter.removeAllHighlights()
+### 方法
 
-移除所有现有的高亮。
-
-### highlighter.getHighlights()
-
-返回所有当前高亮的数组。每个高亮对象包含：
-- `uuid`: 高亮元素的唯一标识符
-- `text`: 高亮的文本内容
-
-### highlighter.removeHighlight(highlight)
-
-移除指定的高亮对象。高亮对象可以从 getHighlights() 方法获取。该方法使用UUID来定位并移除相应的高亮元素。
+- `highlightSelection()`: 高亮当前选中的文本
+- `removeAllHighlights()`: 移除所有高亮
+- `removeHighlight(highlight)`: 移除特定高亮
+- `getHighlights()`: 获取所有高亮对象
+- `setHighlights(highlights)`: 从高亮对象数组设置高亮数据
 
 ## 配置选项详解
 

package/README.md

@@ -43,37 +43,27 @@ document.addEventListener('mouseup', () => {
 
 ## API
 
-### new TextHighlighter(options)
+### Constructor
 
-Initialize a new TextHighlighter instance with the following options:
+`new TextHighlighter(options)`
 
-- `className`: CSS class name for highlighted elements (default: 'highlighted-text')
-- `color`: Background color for highlights (default: '#ffff00')
-- `container`: DOM element that limits where text selection highlighting occurs (default: document.body)
-- `strictMode`: If true, prevents highlighting selections that contain elements with the target className (default: false)
-- `caseSensitive`: Whether search should be case sensitive (default: true)
+Creates a new TextHighlighter instance.
 
-### highlighter.highlightSelection()
+#### Options
 
-Highlights the currently selected text on the page.
+- `className`: CSS class name for highlighted elements (default: `"highlighted-text"`)
+- `color`: Background color for highlights (default: `"#ffff00"`)
+- `container`: DOM element to restrict text selection/highlighting (default: `document.body`)
+- `strictMode`: Prevents highlighting selections that contain elements with the target className (default: `false`)
+- `caseSensitive`: Whether search is case-sensitive (default: `true`)
 
-### highlighter.removeAllHighlights()
+### Methods
 
-Removes all existing highlights.
-
-### highlighter.getHighlights()
-
-Returns an array of all current highlights. Each highlight object contains:
-- `uuid`: Unique identifier for the highlight element
-- `text`: The highlighted text content
-
-### highlighter.removeHighlight(highlight)
-
-Removes a specific highlight object. The highlight object can be obtained from the getHighlights() method. The method uses the UUID to locate and remove the corresponding highlight element.
-
-### highlighter.removeAllHighlights()
-
-Removes all existing highlights.
+- `highlightSelection()`: Highlights the currently selected text
+- `removeAllHighlights()`: Removes all highlights
+- `removeHighlight(highlight)`: Removes a specific highlight
+- `getHighlights()`: Gets all highlight objects
+- `setHighlights(highlights)`: Sets highlight data from an array of highlight objects
 
 ## Testing
 

package/index.js

@@ -195,6 +195,36 @@ class TextHighlighter {
 		}
 		return false;
 	}
+
+	/**
+	 * Set highlights data
+	 * @param {Array} highlights - Array of highlight objects with uuid and text properties
+	 */
+	setHighlights(highlights) {
+		// Validate the input to ensure it's an array of objects with required properties
+		if (!Array.isArray(highlights)) {
+			throw new Error("Highlights must be an array");
+		}
+
+		// Validate each highlight object
+		for (const highlight of highlights) {
+			if (
+				typeof highlight !== "object" ||
+				!highlight.hasOwnProperty("uuid") ||
+				!highlight.hasOwnProperty("text")
+			) {
+				throw new Error(
+					"Each highlight must be an object with uuid and text properties",
+				);
+			}
+		}
+
+		// Clear existing highlights
+		this.removeAllHighlights();
+
+		// Set the new highlights data
+		this.highlights = [...highlights];
+	}
 }
 
 // Export for both Node.js and browser environments

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "lk-text-select-highlight",
-	"version": "1.0.6",
+	"version": "1.0.7",
 	"description": "A lightweight JavaScript library for highlighting selected text on web pages",
 	"main": "dist/lk-text-select-highlight.cjs.js",
 	"module": "dist/lk-text-select-highlight.esm.js",