Merge pull request #7444 from weibangtuo/feat/formatter-dom

Supports column formatter options returns dom element or jquery element
wenzhixin · Aug 7, 2024 · 8b589b7 · 8b589b7
2 parents 3b4fcf3 + cc913a3
commit 8b589b7
Show file tree

Hide file tree

Showing 6 changed files with 288 additions and 198 deletions.
diff --git a/CHANGELOG.md b/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

diff --git a/site/docs/api/column-options.md b/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)