Browse Source

Update doc for column options data-formatter and data-footer-formatter

weibangtuo 1 year ago
parent
commit
cc913a37ae
2 changed files with 9 additions and 1 deletions
  1. 6 0
      CHANGELOG.md
  2. 3 1
      site/docs/api/column-options.md

+ 6 - 0
CHANGELOG.md

@@ -1,6 +1,12 @@
 ChangeLog
 ---------
 
+### 1.23.3
+
+### Core
+
+- **New:** Added support for column options `formatter` and `footerFormatter` methods returning type `jQuery`, `HTMLElement`.
+
 ### 1.23.2
 
 ### Core

+ 3 - 1
site/docs/api/column-options.md

@@ -230,7 +230,7 @@ The column options is defined in `jQuery.fn.bootstrapTable.columnDefaults`.
   * `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.
+  The expected return data type is `jQuery`, `String` or `HTMLElement`. Other types will be forced to the `String` type.
 
   If you fetch data from a server and set the footer value from the server response, please use the `footerField` Option.
 
@@ -282,6 +282,8 @@ The column options is defined in `jQuery.fn.bootstrapTable.columnDefaults`.
   * `index`: the row index.
   * `field`: the row field.
 
+  The expected return data type is `jQuery`, `String` or `HTMLElement`. Other types will be forced to the `String` type.
+
 - **Default:** `undefined`
 
 - **Example:** [Column Formatter](https://examples.bootstrap-table.com/#column-options/formatter.html)