|
|
@@ -33,64 +33,64 @@ Dependence if you use the datepicker option: [bootstrap-datepicker](https://gith
|
|
|
|
|
|
- **Default:** `false`
|
|
|
|
|
|
-### filterControlContainer
|
|
|
+### alignmentSelectControlOptions
|
|
|
|
|
|
-- **Attribute:** `data-filter-control-container`
|
|
|
+- **Attribute:** `data-alignment-select-control-options`
|
|
|
|
|
|
-- **type:** `Selector`
|
|
|
+- **type:** `String`
|
|
|
|
|
|
- **Detail:**
|
|
|
|
|
|
- Set to e.g. `#filter` to allow custom input filter in a element with the id `filter`.
|
|
|
- Each filter element (input or select) must have the following id `bootstrap-table-filter-control-<Fieldname>` (<Fieldname> must be replaced with the defined [Field](https://bootstrap-table.com/docs/api/column-options/#field) name).
|
|
|
+ Set the alignemnt of the select control options. Use Use `left`, `right` or `auto`.
|
|
|
|
|
|
-- **Default:** `false`
|
|
|
+- **Default:** `undefined`
|
|
|
|
|
|
-### filterDataCollector
|
|
|
+### disableControlWhenSearch
|
|
|
|
|
|
-- **Attribute:** `data-filter-data-collector`
|
|
|
+- **Attribute:** `data-disable-control-when-search`
|
|
|
|
|
|
-- **type:** `Function`
|
|
|
+- **type:** `Boolean`
|
|
|
|
|
|
- **Detail:**
|
|
|
|
|
|
- Collect data which will added to the select filter, to filter through e.g. labels which are comma separated and displayed with a formatter.
|
|
|
+ Set to true if you want to disable the control while the server is responding the data. This options will work if the sidePagination is 'server'.
|
|
|
|
|
|
-- **Default:** `undefined`
|
|
|
+- **Default:** `false`
|
|
|
|
|
|
-### alignmentSelectControlOptions
|
|
|
+### filterControlContainer
|
|
|
|
|
|
-- **Attribute:** `data-alignment-select-control-options`
|
|
|
+- **Attribute:** `data-filter-control-container`
|
|
|
|
|
|
-- **type:** `String`
|
|
|
+- **type:** `Selector`
|
|
|
|
|
|
- **Detail:**
|
|
|
|
|
|
- Set the alignemnt of the select control options. Use Use `left`, `right` or `auto`.
|
|
|
+ Set to e.g. `#filter` to allow custom input filter in a element with the id `filter`.
|
|
|
+ Each filter element (input or select) must have the following id `bootstrap-table-filter-control-<Fieldname>` (<Fieldname> must be replaced with the defined [Field](https://bootstrap-table.com/docs/api/column-options/#field) name).
|
|
|
|
|
|
-- **Default:** `undefined`
|
|
|
+- **Default:** `false`
|
|
|
|
|
|
-### hideUnusedSelectOptions
|
|
|
+### filterDataCollector
|
|
|
|
|
|
-- **Attribute:** `data-hide-unused-select-options`
|
|
|
+- **Attribute:** `data-filter-data-collector`
|
|
|
|
|
|
-- **type:** `Boolean`
|
|
|
+- **type:** `Function`
|
|
|
|
|
|
- **Detail:**
|
|
|
|
|
|
- Set to true in order to hide the options that are not in the table. This option does not work on server-side pagination.
|
|
|
+ Collect data which will added to the select filter, to filter through e.g. labels which are comma separated and displayed with a formatter.
|
|
|
|
|
|
-- **Default:** `false`
|
|
|
+- **Default:** `undefined`
|
|
|
|
|
|
-### disableControlWhenSearch
|
|
|
+### hideUnusedSelectOptions
|
|
|
|
|
|
-- **Attribute:** `data-disable-control-when-search`
|
|
|
+- **Attribute:** `data-hide-unused-select-options`
|
|
|
|
|
|
- **type:** `Boolean`
|
|
|
|
|
|
- **Detail:**
|
|
|
|
|
|
- Set to true if you want to disable the control while the server is responding the data. This options will work if the sidePagination is 'server'.
|
|
|
+ Set to true in order to hide the options that are not in the table. This option does not work on server-side pagination.
|
|
|
|
|
|
- **Default:** `false`
|
|
|
|
|
|
@@ -120,82 +120,79 @@ Dependence if you use the datepicker option: [bootstrap-datepicker](https://gith
|
|
|
|
|
|
- **Default:** `undefined`
|
|
|
|
|
|
-### filterData
|
|
|
+### filterControlPlaceholder
|
|
|
|
|
|
-- **Attribute:** `data-filter-data`
|
|
|
+- **attribute:** `data-filter-control-placeholder`
|
|
|
|
|
|
- **type:** `String`
|
|
|
|
|
|
- **Detail:**
|
|
|
|
|
|
- Set custom select filter values, use
|
|
|
- `var:variable` to load from a variable
|
|
|
- `obj:variable.key` to load from a object
|
|
|
- `url:http://www.example.com/data.json` to load from a remote json file
|
|
|
- `json:{key:data}` to load from a json string.
|
|
|
- `func:functionName` to load from a function.
|
|
|
+ Set this in order to show a placeholder only in the input filter control.
|
|
|
|
|
|
-- **Default:** `undefined`
|
|
|
+- **Default:** `''`
|
|
|
|
|
|
-### filterDefault
|
|
|
+### filterCustomSearch
|
|
|
|
|
|
-- **Attribute:** `data-filter-default`
|
|
|
+- **Attribute:** `data-filter-custom-search`
|
|
|
|
|
|
-- **type:** `String`
|
|
|
+- **type:** `function`
|
|
|
|
|
|
- **Detail:**
|
|
|
|
|
|
- Set the default value of the filter.
|
|
|
-
|
|
|
-- **Default:** `undefined`
|
|
|
-
|
|
|
-### filterDatepickerOptions
|
|
|
-
|
|
|
-- **Attribute:** `data-filter-datepicker-options`
|
|
|
-
|
|
|
-- **type:** `Object`
|
|
|
+ The custom search function is executed instead of built-in search function, takes four parameters:
|
|
|
|
|
|
-- **Detail:**
|
|
|
+ * `text`: the search text.
|
|
|
+ * `value`: the the value of the column to compare.
|
|
|
+ * `field`: the column field name.
|
|
|
+ * `data`: the table data.
|
|
|
|
|
|
- If the datepicker option is set use this option to configure the datepicker with the native options. Use this way: `data-filter-datepicker-options='{"autoclose":true, "clearBtn": true, "todayHighlight": true}'`.
|
|
|
+ Return `false` to filter out the current column/row.
|
|
|
+ Return `true` to not filter out the current column/row.
|
|
|
+ Return `null` to skip the custom search for the current value.
|
|
|
|
|
|
- **Default:** `undefined`
|
|
|
|
|
|
-### filterStrictSearch
|
|
|
+### filterData
|
|
|
|
|
|
-- **Attribute:** `data-filter-strict-search`
|
|
|
+- **Attribute:** `data-filter-data`
|
|
|
|
|
|
-- **type:** `Boolean`
|
|
|
+- **type:** `String`
|
|
|
|
|
|
- **Detail:**
|
|
|
|
|
|
- Set to true if you want to use the strict search mode.
|
|
|
+ Set custom select filter values, use
|
|
|
+ `var:variable` to load from a variable
|
|
|
+ `obj:variable.key` to load from a object
|
|
|
+ `url:http://www.example.com/data.json` to load from a remote json file
|
|
|
+ `json:{key:data}` to load from a json string.
|
|
|
+ `func:functionName` to load from a function.
|
|
|
|
|
|
-- **Default:** `false`
|
|
|
+- **Default:** `undefined`
|
|
|
|
|
|
-### filterStartsWithSearch
|
|
|
+### filterDatepickerOptions
|
|
|
|
|
|
-- **attribute:** `data-filter-starts-with-search`
|
|
|
+- **Attribute:** `data-filter-datepicker-options`
|
|
|
|
|
|
-- **type:** `Boolean`
|
|
|
+- **type:** `Object`
|
|
|
|
|
|
- **Detail:**
|
|
|
|
|
|
- Set to true if you want to use the starts with search mode.
|
|
|
+ If the datepicker option is set use this option to configure the datepicker with the native options. Use this way: `data-filter-datepicker-options='{"autoclose":true, "clearBtn": true, "todayHighlight": true}'`.
|
|
|
|
|
|
-- **Default:** `false`
|
|
|
+- **Default:** `undefined`
|
|
|
|
|
|
-### filterControlPlaceholder
|
|
|
+### filterDefault
|
|
|
|
|
|
-- **attribute:** `data-filter-control-placeholder`
|
|
|
+- **Attribute:** `data-filter-default`
|
|
|
|
|
|
- **type:** `String`
|
|
|
|
|
|
- **Detail:**
|
|
|
|
|
|
- Set this in order to show a placeholder only in the input filter control.
|
|
|
+ Set the default value of the filter.
|
|
|
|
|
|
-- **Default:** `''`
|
|
|
+- **Default:** `undefined`
|
|
|
|
|
|
### filterOrderBy
|
|
|
|
|
|
@@ -209,38 +206,33 @@ Dependence if you use the datepicker option: [bootstrap-datepicker](https://gith
|
|
|
|
|
|
- **Default:** `'asc'`
|
|
|
|
|
|
-### filterCustomSearch
|
|
|
+### filterStartsWithSearch
|
|
|
|
|
|
-- **Attribute:** `data-filter-custom-search`
|
|
|
+- **attribute:** `data-filter-starts-with-search`
|
|
|
|
|
|
-- **type:** `function`
|
|
|
+- **type:** `Boolean`
|
|
|
|
|
|
- **Detail:**
|
|
|
|
|
|
- The custom search function is executed instead of built-in search function, takes four parameters:
|
|
|
+ Set to true if you want to use the starts with search mode.
|
|
|
|
|
|
- * `text`: the search text.
|
|
|
- * `value`: the the value of the column to compare.
|
|
|
- * `field`: the column field name.
|
|
|
- * `data`: the table data.
|
|
|
+- **Default:** `false`
|
|
|
|
|
|
- Return `false` to filter out the current column/row.
|
|
|
- Return `true` to not filter out the current column/row.
|
|
|
- Return `null` to skip the custom search for the current value.
|
|
|
+### filterStrictSearch
|
|
|
|
|
|
-- **Default:** `undefined`
|
|
|
+- **Attribute:** `data-filter-strict-search`
|
|
|
|
|
|
-### Icons
|
|
|
+- **type:** `Boolean`
|
|
|
|
|
|
-* clear: 'glyphicon-trash icon-clear'
|
|
|
+- **Detail:**
|
|
|
|
|
|
-## Locale
|
|
|
+ Set to true if you want to use the strict search mode.
|
|
|
|
|
|
-### formatClearFilters
|
|
|
+- **Default:** `false`
|
|
|
|
|
|
-- **type:** `Function`
|
|
|
+### Icons
|
|
|
|
|
|
-- **Default:** `function () { return "Clear Filters";}`
|
|
|
+* clear: 'glyphicon-trash icon-clear'
|
|
|
|
|
|
## Events
|
|
|
|
|
|
@@ -261,3 +253,11 @@ Dependence if you use the datepicker option: [bootstrap-datepicker](https://gith
|
|
|
### clearFilterControl
|
|
|
|
|
|
* Clear all the controls added by this plugin (similar to showSearchClearButton option).
|
|
|
+
|
|
|
+## Locale
|
|
|
+
|
|
|
+### formatClearFilters
|
|
|
+
|
|
|
+- **type:** `Function`
|
|
|
+
|
|
|
+- **Default:** `function () { return "Clear Filters";}`
|