bootstrap-suggest

bootstrap-suggest这是一个基于bootstrap按钮式下拉菜单组件的搜索建议插件

代码演示参考 若依系统 → 实例演示 → 表单元素 → 搜索自动补全 form/autocomplete.html(项目使用需要引入js)

<th:block th:include="include :: bootstrap-suggest-js" />

属性默认值描述
urlnull请求数据的 URL 地址
jsonpnull设置此参数名,将开启jsonp功能,否则使用json数据结构
data[]提示所用的数据,注意格式
indexId0每组数据的第几个数据,作为input输入框的 data-id,设为 -1 且 idField 为空则不设置此值
indexKey0每组数据的第几个数据,作为input输入框的内容
idField''每组数据的哪个字段作为 data-id,优先级高于 indexId 设置(推荐)
keyField''每组数据的哪个字段作为输入框内容,优先级高于 indexKey 设置(推荐)
autoSelecttrue键盘向上/下方向键时,是否自动选择值
allowNoKeywordTRUE是否允许无关键字时请求数据
getDataMethod'firstByUrl'获取数据的方式,url:一直从url请求;data:从 options.data 获取;firstByUrl:第一次从Url获取全部数据,之后从options.data获取
delayUntilKeyupfalse获取数据的方式 为 firstByUrl 时,是否延迟到有输入时才请求数据
ignorecasefalse前端搜索匹配时,是否忽略大小写
effectiveFields[]有效显示于列表中的字段,非有效字段都会过滤,默认全部有效
effectiveFieldsAlias{}有效字段的别名对象,用于 header 的显示
searchFields[]有效搜索字段,从前端搜索过滤数据时使用,但不一定显示在列表中。effectiveFields 配置字段也会用于搜索过滤
twoWayMatchtrue是否双向匹配搜索。为 true 即输入关键字包含或包含于匹配字段均认为匹配成功,为 false 则输入关键字包含于匹配字段认为匹配成功
multiWordfalse以分隔符号分割的多关键字支持
separator','多关键字支持时的分隔符,默认为半角逗号
delay300搜索触发的延时时间间隔,单位毫秒
emptyTip''查询为空时显示的内容,可为 html
searchingTip'搜索中…'ajax 搜索时显示的提示内容,当搜索时间较长时给出正在搜索的提示
hideOnSelectfalse鼠标从列表单击选择了值时,是否隐藏选择列表
autoDropupfalse选择菜单是否自动判断向上展开。设为 true,则当下拉菜单高度超过窗体,且向上方向不会被窗体覆盖,则选择菜单向上弹出
autoMinWidthfalse是否自动最小宽度,设为 false 则最小宽度不小于输入框宽度
showHeaderfalse是否显示选择列表的 header。为 true 时,有效字段大于一列则显示表头
showBtntrue是否显示下拉按钮
inputBgColor''输入框背景色,当与容器背景色不同时,可能需要该项的配置
inputWarnColor'rgba(255,0,0,.1)'输入框内容不是下拉列表选择时的警告色
listStyle默认参考描述列表的样式控制 { 'padding-top': 0, 'max-height': '375px', 'max-width': '800px', 'overflow': 'auto', 'width': 'auto', 'transition': '0.3s', '-webkit-transition': '0.3s', '-moz-transition': '0.3s', '-o-transition': '0.3s' }
listAlign'left'提示列表对齐位置,left/right/auto
listHoverStyle'background: #07d; color:#fff'提示框列表鼠标悬浮的样式
listHoverCSS'jhover'提示框列表鼠标悬浮的样式名称
clearablefalse是否可清除已输入的内容
keyLeft37向左方向键,不同的操作系统可能会有差别,则自行定义
keyUp38向上方向键
keyRight39向右方向键
keyDown40向下方向键
keyEnter13回车键
fnProcessDataprocessData格式化数据的方法,返回数据格式参考 data 参数
fnGetDatagetData获取数据的方法,无特殊需求一般不作设置
fnAdjustAjaxParamnull调整 ajax 请求参数方法,用于更多的请求配置需求。如对请求关键字作进一步处理、修改超时时间等
fnPreprocessKeywordnull搜索过滤数据前,对输入关键字作进一步处理方法。注意,应返回字符串
  1. // suggest 常用方法
  2. $("input#test").bsSuggest("disable"); // 禁用提示
  3. $("input#test").bsSuggest("enable"); // 启用提示
  4. $("input#test").bsSuggest("destroy"); // 销毁插件
  5. $("input#test").bsSuggest("version"); // 查看版本
  6. <!-- 事件监听
  7. onDataRequestSuccess // 当 AJAX 请求数据成功时触发,并传回结果到第二个参数
  8. onSetSelectValue // 当从下拉菜单选取值时触发,并传回设置的数据到第二个参数
  9. onUnsetSelectValue // 当设置了 idField,且自由输入内容时触发(与背景警告色显示同步)
  10. onShowDropdown // 下拉菜单显示时触发
  11. onHideDropdown // 拉菜单隐藏式触发
  12. -->
  13. $("#test").bsSuggest('init', {
  14. url: "/rest/sys/getuserlist?keyword=",
  15. effectiveFields: ["userName", "email"],
  16. searchFields: [ "shortAccount"],
  17. effectiveFieldsAlias:{userName: "姓名"},
  18. clearable: true,
  19. idField: "userId",
  20. keyField: "userName"
  21. }).on('onDataRequestSuccess', function (e, result) {
  22. console.log('onDataRequestSuccess: ', result);
  23. }).on('onSetSelectValue', function (e, selectedData, selectedRawData) {
  24. console.log('onSetSelectValue: ', e.target.value, selectedData, selectedRawData);
  25. }).on('onUnsetSelectValue', function () {
  26. console.log('onUnsetSelectValue');
  27. }).on('onShowDropdown', function (e, data) {
  28. console.log('onShowDropdown', e.target.value, data);
  29. }).on('onHideDropdown', function (e, data) {
  30. console.log('onHideDropdown', e.target.value, data);
  31. });