Merge pull request #5308 from wenzhixin/develop

1.18.0

Author: UtechtDustin

.gitignore

@@ -1,6 +1,9 @@
 node_modules
 bower_components
 
+# Tools
+tools/bootstrap-table-examples
+
 # docs site
 _gh_pages
 

.travis.yml

@@ -9,10 +9,10 @@ jobs:
       node_js:
         - 12
       name: "Lint src and check docs"
-      before_install:
+      script:
         - cd tools
         - git clone --depth=1 https://github.com/wenzhixin/bootstrap-table-examples
-      script: npm run pre-commit
+        - npm run pre-commit
       if: branch != master AND type = pull_request
 
     - stage: deploy

CHANGELOG.md

@@ -1,6 +1,47 @@
 ChangeLog
 ---------
 
+### 1.18.0
+
+#### Core
+
+- **New(option):** Added `buttons` to add custom buttons to the button bar.
+- **New(option):** Added `footerField` to support `server` side pagination.
+- **New(option):** Added new parameter `value` to `footerFormatter`.
+- **New(option):** Added `searchHighlight` and `searchHighlightFormatter`.
+- **New(option):** Added `searchSelector` to custom the search input.
+- **New(event):** Added `BootstrapTable` object as last parameter to all `event`.
+- **New(css):** Added CSS transitions for loading style.
+- **New:** Added support for `style` attribute of `tr` or `td`.
+- **New:** Added ability to use `colspan` in the footer.
+- **Update:** Updated search input type from `text` to `search`.
+- **Update:** Fixed `normalize` not string bug when using `searchAccentNeutralise`.
+- **Update:** Fixed complex group header bug.
+- **Update:** Fixed `resize` and `scroll` event bug with multiple tables.
+- **Update:** Fixed `getScrollPosition` bug when using group-by extension.
+- **Update:** Fixed `updateRow` with `customSearch` and `sortReset` bug.
+- **Update:** Fixed `colspan` and `mergeCell` bug when using `detailFormatter`.
+- **Update:** Fixed `init` bug when using `onPostBody`.
+- **Update:** Fixed sort bug when the `field` is set to `0`.
+- **Update:** Fixed `showFooter` display bug after resize table width.
+- **Update:** Fixed not update selected rows bug when using `checkAll`/`uncheckAll`.
+- **Update:** Fixed `checked` property bug using `formatter` when the field has a value.
+- **Update:** Fixed default data shared bug with multiple tables.
+- **Remove(method):** Removed `getAllSelections` method.
+
+#### Extensions
+
+- **New(addrbar):** Added support for `client` side pagination.
+- **New(cookie):** Added `cookieSameSite` option to prevent breaking changes.
+- **New(group-by):** Added `groupByToggle` and `groupByShowToggleIcon` options.
+- **New(group-by):** Added `groupByCollapsedGroups` option to allow collapse groups.
+- **Update(cookie):** Fixed cookie size is too big bug when saving columns.
+- **Update(cookie):** Fixed checkbox column disappears bug.
+- **Update(export):** Fixed cannot export `all` data bug with pagination.
+- **Update(group-by):** Fixed `scrollTo` not working properly bug.
+- **Update(multiple-sort):** Fixed cannot work bug.
+- **Update(sticky-header):** Fixed vertical scroll cannot work bug.
+
 ### 1.17.1
 
 #### Core

README.md

