浏览代码

Updated the docs API of extensions

zhixin 5 年之前
父节点
当前提交
aa751e9998

+ 20 - 12
site/docs/extensions/auto-refresh.md

@@ -30,18 +30,6 @@ toc: true
 
 - **Default:** `false`
 
-### autoRefreshStatus
-
-- **Attribute:** `data-auto-refresh-status`
-
-- **type:** `Boolean`
-
-- **Detail:**
-
-   Set `true` to enable auto refresh. This is the state auto refresh will be in when the table loads. Clicking the button toggles this property. This is simply the default state of auto refresh as the user can always change it by clicking the button.
-
-- **Default:** `true`
-
 ### autoRefreshInterval
 
 - **Attribute:** `data-auto-refresh-interval`
@@ -66,6 +54,26 @@ toc: true
 
 - **Default:** `true`
 
+### autoRefreshStatus
+
+- **Attribute:** `data-auto-refresh-status`
+
+- **type:** `Boolean`
+
+- **Detail:**
+
+   Set `true` to enable auto refresh. This is the state auto refresh will be in when the table loads. Clicking the button toggles this property. This is simply the default state of auto refresh as the user can always change it by clicking the button.
+
+- **Default:** `true`
+
 ### Icons
 
 - autoRefresh: 'fa-clock'
+
+## Localizations
+
+### formatAutoRefresh
+
+- **Parameter:** `undefined`
+
+- **Default:** `'Auto Refresh'`

+ 71 - 67
site/docs/extensions/cookie.md

@@ -30,29 +30,57 @@ toc: true
 
 - **Default:** `false`
 
-### cookieExpire
+### cookieCustomStorageDelete
 
-- **Attribute:** `data-cookie-expire`
+- **Attribute:** `data-cookie-custom-storage-delete`
 
-- **type:** `String`
+- **type:** `function`
+
+- **parameter**
+
+  - cookieName - The name of the value e.g. the search
 
 - **Detail:**
 
-   You must set this property if cookie option is enable to know when will expire the cookie created. Must use this format: `'number{letter}'` like `'2h'`, in the letter position you can use: `'s'`, `'mi'`, `'h'`, `'d'`, `'m'`, `'y'`, these means: `'seconds'`, `'minutes'`, `'hours'`, `'days'`, `'months'`, `'years'`.
+   This option allows to delete values with your custom function.
+   This option is only required if you use `customStorage` on the `cookieStorage` option!
 
-- **Default:** `2h`
+- **Default:** `undefined`
 
-### cookiePath
+### cookieCustomStorageGet
 
-- **Attribute:** `data-cookie-path`
+- **Attribute:** `data-cookie-custom-storage-get`
 
-- **type:** `String`
+- **type:** `function`
+
+- **parameter**
+
+  - cookieName - The name of the value e.g. the search
 
 - **Detail:**
 
-   you can tell the browser what path the cookie belongs to. By default, the cookie belongs to the current page.
+   This option allows to get the saved value from your custom function.
+   This option is only required if you use `customStorage` on the `cookieStorage` option!
 
-- **Default:** `null`
+- **Default:** `undefined`
+
+### cookieCustomStorageSet
+
+- **Attribute:** `data-cookie-custom-storage-set`
+
+- **type:** `function`
+
+- **parameter**
+
+  - cookieName - The name of the value e.g. the search
+  - value - The value which will be saved
+
+- **Detail:**
+
+   This option allows to save values with your custom function.
+   This option is only required if you use `customStorage` on the `cookieStorage` option!
+
+- **Default:** `undefined`
 
 ### cookieDomain
 
@@ -66,17 +94,17 @@ toc: true
 
 - **Default:** `null`
 
-### cookieSecure
+### cookieExpire
 
-- **Attribute:** `data-cookie-secure`
+- **Attribute:** `data-cookie-expire`
 
-- **type:** `Boolean`
+- **type:** `String`
 
 - **Detail:**
 
-   This property keeps cookie communication limited to encrypted transmission, directing browsers to use cookies only via secure/encrypted connections.
+   You must set this property if cookie option is enable to know when will expire the cookie created. Must use this format: `'number{letter}'` like `'2h'`, in the letter position you can use: `'s'`, `'mi'`, `'h'`, `'d'`, `'m'`, `'y'`, these means: `'seconds'`, `'minutes'`, `'hours'`, `'days'`, `'months'`, `'years'`.
 
