一个基于jquery的智能提示控件intellSeach.js
一、需求
我们经常会遇到【站内搜索】的需求,为了提高用户体验,我们希望能做到像百度那样的即时智能提示。例如:某公司人事管理系统,想搜索李XX,只要输入“李”,系统自然会提示一些姓李的员工,这样方便用户使用。说白了,就是用户边输入,系统会提示相关的结果;或者,当用户点击搜索框时,就推荐一些内容,如360、百度都会提示今天的主要新闻或搜索量大的内容。
jquery 已经有一个这样的插件了,叫 autocomplete, 但我觉得不好用。关于autocomplete的介绍也很多,有兴趣的朋友可以去试试。
看标题就知道,这里只是分享一个插件,不会讨论后台搜索的相关算法和过程,也就是说,后台返回特定格式的数据,控件负责渲染结果呈现。ok,先看一下效果图:
效果一:
效果图二:
样式与控件无关,只需要一个 input text 就可以了。
二、参数说明
控件以json格式作为传输格式。参数比较多,大部分都有默认值(具体看源码),有些可能不常用,保持默认即可。如下:
url: 请求地址。如:Handler.ashx, 后台获取数据的地址
property: 要显示的json对象的属性。如果我们直接返回["tom","tom cat","tom2"] 这样的形式,那么该属性可以不用设置;但有时候我们会返回[{"Name":"tom","ID":"001"},{"Name":"tom cat","ID":"002"},{"Name":"tom2","ID":"003"}] 这样的形式,显示的是Name,那么设置该属性为"Name"即可。至于我们想在点击的时候获得点击的项的ID,通过点击事件即可。
itemNumber: 显示的项数目。
isEmptyRequest: focus时,空白是否发起请求。就像前面说的,如果点击搜索框时(此时没有内容),想要推荐一些内容,设置该属性为true,即会发起请求。
defaultValue: 默认值。通常会是:“请输入关键词...” 这类的提示。
width: 下拉列表宽度。
aligner: 要对齐的元素。
maxHeight: 最大高度。如果设置该高度,超过时就会出现滚动条。
ajax:{
timeout:
超时时间
cache: 是否缓存
},
event:{
setData:
发送请求前触发。用于设置参数
itemClick: 点击项触发
enterKeydown: 按下enter键触发
beforeRender: 所有项呈现前触发
endRender: 所有项呈现后触发
itemBeforeRender: 项呈现前触发
itemAfterRender: 项呈现后触发
beforeSend: 发送请求前触发。用户设置请求头部参数等,相当于jquery ajax 的
beforeSend。
}
event
里的方法都会在适当的时候触发,需要注意的是,所有方法都接收一个参数,该参数是一个对象,有4个属性,某些情况如果没有该属性的,则为空。包括如下属性:
jthis: input 的 jQuery 对象。
jItem: 项的 jQuery 对象。
data: 返回的 json 字符串。如果在前台需要对返回 json 再进行处理,那么可以通过 data 属性获得,处理完成后,需要将 json
字符串 return。
event: 事件对象,如按下 enter 时的事件对象。
三、例子
使用例子:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
$( "#search" ).intellSearch({ url: "Handler.ashx" , property: "Name" , itemNumber:5, isEmptyRequest: false , defaultValue: "请输入关键字..." , width:$( "#search" ).width() + 2, maxHeight:-1, event:{ itemClick: function (obj){ alert(obj.item.ID); }, enterKeydown: function (obj){ if (obj.item){ alert( "有当前项" ); } else { alert( "没有当前项" ); } } } }); |
四、总结
如果你还有自己的逻辑需要处理,也支持链式调用,大可以这样写
$("#search").intellSearch({参数...}).focus(function(){你的处理...});
分享该插件希望能帮助到有需要的朋友,主要用于学习。由于是v1.0,可能还有一些bug,有发现的朋友也可以告诉我,我会及时修正。
附源代码
js代码
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
|
/*搜索智能提示 date:2015.09.08 */ ;( function (w,$){ $.fn.intellSearch = function (options){ var jthis = this ; var _dftOpts = url: "" , //请求地址或数组 property: "" , //要显示的json对象的属性 itemNumber:5, //显示的条数 isEmptyRequest: false , //focus空白是否发起请求 defaultValue: "" , //默认值 width:0, //列表宽度 aligner:jthis, //要对齐的元素 maxHeight:-1, //最大高度 ajax:{ timeout:3000, //超时时间 cache: true //是否缓存 }, event:{ /*参数说明:parameter:{jthis:"jq input",jItem:"jq setData: null , //设置参数 itemClick: null , //点击项触发 enterKeydown: null , //按下enter键触发 beforeRender: null , //所有项呈现前触发 endRender: null , //所有项呈现后触发 itemBeforeRender: null , //项呈现前触发 itemAfterRender: null , //项呈现后触发 beforeSend: null //发送请求前触发 } }; $.extend(_dftOpts,options); if (!_dftOpts.url){ throw Error( "url不能为空!" ); } var jResult; var _value = "" ; var _ajax = var _event = var _cache = var _focusCount //防止focus触发多次(sogou) /*on window.intellObj = window.intellObj || {}; /*for global event*/ window.intellDocumentClick = window.intellDocumentClick function (e){ if (!window.intellObj.jthis){ return ; } if (e.target !== setIntellObj( null ); } } window.intellDocumentKeydown = function (e){ var jthis = if (!jthis){ return ; } var code = var value = var jResult,jCurItem,keyword; if (code === 13 jResult = window.intellObj.jResult; jItems = jResult.find( "li" ); jCurItem = jResult.find( "li.cur" ); if (code === if (jCurItem.length > 0){ jCurItem.click(); } else { setIntellObj( null ); if (_event.enterKeydown){ _event.enterKeydown({ "jthis" :jthis, "event" :e}); } } jthis.blur(); } else if (jItems.length > 0){ if (code === if (jCurItem.length <= 0){ jCurItem = jItems.last(); jCurItem.addClass( "cur" ); keyword = jCurItem.text(); } else { var index = jCurItem.removeClass( "cur" ); if (index <= keyword = value; } else { jCurItem = jItems.eq(index-1); jCurItem.addClass( "cur" ); keyword = jCurItem.text(); } } jthis.val(keyword); } else { if (jCurItem.length <= 0){ jCurItem = jItems.first(); jCurItem.addClass( "cur" ); keyword = jCurItem.text(); } else { var index = jCurItem.removeClass( "cur" ); if (index + 1 keyword = value; } else { jCurItem = jItems.eq(index+1); jCurItem.addClass( "cur" ); keyword = jCurItem.text(); } } jthis.val(keyword); } } } } /*event handler*/ $.fn.unintell = function (){ remove(); } $(document).unbind({click:window.intellDocumentClick,keydown:window.intellDocumentKeydown}) .bind({click:window.intellDocumentClick,keydown:window.intellDocumentKeydown}); jthis.focus( function (){ _focusCount++; if (_focusCount return ; } if (window.intellObj.jthis && jthis !== setIntellObj( null ); } var keyword = if (keyword === keyword = "" ; attrValue(keyword); } if (keyword || sendRequest(); } }) jthis.blur( function (){ _focusCount = 0; if (!attrValue()){ attrValue(_dftOpts.defaultValue); } }) jthis.keyup( function (e){ if (e.keyCode return ; } var keyword = if (!keyword){ remove(); window.intellObj.value = _value = "" ; return ; } if (keyword !== window.intellObj.value = _value = keyword; sendRequest(); } }); return initBox(); /*function*/ function initBox(){ attrValue(_dftOpts.defaultValue); return jthis; } function initIntell(){ generate(); register(); setIntellObj({jthis:jthis,jResult:jResult}); } function generate(){ var offset = var width = jResult = $( "<ul>" ,{ "class" : "intellResult" }); jResult.width(width).css({ "position" : "absolute" , "left" :offset.left, "top" :offset.top $( "body" ).append(jResult); if (_dftOpts.maxHeight > 0){ jResult.height(_dftOpts.maxHeight).css( "overflowY" , "scroll" ); } } function remove(){ if (jResult){ jResult.remove(); jResult = null ; } } function register(){ jResult.on( "click" , "li" , function (){ var jItem = this ); var index = var keyword = attrValue(keyword); _value = keyword; if (_event.itemClick){ _event.itemClick({ "jthis" :jthis, "jItem" :jItem, "item" :_cache[index]}); } }).on( "mouseenter" , "li" , function (){ $( this ).siblings( "li" ).removeClass( "cur" ).end().addClass( "cur" ); }).on( "mouseleave" , "li" , function (){ $( this ).removeClass( "cur" ); }); } function setIntellObj(obj){ if (!obj){ if (window.intellObj.jResult){ window.intellObj.jResult.remove(); } window.intellObj.jthis = null ; window.intellObj.jResult = null ; } else { window.intellObj.jthis = obj.jthis; window.intellObj.jResult = obj.jResult; } } function sendRequest(){ var data; if (_event.setData){ data = _event.setData({ "jthis" :jthis}); } $.ajax({ url:_dftOpts.url, data:data, cache:_ajax.cache, timeout:_ajax.timeout, beforeSend: function (xhr){ if (_event.beforeSend){ _event.beforeSend(xhr); } }, success: function (data){ remove(); showData(data); }, error: null }); } function showData(data){ data if (_event.beforeRender){ var rs = "jthis" :jthis, "data" :data}); if (rs === false ){ return ; } if (rs !== data = rs; } } if (!data){ return ; } var jItem,jA,jSpan,hasProp,item,text,otherTexts,isRender,index; var list = var length = length = length > _dftOpts.itemNumber ? if (length <= return ; } initIntell(); _cache.length = 0; hasProp = list[0][_dftOpts.property]; for ( var i=0;i<length;i++){ item = list[i]; if (item === null || item === undefined){ continue ; } text = hasProp ? item[_dftOpts.property] : item; text = $.trim(text.toString()); if (text === "" ){ continue ; } jItem = $( "<li>" ,{ "class" : "intellResult_item" }); jA = $( "<a>" ,{ "title" :text}).appendTo(jItem); jSpan = $( "<span>" ).appendTo(jA); index = otherTexts = splitText(text,_value,index); if (otherTexts){ jSpan.text(text.substr(index,_value.length)); if (otherTexts.length > 1){ $( "<b>" ,{ "text" :otherTexts[0]}).insertBefore(jSpan); $( "<b>" ,{ "text" :otherTexts[1]}).insertAfter(jSpan); } else { if (index === $( "<b>" ,{ "text" :otherTexts[0]}).insertAfter(jSpan); } else { $( "<b>" ,{ "text" :otherTexts[0]}).insertBefore(jSpan); } } } else { jSpan.text(text); } isRender = true ; if (_event.itemBeforeRender){ isRender = _event.itemBeforeRender({ "jthis" :jthis, "jItem" :jItem, "item" :item}); } if (isRender !== false ){ jResult.append(jItem); if (_event.itemAfterRender){ _event.itemAfterRender({ "jthis" :jthis, "jItem" :jItem, "item" :item}); } } _cache.push(item); } if (_event.endRender){ _event.endRender({ "jthis" :jthis}); } jResult.show(); } function attrValue(value){ if (!value "" ){ return $.trim(jthis.val()); } jthis.val(value); } function splitText(text,value,index){ var tlength = var vlength = if (index === return null ; } if (index === if (index + return null ; } return [text.substr(index + vlength)]; } if (index + return [text.substr(0,index)]; } return [text.substr(0,index),text.substr(index + vlength)]; } } })(window,jQuery); |
样式
1
2
3
|
.intellResult{ margin : 0 ; padding : 0 ; background : #fff ; border : 1px solid #b6b6b6 ; clear : both ; z-index : 999 ; display : none ;} .intellResult margin : 0 ; padding : 0 ; padding : 5px 15px ; height : 20px ; line-height : 20px ; overflow : hidden ;text- overflow :ellipsis; cursor : pointer ; white-space : nowrap ;} .intellResult background : #E5E0E0 ;} |
一个基于jquery的智能提示控件intellSeach.js的更多相关文章
- 福利到~分享一个基于jquery的智能提示控件intellSeach.js
一.需求 我们经常会遇到[站内搜索]的需求,为了提高用户体验,我们希望能做到像百度那样的即时智能提示.例如:某公司人事管理系统,想搜索李XX,只要输入“李”,系统自然会提示一些姓李的员工,这样方便用户 ...
- jquery的智能提示控件
福利到~分享一个基于jquery的智能提示控件intellSeach.js 一.需求 我们经常会遇到[站内搜索]的需求,为了提高用户体验,我们希望能做到像百度那样的即时智能提示.例如:某公司人事管 ...
- 基于Jquery的文本提示控件 poshytip
Html中,如设置了title的属性,则当鼠标在该对象上面短暂的停留时,会显示预设的文本提示,但,这些效果只会短暂的显示,一会就会消失,又要重新把鼠标移出再移回来才被显示,样式也无法重写,实在是恼人之 ...
- 气泡形提示控件grumble.js
grumble.js 是一个很特别的气泡形状提示控件,最开始是为 Huddle.com 网站开发的, 它没有通常的north/east/south/west的定位限制. 任何一个grumble都可以放 ...
- 打造基于jQuery的日期选择控件
终于把jQuery拼写正确了哈,哈哈javascript也是区分大小写的,所以确实不能写错,今天我来和大家分享的是日期选择控件的实现,功能也许不够强大,但是能够满足需求. 我之前也写过(正确的说是改过 ...
- 基于JQuery EasyUI的WebMVC控件封装(含源码)
JQuery EasyUI类库,大家不会陌生,出来已经有很多年了.个人感觉还是很好用的,作者更新频率也很快,bug也及时修复. 最近在整理以前的代码,找到了这个组件,它是将EasyUI组件封装成MVC ...
- jquery自动生成分页控件 - pagetest.js
/* pagenum:当前页数 theallnum:总条数 themeiye:每页显示多少条 */ function pagetest(pagenum, theallnum, themeiye) { ...
- jquery messagetip信息语提示控件
编写原因: 作为提示框,jquery有个messagebox的控件,也就是弹出的提示框.但这个控件如果不是用在需要确认的时候,单单警告提示.消息提示.失败提示时,用户还需要去点下确认,有时这操作还是挺 ...
- jquery的上传控件uploadly,每行都有一个这样的控件对id选择器的使用
1.先看看预览图 这个是我的页面,其中如果我没点击添加一行的时候,会把本来有的数据进行循环出来,这个时候每个记录都必须有个上传图片的按钮,但是jquery的uploadly这个控件只是锁定id的,至少 ...
随机推荐
- sqoop 兼容性问题
--direct 只支持mysql 5.0 + 和postgresql 8.3+(只是import) jdbc的jar包需要放在$SQOOP_HOME/lib目录下 mysql zeroDateTim ...
- linux安装android sdk
https://dl.google.com/android/repository/sdk-tools-linux-4333796.zip 1,先安装java https://developer.and ...
- 更快的方式实现 PHP 数组去重
概述 使用PHP的array_unique()函数允许你传递一个数组,然后移除重复的值,返回一个拥有唯一值的数组.这个函数大多数情况下都能工作得很好.但是,如果你尝试在一个大的数组里使用array_u ...
- 常用的HTTP协议状态码
200 - OK,服务器成功返回网页 - Standard response for successful HTTP requests. 301 - Moved Permanently(永久跳 ...
- CRNA的使用
为了能让更多人感受 RN 的魅力,早在几个月前 React-community 就给出了一个不错的解决方案,可以让一个完全没接触过 RN 的人,从配环境开始5分钟实现 Hello Wolrd 的编写( ...
- Android 中自定义控件和属性(attr.xml,declare-styleable,TypedArray)的方法和使用
一. 在res/values 文件下定义一个attrs.xml 文件.代码如下: <?xml version="1.0" encoding="utf-8" ...
- kali 无法使用ifconfig等常用命令
kali无法使用ifconfig apt-get -y install net-tools
- QACT 在线调试 Android O
使用QACT调试Android O的音频时,不能在线调试,但是使用Android N却可以在线调试. 解决方法 1. adb root 2. adb remount 3. adb shell 4. c ...
- 第三百八十六节,Django+Xadmin打造上线标准的在线教育平台—HTML母版继承
第三百八十六节,Django+Xadmin打造上线标准的在线教育平台—HTML母版继承 母板-子板-母板继承 母板继承就是访问的页面继承一个母板,将访问页面的内容引入到母板里指定的地方,组合成一个新页 ...
- LintCode #3 统计数字
解题思路请参考 代码(可以通过,不过很乱,需要整理): /// <summary> /// 计算n在数组[targetNum]中出现的次数 /// 形如:[0, 1, 2, 3, 4, 5 ...