Sidebar Search Plugin

边栏搜索插件提供从边栏菜单项中搜索菜单项的功能。

用法

此插件可以作为 jQuery 插件或使用数据 API 激活。

数据 API

通过向边栏内的输入组中添加以下数据属性 data-widget="sidebar-search" 激活该插件。你可以使用以下 HTML 标记快速入门。

jQuery

jQuery API 提供了更多可定制的选项，允许开发人员在呈现之前预处理请求，并在呈现后对其进行后处理。

("[data-widget="sidebar-search"]").SidebarSearch(options)

HTML 标记

将此 HTML 标记放在 div.user-panel 之后。

<div class="form-inline">
  <div class="input-group" data-widget="sidebar-search">
    <input class="form-control form-control-sidebar" type="search" placeholder="Search" aria-label="Search">
    <div class="input-group-append">
      <button class="btn btn-sidebar">
        <i class="fas fa-search fa-fw"></i>
      </button>
    </div>
  </div>
</div>

选项

名称	类型	默认	描述
arrowSign	字符串	’->’	菜单项路径之间的箭头符号。
minLength	数字	3	最小搜索查询长度。
maxResults	数字	7	要显示的最大搜索结果数。
highlightName	布尔值	TRUE	突出显示菜单项名称。
highlightPath	布尔值	FALSE	是否突出显示菜单项路径。
highlightClass	字符串	’text-light’	突出显示类。
notFoundText	字符串	’未找到元素！	如果找不到菜单项的响应文本。

方法

方法	描述
init	初始化 SidebarSearch 插件并注册所有可见的菜单项。
toggle	切换搜索下拉列表。
close	关闭搜索下拉列表。
open	打开搜索下拉列表。
search	触发搜索。

示例：$('[data-widget="sidebar-search"]').SidebarSearch('toggle')