-- **Default:** `null`
+- **Default:** `2h`
 
 ### cookieIdTable
 
@@ -90,83 +118,66 @@ toc: true
 
 - **Default:** `''`
 
-### cookieStorage
+### cookiePath
 
-- **Attribute:** `data-cookie-storage`
+- **Attribute:** `data-cookie-path`
 
 - **type:** `String`
 
 - **Detail:**
 
-   Set the storage that this extension will use. Use `cookieStorage` or `localStorage` or `sessionStorage` or `customStorage`.
-   
-   Info for `customStorage`:   
-   You have use `cookieCustomStorageGet`, `cookieCustomStorageSet` and `cookieCustomStorageDelete`. 
+   you can tell the browser what path the cookie belongs to. By default, the cookie belongs to the current page.
 
-- **Default:** `cookieStorage`
+- **Default:** `null`
 
-### cookiesEnabled
+### cookieSecure
 
-- **Attribute:** `data-cookies-enabled`
+- **Attribute:** `data-cookie-secure`
 
-- **type:** `Array`
+- **type:** `Boolean`
 
 - **Detail:**
 
-   Set this array with the table properties (sortOrder, sortName, pageNumber, pageList, columns, searchText, filterControl) that you want to save
-
-- **Default:** `['bs.table.sortOrder', 'bs.table.sortName', 'bs.table.pageNumber', 'bs.table.pageList', 'bs.table.columns', 'bs.table.searchText', 'bs.table.filterControl']`
+   This property keeps cookie communication limited to encrypted transmission, directing browsers to use cookies only via secure/encrypted connections.
 
-### cookieCustomStorageGet
+- **Default:** `null`
 
-- **Attribute:** `data-cookie-custom-storage-get`
+### cookieStorage
 
-- **type:** `function`
+- **Attribute:** `data-cookie-storage`
 
-- **parameter**
-  - cookieName - The name of the value e.g. the search
+- **type:** `String`
 
 - **Detail:**
 
-   This option allows to get the saved value from your custom function.   
-   This option is only required if you use `customStorage` on the `cookieStorage` option! 
+   Set the storage that this extension will use. Use `cookieStorage` or `localStorage` or `sessionStorage` or `customStorage`.
 
-- **Default:** `undefined`
+   Info for `customStorage`:
+   You have use `cookieCustomStorageGet`, `cookieCustomStorageSet` and `cookieCustomStorageDelete`.
 
-### cookieCustomStorageSet
+- **Default:** `cookieStorage`
 
-- **Attribute:** `data-cookie-custom-storage-set`
+### cookiesEnabled
 
-- **type:** `function`
+- **Attribute:** `data-cookies-enabled`
 
-- **parameter**
-  - cookieName - The name of the value e.g. the search
-  - value - The value which will be saved
+- **type:** `Array`
 
 - **Detail:**
 
-   This option allows to save values with your custom function.   
-   This option is only required if you use `customStorage` on the `cookieStorage` option! 
-
-- **Default:** `undefined`
+   Set this array with the table properties (sortOrder, sortName, pageNumber, pageList, columns, searchText, filterControl) that you want to save
 
-### cookieCustomStorageDelete
+- **Default:** `['bs.table.sortOrder', 'bs.table.sortName', 'bs.table.pageNumber', 'bs.table.pageList', 'bs.table.columns', 'bs.table.searchText', 'bs.table.filterControl']`
 
-- **Attribute:** `data-cookie-custom-storage-delete`
+## Methods
 
-- **type:** `function`
+### deleteCookie
 
-- **parameter**
-  - cookieName - The name of the value e.g. the search
+- **parameters:** `cookieName`
 
 - **Detail:**
 
-   This option allows to delete values with your custom function.      
-   This option is only required if you use `customStorage` on the `cookieStorage` option! 
-
-- **Default:** `undefined`
-
-## Methods
+   Delete the saved cookie by cookie name.
 
 ### getCookies
 
@@ -176,18 +187,11 @@ toc: true
 
    Return the saved cookies.
 
-### deleteCookie
-
-- **parameters:** `cookieName`
-
-- **Detail:**
-
-   Delete the saved cookie by cookie name.
-
 ## This plugin saves
 