@@ -2,11 +2,10 @@
 
 [![Build Status](https://travis-ci.org/wenzhixin/bootstrap-table.svg)](https://travis-ci.org/wenzhixin/bootstrap-table)
 [![GitHub version](https://badge.fury.io/gh/wenzhixin%2Fbootstrap-table.svg)](http://badge.fury.io/gh/wenzhixin%2Fbootstrap-table)
-[![Bower version](https://badge.fury.io/bo/bootstrap-table.svg)](http://badge.fury.io/bo/bootstrap-table)
-[![jsDelivr Hits](https://data.jsdelivr.com/v1/package/npm/bootstrap-table/badge?style=rounded)](https://www.jsdelivr.com/package/npm/bootstrap-table)
 [![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ZDHP676FQDUT6)
 [![Backers on Open Collective](https://opencollective.com/bootstrap-table/backers/badge.svg)](#backers)
 [![Sponsors on Open Collective](https://opencollective.com/bootstrap-table/sponsors/badge.svg)](#sponsors)
+[![Package Quality](https://npm.packagequality.com/shield/bootstrap-table.svg)](https://packagequality.com/#?package=bootstrap-table)
 
 An extended Bootstrap table with radio, checkbox, sort, pagination, extensions and other added features.
 

package.json

@@ -27,9 +27,8 @@
     "rollup-plugin-inject": "^3.0.0",
     "rollup-plugin-multi-entry": "^2.1.0",
     "rollup-plugin-node-resolve": "^5.0.4",
-    "rollup-plugin-terser": "^6.1.0",
+    "rollup-plugin-terser": "^7.0.0",
     "rollup-plugin-vue": "5.1.9",
-    "safe-eval": "^0.4.1",
     "stylelint": "^13.3.3",
     "stylelint-config-standard": "^20.0.0",
     "vue-template-compiler": "^2.6.10"

site/docs/api/column-options.md

@@ -225,12 +225,15 @@ The column options is defined in `jQuery.fn.bootstrapTable.columnDefaults`.
 
   The context (this) is the column Object.
 
-  The function, take one parameter:
+  The function, takes two parameters:
 
-  * `data`: Array of all the  data rows.
+  * `data`: Array of all the data rows.
+  * `value`: If footer data is set, the value of the footer column.
 
   the function should return a string with the text to show in the footer cell.
 
+  If you fetch data from a server and tries to set the footer value from the server response, please use the `footerField` Option.
+
 - **Default:** `undefined`
 
 - **Example:** [Footer Formatter](https://examples.bootstrap-table.com/#column-options/footer-formatter.html)
@@ -315,6 +318,20 @@ The column options is defined in `jQuery.fn.bootstrapTable.columnDefaults`.
 
 - **Example:** [Rowspan Colspan](https://examples.bootstrap-table.com/#column-options/rowspan-colspan.html)
 
+## searchable
+
+- **Attribute:** `data-searchable`
+
+- **Type:** `Boolean`
+
+- **Detail:**
+
+  Set `true` to search data for this column.
+
+- **Default:** `true`
+
+- **Example:** [Column Searchable](https://examples.bootstrap-table.com/#column-options/searchable.html)
+
 ## searchFormatter
 
 - **Attribute:** `data-search-formatter`
@@ -329,19 +346,19 @@ The column options is defined in `jQuery.fn.bootstrapTable.columnDefaults`.
 
 - **Example:** [Search Formatter](https://examples.bootstrap-table.com/#column-options/search-formatter.html)
 
-## searchable
+## searchHighlightFormatter
 
-- **Attribute:** `data-searchable`
+- **Attribute:** `data-search-highlight-formatter`
 
-- **Type:** `Boolean`
+- **Type:** `Boolean|Function`
 
 - **Detail:**
 
-  Set `true` to search data for this column.
+  Define a `function` to use a custom highlight formatter for the [search highlight](https://bootstrap-table.com/docs/api/table-options/#searchhighlight) option.
 
 - **Default:** `true`
 
-- **Example:** [Column Searchable](https://examples.bootstrap-table.com/#column-options/searchable.html)
+- **Example:** [Searchable Highlight Formatter](https://examples.bootstrap-table.com/#column-options/search-highlight-formatter.html)
 
 ## showSelectTitle
 
@@ -357,20 +374,6 @@ The column options is defined in `jQuery.fn.bootstrapTable.columnDefaults`.
 
 - **Example:** [Show Select Title](https://examples.bootstrap-table.com/#column-options/show-select-title.html)
 
-## sortName
-
-- **Attribute:** `data-sort-name`
-
-- **Type:** `String`
-
-- **Detail:**
-
-  Provide a customizable sort-name, not the default sort-name in the header, or the field name of the column. For example, a column might display the value of fieldName of 'html' such as `<b><span style="color:red">abc</span></b>`, but a fieldName to sort is 'content' with the value of `'abc'`.
-
-- **Default:** `undefined`
-
-- **Example:** [Sort Name Order](https://examples.bootstrap-table.com/#column-options/sort-name-order.html)
-
 ## sortable
 
 - **Attribute:** `data-sortable`
@@ -406,6 +409,20 @@ The column options is defined in `jQuery.fn.bootstrapTable.columnDefaults`.
 
 - **Example:** [Column Sorter](https://examples.bootstrap-table.com/#column-options/sorter.html)
 
+## sortName
+
+- **Attribute:** `data-sort-name`
+
+- **Type:** `String`
+
+- **Detail:**
+
+  Provide a customizable sort-name, not the default sort-name in the header, or the field name of the column. For example, a column might display the value of fieldName of 'html' such as `<b><span style="color:red">abc</span></b>`, but a fieldName to sort is 'content' with the value of `'abc'`.
+
+- **Default:** `undefined`
+
+- **Example:** [Sort Name Order](https://examples.bootstrap-table.com/#column-options/sort-name-order.html)
+
 ## switchable
 
 - **Attribute:** `data-switchable`

site/docs/api/events.md

@@ -9,12 +9,16 @@ toc: true
 To use event syntax:
 
 {% highlight html %}
+// Here you can expect to have as last parameter the boostrap-table object
+
 $('#table').bootstrapTable({
   onEventName: function (arg1, arg2, ...) {
     // ...
   }
 })
 
+// Here you can expect to have in the 'e' variable the sender property which is the boostrap-table object
+
 $('#table').on('event-name.bs.table', function (e, arg1, arg2, ...) {
   // ...
 })

site/docs/api/localizations.md

@@ -125,6 +125,18 @@ $('#table').bootstrapTable({
 
 - **Default:** `'Refresh'`
 
+## formatSearch
+
+- **Parameter:** `undefined`
+
+- **Default:** `'Search'`
+
+## formatShowingRows
+
+- **Parameter:** `pageFrom, pageTo, totalRows`
+
+- **Default:** `'Showing %s to %s of %s rows'`
+
 ## formatSRPaginationNextText
 
 - **Parameter:** `undefined`
@@ -143,18 +155,6 @@ $('#table').bootstrapTable({
 
 - **Default:** `'previous page'`
 
-## formatSearch
-
-- **Parameter:** `undefined`
-
-- **Default:** `'Search'`
-
-## formatShowingRows
-
-- **Parameter:** `pageFrom, pageTo, totalRows`
-
-- **Default:** `'Showing %s to %s of %s rows'`
-
 ## formatToggle
 
 - **Parameter:** `undefined`

site/docs/api/methods.md

@@ -167,16 +167,6 @@ The calling method syntax: `$('#table').bootstrapTable('method', parameter)`.
 
 - **Example:** [Filter By](https://examples.bootstrap-table.com/#methods/filter-by.html)
 
-## getAllSelections
-
-- **Parameter:** `undefined`
-
-- **Detail:**
-
-  Return all selected rows contain search or filter, when no record selected, an empty array will return.
-
-- **Example:** [Get All Selections](https://examples.bootstrap-table.com/#methods/get-all-selections.html)
-
 ## getData
 
 - **Parameter:** `params`
@@ -249,6 +239,7 @@ The calling method syntax: `$('#table').bootstrapTable('method', parameter)`.
 - **Detail:**
 
   Return selected rows, when no record selected, an empty array will return.
+  The selected rows will be unselected while some actions happens e.g. searching or page change, if you want to maintain the selections please use [maintainMetaData](https://bootstrap-table.com/docs/api/table-options/#maintainmetadata). 
 
 - **Example:** [Get Selections](https://examples.bootstrap-table.com/#methods/get-selections.html)