Browse Source

Merge branch 'hotfix/docs'

zhixin 6 years ago
parent
commit
011e5c9601
1 changed files with 28 additions and 6 deletions
  1. 28 6
      site/docs/api/table-options.md

+ 28 - 6
site/docs/api/table-options.md

@@ -25,7 +25,7 @@ The table options are defined in `jQuery.fn.bootstrapTable.defaults`.
 
 - **Default:** `'table'`
 
-- **Example:** [From HTML](https://examples.bootstrap-table.com/#options/from-html.html)
+- **Example:** [From HTML](https://examples.bootstrap-table.com/#welcomes/from-html.html)
 
 ## height
 
@@ -285,7 +285,7 @@ The table options are defined in `jQuery.fn.bootstrapTable.defaults`.
 
 - **Default:** `[]`
 
-- **Example:** [From Data](https://examples.bootstrap-table.com/#options/from-data.html)
+- **Example:** [From Data](https://examples.bootstrap-table.com/#welcomes/from-data.html)
 
 ## url
 
@@ -304,7 +304,7 @@ The table options are defined in `jQuery.fn.bootstrapTable.defaults`.
 
 - **Default:** `undefined`
 
-- **Example:** [From URL](https://examples.bootstrap-table.com/#options/from-url.html)
+- **Example:** [From URL](https://examples.bootstrap-table.com/#welcomes/from-url.html)
 
 ## method
 
@@ -1116,6 +1116,8 @@ The table options are defined in `jQuery.fn.bootstrapTable.defaults`.
 
 - **Default:** `false`
 
+- **Example:** [Card View](https://examples.bootstrap-table.com/#options/card-view.html)
+
 ## detailView
 
 - **Attribute:** `data-detail-view`
@@ -1128,6 +1130,8 @@ The table options are defined in `jQuery.fn.bootstrapTable.defaults`.
 
 - **Default:** `false`
 
+- **Example:** [Detail View](https://examples.bootstrap-table.com/#options/detail-view.html)
+
 ## detailFormatter
 
 - **Attribute:** `data-detail-formatter`
@@ -1140,6 +1144,8 @@ The table options are defined in `jQuery.fn.bootstrapTable.defaults`.
 
 - **Default:** `function(index, row, element) { return '' }`
 
+- **Example:** [Detail View](https://examples.bootstrap-table.com/#options/detail-view.html)
+
 ## detailFilter
 
 - **Attribute:** `data-detail-filter`
@@ -1152,6 +1158,8 @@ The table options are defined in `jQuery.fn.bootstrapTable.defaults`.
 
 - **Default:** `function(index, row) { return true }`
 
+- **Example:** [Detail Filter](https://examples.bootstrap-table.com/#options/detail-filter.html)
+
 ## toolbar
 
 - **Attribute:** `data-toolbar`
@@ -1164,6 +1172,8 @@ The table options are defined in `jQuery.fn.bootstrapTable.defaults`.
 
 - **Default:** `undefined`
 
+- **Example:** [Custom Toolbar](https://examples.bootstrap-table.com/#options/custom-toolbar.html)
+
 ## toolbarAlign
 
 - **Attribute:** `data-toolbar-align`
@@ -1176,6 +1186,8 @@ The table options are defined in `jQuery.fn.bootstrapTable.defaults`.
 
 - **Default:** `'left'`
 
+- **Example:** [Toolbar Align](https://examples.bootstrap-table.com/#options/toolbar-align.html)
+
 ## buttonsToolbar
 
 - **Attribute:** `data-buttons-toolbar`
@@ -1184,10 +1196,12 @@ The table options are defined in `jQuery.fn.bootstrapTable.defaults`.
 
 - **Detail:**
 
-  A jQuery selector that indicates the buttons toolbar, for example: `#buttons-toolbar`, `.buttons-toolbar`, or a DOM node.
+  A jQuery selector that indicates the custom buttons toolbar, for example: `#buttons-toolbar`, `.buttons-toolbar`, or a DOM node.
 
 - **Default:** `undefined`
 
+- **Example:** [Buttons Toolbar](https://examples.bootstrap-table.com/#options/buttons-toolbar.html)
+
 ## buttonsAlign
 
 - **Attribute:** `data-buttons-align`
@@ -1200,6 +1214,8 @@ The table options are defined in `jQuery.fn.bootstrapTable.defaults`.
 
 - **Default:** `'right'`
 
+- **Example:** [Buttons Align](https://examples.bootstrap-table.com/#options/buttons-align.html)
+
 ## buttonsClass
 
 - **Attribute:** `data-buttons-class`
@@ -1208,10 +1224,12 @@ The table options are defined in `jQuery.fn.bootstrapTable.defaults`.
 
 - **Detail:**
 
-  Defines the Bootstrap class (added after `'btn-'`) of table buttons.
+  Defines the class (added after `'btn-'`) of table buttons.
 
 - **Default:** `'secondary'`
 
+- **Example:** [Buttons Class](https://examples.bootstrap-table.com/#options/buttons-class.html)
+
 ## icons
 
 - **Attribute:** `data-icons`
@@ -1248,10 +1266,12 @@ The table options are defined in `jQuery.fn.bootstrapTable.defaults`.
 
 - **Detail:**
 
-  Defines icon size: `undefined` => `btnxs` => `btn-xssm` => `btn-smlg` => `btn-lg`
+  Defines icon size, `undefined`, `'lg'`, `'sm'` can be used.
 
 - **Default:** `undefined`
 
+- **Example:** [Icon Size](https://examples.bootstrap-table.com/#options/icon-size.html)
+
 ## iconsPrefix
 
 - **Attribute:** `data-icons-prefix`
@@ -1263,3 +1283,5 @@ The table options are defined in `jQuery.fn.bootstrapTable.defaults`.
   Defines icon set name (`'glyphicon'` or `'fa'` for FontAwesome). By default `'fa'` is used for Bootstrap v4.
 
 - **Default:** `'fa'`
+
+- **Example:** [Icons Prefix](https://examples.bootstrap-table.com/#options/icons-prefix.html)