项目简介
jQuery Highlighter 是一个用来高亮显示文本关键字的 jQuery 插件。
项目主页:http://github.com/XuJinNet/jQuery-Highlighter
在线测试页面:http://xujinnet.github.com/jQuery-Highlighter/jQuery-Highlighter-Test-Page.html
功能特定
- 支持同时高亮多个关键字
- 多个关键字之间可以重叠
- 能够取消高亮关键字
Quick Start
-
Include jQuery and the Highlighter plugin script file in your HTML page:
-
In your HTML body create a container tag pair that will hold some text.Give it an id or class attribute (e.g. "News-Pagination"). This attribute can used as the selector for jQuery.
- Write some text into the previously created container tag, that contain the key words you want to search .
-
Write the JavaScript code in your HTML head:
-
Use your favorite browser to view this page, you will see the keywords are marked red.
-
If you want to cancel the highlighted keywords or need to highlight keywords several times within the same container tag:
Available Options
hClass
Specifies the CSS class used to highlight key words.
Data Type: String
Default Value: null
hColor
Specifies the color used to highlight key words. If you setted the hClass option, this option will be ignored.
Data Type: String
Default Value: "#C03"
separator
The symbol used to separate multiple keywords.
Data Type: String
Default Value: " "
wrapper
Specifies the HTML tag used to wrap the keywords.
Data Type: String
Default Value: "em"
useDefaultStyle
When not set hClass option, specify whether to use the default style to highlight the keywords (eg: use the hColor option).
Data Type: Boolean
Default Value: true
needUnhighlight
Specifies whether need the function of cancel the highlighted keywords or highlight keywords several times within the same container tag.
Data Type: Boolean
Default Value: false