-* Sort order
 * Page number
 * Page number from the list
-* Visible columns
 * Search text
+* Search filter control
+* Sort order
+* Visible columns

+ 16 - 12
site/docs/extensions/copy-rows.md

@@ -32,18 +32,6 @@ This extension adds functionality for copying selected rows to the clipboard. Cu
 
 - **Default:** `false`
 
-### copyWithHidden
-
-- **Attribute:** `data-copy-width-hidden`
-
-- **type:** `Boolean`
-
-- **Detail:**
-
-   Set `true` to copy with hidden columns.
-
-- **Default:** `false`
-
 ### copyDelimiter
 
 - **Attribute:** `data-copy-delimiter`
@@ -68,6 +56,22 @@ This extension adds functionality for copying selected rows to the clipboard. Cu
 
 - **Default:** `'\n'`
 
+### copyWithHidden
+
+- **Attribute:** `data-copy-width-hidden`
+
+- **type:** `Boolean`
+
+- **Detail:**
+
+   Set `true` to copy with hidden columns.
+
+- **Default:** `false`
+
+### Icons
+
+- copy: 'fa-copy'
+
 ## Methods
 
 ### copyColumnsToClipboard

+ 15 - 0
site/docs/extensions/editable.md

@@ -61,6 +61,21 @@ Use Plugin: [x-editable](https://github.com/vitalets/x-editable)
   </table>
   {% endhighlight %}
 
+  You can use `noeditFormatter` to disable the editable column, for example:
+
+  {% highlight javascript %}
+  {
+    editable: {
+      noeditFormatter (value, row, index) {
+        if (value === 'noedit') {
+          return true
+        }
+        return false
+      }
+    }
+  }
+  {% endhighlight %}
+
 - **Default:** `undefined`
 
 ## Events

+ 37 - 7
site/docs/extensions/export.md

@@ -46,17 +46,17 @@ This is an important link to check out as some file types may require extra step
 
 - **Default:** `basic`
 
-### exportTypes
+### exportFooter
 
-- **Attribute:** `data-export-types`
+- **Attribute:** `data-export-footer`
 
-- **type:** `Array`
+- **type:** `Boolean`
 
 - **Detail:**
 
-   export types, support types: 'json', 'xml', 'png', 'csv', 'txt', 'sql', 'doc', 'excel', 'xlsx', 'pdf'.
+   set `true` to export the table footer.
 
-- **Default:** `['json', 'xml', 'csv', 'txt', 'sql', 'excel']`
+- **Default:** `false`
 
 ### exportOptions
 
@@ -78,8 +78,24 @@ This is an important link to check out as some file types may require extra step
    }
    ```
 
+### exportTypes
+
+- **Attribute:** `data-export-types`
+
+- **type:** `Array`
+
+- **Detail:**
+
+   export types, support types: 'json', 'xml', 'png', 'csv', 'txt', 'sql', 'doc', 'excel', 'xlsx', 'pdf'.
+
+- **Default:** `['json', 'xml', 'csv', 'txt', 'sql', 'excel']`
+
 - **Default:** `{}`
 
+### Icons
+
+- export: `'glyphicon-export icon-share'`
+
 ## Column options
 
 ### forceExport
@@ -108,6 +124,20 @@ This is an important link to check out as some file types may require extra step
 
   * `exportedRows`: The exported rows (depends on exportDataType)
 
-### Icons
+## Methods
 
-- export: `'glyphicon-export icon-share'`
+### exportTable
+
+- **parameters:** `options`
+
+- **Detail:**
+
+   Export table with custom options.
+
+## Localizations
+
+### formatExport
+
+- **Parameter:** `undefined`
+
+- **Default:** `'Export data'`

+ 79 - 79
site/docs/extensions/filter-control.md

@@ -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";}`

+ 11 - 9
site/docs/extensions/i18n-enhance.md

@@ -21,16 +21,18 @@ toc: true
 ### changeLocale
 
 * Change table locale.
-	* Parameters
-		* String : localeId
-	* Example: <code> $table.bootstrapTable("changeLocale", "zh_TW");</code>
+
+  * Parameters
+	* String : localeId
+  * Example: <code> $table.bootstrapTable('changeLocale', 'zh_TW')</code>
 
 ### changeTitle
 
 * Change column's title.
