Browse Source

Adding documentation of group by formatter

djhvscf 6 years ago
parent
commit
a4913dbece
1 changed files with 15 additions and 1 deletions
  1. 15 1
      site/docs/extensions/group-by.md

+ 15 - 1
site/docs/extensions/group-by.md

@@ -58,4 +58,18 @@ jsFiddle example: [boostrap-table-group-by](https://jsfiddle.net/Bighamster/fj8d
 
    Set the names of the fields by which you want to calculate averages.
 
-- **Default:** ``
+- **Default:** ``
+
+### groupByFormatter
+
+- **type:** `Function`
+
+- **Detail:**
+
+   The group row formatter function, takes three parameters:
+
+   * `colspan`: the colspan should be applied to the tr element.
+   * `key`: the group key name.
+   * `tds`: an array of tds elements to be added to the tr element.
+
+- **Default:** `undefined`