在 GitHub 上查看

表格过滤器控件

Bootstrap 表格的表格过滤器控件扩展。

使用

<link rel="stylesheet" type="text/css" href="extensions/filter-control/bootstrap-table-filter-control.css">
<script src="extensions/filter-control/bootstrap-table-filter-control.js"></script>

示例

过滤器控件

选项

filterControl

  • 属性: data-filter-control

  • 类型: 布尔值

  • 详情

    设置为 true 以在列中添加一个 inputselect

  • 默认值: false

filterControlVisible

  • 属性: data-filter-control-visible

  • 类型: 布尔值

  • 详情

    设置为 false 以隐藏过滤器控件。

  • 默认值: true

alignmentSelectControlOptions

  • 属性: data-alignment-select-control-options

  • 类型: 字符串

  • 详情

    设置选择控件选项的对齐方式。使用 left, rightauto

  • 默认值: undefined

filterControlContainer

  • 属性: data-filter-control-container

  • 类型: 选择器

  • 详情

    设置为例如 #filter 以允许在具有 id filter 的元素中使用自定义输入过滤器。每个过滤器元素(input 或 select)必须具有以下类 bootstrap-table-filter-control-<FieldName> (必须替换为定义的 [字段](https://table.bootstrap.ac.cn/docs/api/column-options/#field) 名称)。

  • 默认值: false

filterDataCollector

  • 属性: data-filter-data-collector

  • 类型: 函数

  • 详情

    收集将添加到选择过滤器中的数据,以过滤例如以逗号分隔并使用格式化程序显示的标签。

  • 默认值: undefined

filterControlMultipleSearch

  • 属性: data-filter-control-multiple-search

  • 类型: 布尔值

  • 详情

    设置为 true 以允许一次搜索多个值。这些值将使用分隔符分隔,请参阅选项 filterControlMultipleSearchDelimiter

  • 默认值: false

filterControlMultipleSearchDelimiter

  • 属性: data-filter-control-multiple-search-delimiter

  • 类型: 字符串

  • 详情

    定义将在选项 filterControlMultipleSearchDelimiter 中用于分隔搜索值的定界符。

  • 默认值: ,

filterControlSearchClear

  • 属性: data-filter-control-search-clear

  • 类型: 布尔值

  • 详情

    设置为 true 以使用表格选项 showSearchButton 清除过滤器控件过滤器。

  • 默认值: true

searchOnEnterKey

  • 属性: data-search-on-enter-key

  • 类型: 布尔值

  • 详情

    设置为 true 以在用户按下回车键时触发搜索操作。

  • 默认值: false

showFilterControlSwitch

  • 属性: data-show-filter-control-switch

  • 类型: 布尔值

  • 详情

    设置为 true 以显示过滤器控件切换按钮。

  • 默认值: false

sortSelectOptions

  • 属性: data-sort-select-options

  • 类型: 布尔值

  • 详情

    设置为 true 以对选择控件的选项元素进行排序。

  • 默认值: false

列选项

filterControl

  • 属性: data-filter-control

  • 类型: 字符串

  • 详情

    设置为 input: 显示输入控件,select: 显示选择控件,datepicker: 显示 HTML5 日期选择器控件。

  • 默认值: undefined

filterControlPlaceholder

  • 属性: data-filter-control-placeholder

  • 类型: 字符串

  • 详情

    设置为在输入过滤器控件中仅显示占位符。

  • 默认值: ''

filterCustomSearch

  • 属性: data-filter-custom-search

  • 类型: 函数

  • 详情

    自定义搜索函数将替代内置搜索函数执行,并接受四个参数

    • text: 搜索文本。
    • value: 要比较的列的值。
    • field: 列字段名称。
    • data: 表格数据。

    返回 false 以过滤掉当前列/行。返回 true 以不过滤掉当前列/行。返回 null 以跳过当前值的自定义搜索。

  • 默认值: undefined

filterData

  • 属性: data-filter-data

  • 类型: 字符串

  • 详情

    设置自定义选择过滤器值,使用 var:variable 从变量加载 obj:variable.key 从对象加载 url:http://www.example.com/data.json 从远程 JSON 文件加载 json:{key:data} 从 JSON 字符串加载。 func:functionName 从函数加载。

  • 默认值: undefined

filterDatepickerOptions

  • 属性: data-filter-datepicker-options

  • 类型: 对象

  • 详情

    如果设置了日期选择器选项,请使用此选项以本机选项配置日期选择器。使用以下方式:data-filter-datepicker-options='{"max":value1, "min": value2, "step": value3}'。有关更多信息,请访问此 文档

  • 默认值: undefined

filterDefault

  • 属性: data-filter-default

  • 类型: 字符串

  • 详情

    设置过滤器的默认值。

  • 默认值: undefined

filterOrderBy

  • 属性: data-filter-order-by

  • 类型: 字符串

  • 详情

    设置为对选择控件中的选项进行排序,无论是升序 ('asc'),降序 ('desc') 还是服务器提供的顺序 ('server')。

  • 默认值: 'asc'

filterStartsWithSearch

  • 属性: data-filter-starts-with-search

  • 类型: 布尔值

  • 详情

    设置为 true 如果你想要使用以开头匹配的搜索模式。

  • 默认值: false

filterStrictSearch

  • 属性: data-filter-strict-search

  • 类型: 布尔值

  • 详情

    设置为 true 如果你想要使用严格匹配的搜索模式。

  • 默认值: false

图标

  • 清除:'glyphicon-trash icon-clear'
  • filterControlSwitchHide:'glyphicon-zoom-out icon-zoom-out'
  • filterControlSwitchShow:'glyphicon-zoom-in icon-zoom-in'

事件

onColumnSearch(column-search.bs.table)

  • 当我们在列数据中搜索时触发

onCreatedControls(created-controls.bs.table)

  • 当我们在列数据中搜索时触发

方法

triggerSearch

  • 手动触发搜索操作

clearFilterControl

  • 清除此插件添加的所有控件(类似于 showSearchClearButton 选项)。

toggleFilterControl

  • 切换过滤器控件的可见性(显示/隐藏)。

本地化

formatClearFilters

  • 类型: 函数

  • 默认值: function () { return "Clear Filters" }

formatFilterControlSwitch

  • 类型: 函数

  • 默认值: function () { return "Hide/Show controls" }

formatFilterControlSwitchHide

  • 类型: 函数

  • 默认值: function () { return "Hide controls" }

formatFilterControlSwitchShow

  • 类型: 函数

  • 默认值: function () { return "Show controls" }