-	* Parameters
-		* Object : object's key is column field , value is new title.
-	* Example: <code> $table.bootstrapTable("changeTitle", {
-          columnA.field: "New column A title.",
-          columnB.field: "New column B title."
-        });</code>
+  * Parameters
+	* Object : object's key is column field , value is new title.
+  * Example: <code>
+  	$table.bootstrapTable('changeTitle', {
+      columnA.field: 'New column A title.',
+      columnB.field: 'New column B title.'
+    })</code>

+ 22 - 22
site/docs/extensions/mobile.md

@@ -18,18 +18,6 @@ toc: true
 
 ## Options
 
-### mobileResponsive
-
-- **attribute:** `data-mobile-responsive`
-
-- **type:** `Boolean`
-
-- **Detail:**
-
-   Set true to change the view between card and table view depending on width and height given.
-
-- **Default:** `false`
-
 ### checkOnInit
 
 - **attribute:** `data-check-on-init`
@@ -42,17 +30,17 @@ toc: true
 
 - **Default:** `true`
 
-### minWidth
+### columnsHidden
 
-- **attribute:** `data-min-width`
+- **attribute:** `data-columns-hidden`
 
-- **type:** `Integer`
+- **type:** `String`
 
 - **Detail:**
 
-   Set the minimum width when the table will change the view.
+   Set the columns fields in this array in order to hide those columns in the cardView mode. Use this way in `data-*` configuration: ` data-columns-hidden="['name', 'description']"` or this way in javascript configuration: `columnsHidden = ['name', 'description']`.
 
-- **Default:** `562`
+- **Default:** `undefined`
 
 ### minHeight
 
@@ -66,14 +54,26 @@ toc: true
 
 - **Default:** `undefined`
 
-### columnsHidden
+### minWidth
 
-- **attribute:** `data-columns-hidden`
+- **attribute:** `data-min-width`
 
-- **type:** `String`
+- **type:** `Integer`
 
 - **Detail:**
 
-   Set the columns fields in this array in order to hide those columns in the cardView mode. Use this way in `data-*` configuration: ` data-columns-hidden="['name', 'description']"` or this way in javascript configuration: `columnsHidden = ['name', 'description']`.
+   Set the minimum width when the table will change the view.
 
-- **Default:** `undefined`
+- **Default:** `562`
+
+### mobileResponsive
+
+- **attribute:** `data-mobile-responsive`
+
+- **type:** `Boolean`
+
+- **Detail:**
+
+   Set true to change the view between card and table view depending on width and height given.
+
+- **Default:** `false`

+ 35 - 47
site/docs/extensions/multiple-sort.md

@@ -106,114 +106,102 @@ toc: true
 
 ## Locales
 
-### formatMultipleSort
-
-
-- **Detail:**
-
-   Title of the advanced search modal
-
-- **Default:** `Multiple Sort`
-
 ### formatAddLevel
 
-
 - **Detail:**
 
-   Text of the add level button
+  Text of the add level button
 
 - **Default:** `Add Level`
 
-### formatDeleteLevel
-
+### formatCancel
 
 - **Detail:**
 
-   Text of the delete level button
+  Text of the delete level button
 
-- **Default:** `Delete Level`
+- **Default:** `Cancel`
 
 ### formatColumn
 
-
 - **Detail:**
 
-   Text of Column header
+  Text of Column header
 
 - **Default:** `Column`
 
-### formatOrder
-
+### formatDeleteLevel
 
 - **Detail:**
 
-   Text of the delete level button
+  Text of the delete level button
 
-- **Default:** `Order`
-
-### formatSortBy
+- **Default:** `Delete Level`
 
+### formatDuplicateAlertTitle
 
 - **Detail:**
 
-   Text of the delete level button
-
-- **Default:** `Sort by`
+  Title of the duplicate alert
 
-### formatThenBy
+- **Default:** `Duplicate(s) detected!`
 
+### formatDuplicateAlertDescription
 
 - **Detail:**
 
-   Text of the delete level button
-
-- **Default:** `Then by`
+  Text of the duplicate alert
 
-### formatSort
+- **Default:** `Please remove or change any duplicate column.`
 
+### formatMultipleSort
 
 - **Detail:**
 
-   Text of the delete level button
+  Title of the advanced search modal
 
-- **Default:** `Sort`
-
-### formatCancel
+- **Default:** `Multiple Sort`
 
