Browse Source

Added documentation

Dustin Utecht 5 years ago
parent
commit
3f25f9d55f
2 changed files with 28 additions and 0 deletions
  1. 14 0
      site/docs/api/column-options.md
  2. 14 0
      site/docs/api/table-options.md

+ 14 - 0
site/docs/api/column-options.md

@@ -346,6 +346,20 @@ The column options is defined in `jQuery.fn.bootstrapTable.columnDefaults`.
 
 - **Example:** [Column Searchable](https://examples.bootstrap-table.com/#column-options/searchable.html)
 
+## searchHighlightFormatter
+
+- **Attribute:** `data-search-highlight-formatter`
+
+- **Type:** `Function|Bool`
+
+- **Detail:**
+
+  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/search-highlight-formatter.html)
+
 ## showSelectTitle
 
 - **Attribute:** `data-show-select-title`

+ 14 - 0
site/docs/api/table-options.md

@@ -1103,6 +1103,20 @@ The table options are defined in `jQuery.fn.bootstrapTable.defaults`.
 
 - **Example:** [Search Align](https://examples.bootstrap-table.com/#options/search-align.html)
 
+## searchHighlight
+
+- **Attribute:** `data-search-highlight`
+
+- **Type:** `Boolean`
+
+- **Detail:**
+
+  Set to `true` to highlight the searched text (using the `<mark>` html tag).   
+  You can also define a [custom highlight formatter](https://bootstrap-table.com/docs/api/column-options/#searchhighlightformatter) e.g. for values with html or to use a custom highlight color. 
+- **Default:** `'false'`
+
+- **Example:** [Search Align](https://examples.bootstrap-table.com/#options/search-highlight.html)
+
 ## searchOnEnterKey
 
 - **Attribute:** `data-search-on-enter-key`