lk-text-select-highlight 1.0.0

package/types/index.d.ts

@@ -0,0 +1,89 @@
+declare interface TextHighlighterOptions {
+	/**
+	 * 高亮元素的CSS类名
+	 * @default 'highlighted-text'
+	 */
+	className?: string;
+
+	/**
+	 * 高亮背景颜色
+	 * @default '#ffff00'
+	 */
+	color?: string;
+
+	/**
+	 * 限制文本选择高亮的DOM元素
+	 * @default document.body
+	 */
+	container?: HTMLElement;
+
+	/**
+	 * 严格模式，如果为true，则防止在包含目标className元素的选择上进行高亮
+	 * @default false
+	 */
+	strictMode?: boolean;
+
+	/**
+	 * 搜索是否区分大小写
+	 * @default true
+	 */
+	caseSensitive?: boolean;
+}
+
+declare interface HighlightObject {
+	/** 高亮的DOM元素 */
+	element: HTMLElement;
+	/** 高亮的文本内容 */
+	text: string;
+}
+
+declare class TextHighlighter {
+	/**
+	 * 创建一个新的文本高亮实例
+	 * @param options 配置选项
+	 */
+	constructor(options?: TextHighlighterOptions);
+
+	/** 当前配置选项 */
+	readonly options: TextHighlighterOptions;
+
+	/**
+	 * 高亮选中的文本
+	 * @returns 如果成功高亮返回true，否则返回false
+	 */
+	highlightSelection(): boolean;
+
+	/**
+	 * 移除所有高亮
+	 */
+	removeAllHighlights(): void;
+
+	/**
+	 * 移除指定的高亮
+	 * @param highlight 要移除的高亮对象
+	 * @returns 如果成功移除返回true，否则返回false
+	 */
+	removeHighlight(highlight: HighlightObject): boolean;
+
+	/**
+	 * 获取所有高亮对象
+	 * @returns 高亮对象数组
+	 */
+	getHighlights(): HighlightObject[];
+
+	/**
+	 * 将范围包装在高亮元素中
+	 * @param range 要包装的范围
+	 * @returns 高亮元素
+	 */
+	wrapRange(range: Range): HTMLElement;
+
+	/**
+	 * 检查选择范围是否包含目标类名的元素
+	 * @param range 要检查的范围
+	 * @returns 如果包含目标类名元素返回true，否则返回false
+	 */
+	hasTargetClassInSelection(range: Range): boolean;
+}
+
+export default TextHighlighter;