+### formatOrder
 
 - **Detail:**
 
-   Text of the delete level button
-
-- **Default:** `Cancel`
+  Text of the delete level button
 
-### formatDuplicateAlertTitle
+- **Default:** `Order`
 
+### formatSort
 
 - **Detail:**
 
-   Title of the duplicate alert
+  Text of the delete level button
 
-- **Default:** `Duplicate(s) detected!`
-
-### formatDuplicateAlertDescription
+- **Default:** `Sort`
 
+### formatSortBy
 
 - **Detail:**
 
-   Text of the duplicate alert
+  Text of the delete level button
 
-- **Default:** `Please remove or change any duplicate column.`
+- **Default:** `Sort by`
 
 ### formatSortOrders
 
-
 - **Detail:**
 
-   Text of the sort orders
+  Text of the sort orders
 
 - **Default:**asc : `Ascending` and desc : `Descending`
 
+### formatThenBy
+
+- **Detail:**
+
+  Text of the delete level button
+
+- **Default:** `Then by`
+
 ## Events
 
 ### onMultipleSort(multiple-sort.bs.table)

+ 8 - 0
site/docs/extensions/page-jump-to.md

@@ -30,3 +30,11 @@ toc: true
    Set true to enable show 'jump to page'. Can be defined via `data-show-jump-to` HTML attributes.
 
 - **Default:** `false`
+
+## Localizations
+
+### formatJumpTo
+
+- **Parameter:** `undefined`
+
+- **Default:** `'GO'`

+ 24 - 24
site/docs/extensions/print.md

@@ -44,6 +44,18 @@ Adds a button to the toolbar for printing the table in a predefined configurable
 
 - **Default:** `true`
 
+### printPageBuilder
+
+- **attribute:** `data-print-page-builder`
+
+- **type:** `Function`
+
+- **Detail:**
+
+   Receive html `<table>` element as string parameter, returns html string for printing. Used for styling and adding header or footer.
+
+- **Default:** `function(table){return printPageBuilderDefault(table)}`
+
 ### printSortColumn
 
 - **attribute:** `data-print-sort-column`
@@ -68,17 +80,9 @@ Adds a button to the toolbar for printing the table in a predefined configurable
 
 - **Default:** `'asc'`
 
-### printPageBuilder
-
-- **attribute:** `data-print-page-builder`
+### Icons
 
-- **type:** `Function`
-
-- **Detail:**
-
-   Receive html `<table>` element as string parameter, returns html string for printing. Used for styling and adding header or footer.
-
-- **Default:** `function(table){return printPageBuilderDefault(table)}`
+* print: `'glyphicon-print icon-share'`
 
 ## Column options
 
@@ -94,18 +98,6 @@ Adds a button to the toolbar for printing the table in a predefined configurable
 
 - **Default:** `undefined`
 
-### printIgnore
-
-- **attribute:** `data-print-ignore`
-
-- **type:** `Boolean`
-
-- **Detail:**
-
-   set true to hide this column in the printed page.
-
-- **Default:** `false`
-
 ### printFormatter
 
 - **attribute:** `data-print-formatter`
@@ -118,6 +110,14 @@ Adds a button to the toolbar for printing the table in a predefined configurable
 
 - **Default:** `undefined`
 
-## Icons
+### printIgnore
 
-* print: `'glyphicon-print icon-share'`
+- **attribute:** `data-print-ignore`
+
+- **type:** `Boolean`
+
+- **Detail:**
+
+   set true to hide this column in the printed page.
+
+- **Default:** `false`

+ 15 - 15
site/docs/extensions/reorder-columns.md

@@ -38,6 +38,18 @@ Dependence:
 
 - **Default:** `false`
 
+### dragaccept
+
+- **attribute:** `data-dragaccept`
+
+- **type:** `String`
+
+- **Detail:**
+
+   Allow to drag only the rows that have the css class as attribute.
+
+- **Default:** `null`
+
 ### maxMovingRows
 
 - **attribute:** `data-max-moving-rows`
@@ -50,17 +62,11 @@ Dependence:
 
 - **Default:** `10`
 
-### dragaccept
-
-- **attribute:** `data-dragaccept`
-
-- **type:** `String`
-
-- **Detail:**
+## Events
 
-   Allow to drag only the rows that have the css class as attribute.
+### onReorderColumn(reorder-column.bs.table)
 
-- **Default:** `null`
+Fired when the column was dropped, receive as parameter the new header fields order.
 
 ## Methods
 
@@ -72,9 +78,3 @@ Dependence:
 
    Reorders the the columns by the given object.
    The Object key has to be the [field](https://bootstrap-table.com/docs/api/column-options/#field) and the value is the column index (starts by 0).
-
-## Events
-
-### onReorderColumn(reorder-column.bs.table)
-
-Fired when the column was dropped, receive as parameter the new header fields order

+ 28 - 29
site/docs/extensions/reorder-rows.md

@@ -10,7 +10,6 @@ Dependence: [tablednd](https://github.com/isocra/TableDnD) v0.9
 
 if you want you can include the bootstrap-table-reorder-rows.css file to use the default dragClass.
 
-
 ## Usage
 
 {% highlight html %}
@@ -49,18 +48,6 @@ if you want you can include the bootstrap-table-reorder-rows.css file to use the
 
 - **Default:** `null`
 
-### onDropStyle
-
-- **attribute:** `data-on-drop-style`
-
-- **type:** `String`
-
-- **Detail:**
-
-   This is the style that is assigned to the row when it is dropped. As for onDragStyle, there are limitations to what you can do. Also this replaces the original style, so again consider using onDragClass which is simply added and then removed on drop.
-
-- **Default:** `null`
-
 ### onDragClass
 
 - **attribute:** `data-on-drag-class`
@@ -73,29 +60,17 @@ if you want you can include the bootstrap-table-reorder-rows.css file to use the
 
 - **Default:** `reorder_rows_onDragClass`
 
-### dragHandle
+### onDropStyle
 
-- **attribute:** `data-drag-handle`
+- **attribute:** `data-on-drop-style`
 
 - **type:** `String`
 
 - **Detail:**
 
-   This is the cursor to use
-
-- **Default:** `>tbody>tr>td`
-
-### useRowAttrFunc
-
-- **attribute:** `data-use-row-attr-func`
-
-- **type:** `Boolean`
-
-- **Detail:**
-
-   This function must be use if your `tr` elements won't have the `id` attribute. If your `tr` elements don't have the `id` attribute this plugin don't fire the onDrop event.
+   This is the style that is assigned to the row when it is dropped. As for onDragStyle, there are limitations to what you can do. Also this replaces the original style, so again consider using onDragClass which is simply added and then removed on drop.
 
-- **Default:** `false`
+- **Default:** `null`
 
 ### onReorderRowsDrag
 
@@ -121,6 +96,30 @@ if you want you can include the bootstrap-table-reorder-rows.css file to use the
 
 - **Default:** `empty function`
 
+### dragHandle
+
+- **attribute:** `data-drag-handle`
+
+- **type:** `String`
+
+- **Detail:**
+
+   This is the cursor to use
+
+- **Default:** `>tbody>tr>td`
+
+### useRowAttrFunc
+
+- **attribute:** `data-use-row-attr-func`
+
+- **type:** `Boolean`
+
+- **Detail:**
+
+   This function must be use if your `tr` elements won't have the `id` attribute. If your `tr` elements don't have the `id` attribute this plugin don't fire the onDrop event.
+
+- **Default:** `false`
+
 ## Events
 
 ### onReorderRow(reorder-row.bs.table)

+ 11 - 11
site/docs/extensions/sticky-header.md

@@ -32,38 +32,38 @@ This is an extension which provides a sticky header for the table when scrolling
 
 - **Default:** `false`
 
-### stickyHeaderOffsetY
+### stickyHeaderOffsetLeft
 
-- **attribute:** `data-sticky-header-offset-y`
+- **attribute:** `data-sticky-header-offset-left`
 
-- **type:** `Number`
+- **type:** `Number | String`
 
 - **Detail:**
 
-   Set the Y offset from the top of the window to pin the sticky header. If there is a fixed navigation bar with a height of 60px, this value would be `60`.
+   Set the left offset of the sticky header container.
 
 - **Default:** `0`
 
-### stickyHeaderOffsetLeft
+### stickyHeaderOffsetRight
 
-- **attribute:** `data-sticky-header-offset-left`
+- **attribute:** `data-sticky-header-offset-right`
 
 - **type:** `Number | String`
 
 - **Detail:**
 
-   Set the left offset of the sticky header container.
+   Set the right offset of the sticky header container.
 
 - **Default:** `0`
 
-### stickyHeaderOffsetRight
+### stickyHeaderOffsetY
 
-- **attribute:** `data-sticky-header-offset-right`
+- **attribute:** `data-sticky-header-offset-y`
 
-- **type:** `Number | String`
+- **type:** `Number`
 
 - **Detail:**
 
-   Set the right offset of the sticky header container.
+   Set the Y offset from the top of the window to pin the sticky header. If there is a fixed navigation bar with a height of 60px, this value would be `60`.
 
 - **Default:** `0`

+ 17 - 17
site/docs/extensions/toolbar.md

@@ -30,29 +30,29 @@ toc: true
 
 - **Default:** `false`
 
-### idForm
+### actionForm
 
-- **attribute:** `data-id-form`
+- **attribute:** `data-action-form`
 
 - **type:** `String`
 
 - **Detail:**
 
-   Must be set to know the idform.
+   Set the action of the form (pop-up).
 
-- **Default:** `advancedSearch`
+- **Default:** `''`
 
-### actionForm
+### idForm
 
-- **attribute:** `data-action-form`
+- **attribute:** `data-id-form`
 
 - **type:** `String`
 
 - **Detail:**
 
-   Set the action of the form (pop-up).
+   Must be set to know the idform.
 
-- **Default:** `''`
+- **Default:** `advancedSearch`
 
 ### idTable
 
@@ -66,15 +66,13 @@ toc: true
 
 - **Default:** `''`
 
-## Locales
-
-### formatAdvancedSearch
+## Events
 
-- **Detail:**
+### onColumnAdvancedSearch(column-advanced-search.bs.table)
 
-   Title of the advanced search modal
+* Fired when we are searching into the advanced search form.
 
-- **Default:** `Advanced search`
+## Locales
 
 ### formatAdvancedCloseButton
 
@@ -84,8 +82,10 @@ toc: true
 
 - **Default:** `Close`
 
-## Events
+### formatAdvancedSearch
 
-### onColumnAdvancedSearch(column-advanced-search.bs.table)
+- **Detail:**
+
+   Title of the advanced search modal
 
-* Fired when we are searching into the advanced search form
+- **Default:** `Advanced search`

+ 8 - 8
site/docs/extensions/treegrid.md

@@ -44,29 +44,29 @@ Dependence: [jquery-treegrid](https://github.com/maxazan/jquery-treegrid) v0.3.0
 
 - **Default:** `'id'`
 
-### treeShowField
+### parentIdField
 
-- **attribute:** `data-tree-show-field`
+- **attribute:** `data-parent-id-field`
 
 - **type:** `String`
 
 - **Detail:**
 
-  Set the `treeShowField` will auto enable the tree grid.
+  Set the parent id field.
 
-- **Default:** `''`
+- **Default:** `'pid'`
 
-### parentIdField
+### treeShowField
 
-- **attribute:** `data-parent-id-field`
+- **attribute:** `data-tree-show-field`
 
 - **type:** `String`
 
 - **Detail:**
 
-  Set the parent id field.
+  Set the `treeShowField` will auto enable the tree grid.
 
-- **Default:** `'pid'`
+- **Default:** `''`
 
 ### rootParentId
 

+ 5 - 0
src/extensions/addrbar/bootstrap-table-addrbar.js

@@ -63,6 +63,11 @@ function _buildUrl (dict, url = window.location.search) {
   return url
 }
 
+$.extend($.fn.bootstrapTable.defaults, {
+  addrbar: false,
+  addrPrefix: ''
+})
+
 $.BootstrapTable = class extends $.BootstrapTable {
   init (...args) {
     if (

+ 3 - 0
src/extensions/cookie/bootstrap-table-cookie.js

@@ -249,6 +249,9 @@ $.extend($.fn.bootstrapTable.defaults, {
     'bs.table.reorderColumns'
   ],
   cookieStorage: 'cookieStorage', // localStorage, sessionStorage, customStorage
+  cookieCustomStorageGet: null,
+  cookieCustomStorageSet: null,
+  cookieCustomStorageDelete: null,
   // internal variable
   filterControls: [],
   filterControlValuesLoaded: false