Browse Source

Merge branch 'hotfix/extensions-docs'

zhixin 6 years ago
parent
commit
ba81c28749

+ 0 - 4
site/_data/nav.yml

@@ -28,13 +28,9 @@
     - title: Filter Control
     - title: Fixed Columns
     - title: Group By v2
-    - title: Group By
     - title: i18n Enhance
     - title: Key Events
     - title: Mobile
-    - title: Multi Column Toggle
-    - title: Multiple Search
-    - title: Multiple Selection Row
     - title: Multiple Sort
     - title: Natural Sorting
     - title: Page Jump To

+ 4 - 0
site/docs/extensions/cookie.md

@@ -12,6 +12,10 @@ toc: true
 <script src="extensions/cookie/bootstrap-table-cookie.js"></script>
 {% endhighlight %}
 
+## Example
+
+[Cookie](https://examples.bootstrap-table.com/#extensions/cookie.html)
+
 ## Options
 
 ### cookie

+ 4 - 0
site/docs/extensions/copy-rows.md

@@ -14,6 +14,10 @@ This extension adds functionality for copying selected rows to the clipboard. Cu
 <script src="extensions/copy-rows/bootstrap-table-copy-rows.js"></script>
 {% endhighlight %}
 
+## Example
+
+[Copy Rows](https://examples.bootstrap-table.com/#extensions/copy-rows.html)
+
 ## Options
 
 ### showCopyRows

+ 4 - 0
site/docs/extensions/defer-url.md

@@ -12,6 +12,10 @@ toc: true
 <script src="extensions/defer-url/bootstrap-table-defer-url.js"></script>
 {% endhighlight %}
 
+## Example
+
+[Defer URL](https://examples.bootstrap-table.com/#extensions/defer-url.html)
+
 ## Options
 
 ### deferUrl

+ 4 - 0
site/docs/extensions/export.md

@@ -16,6 +16,10 @@ This is an important link to check out as some file types may require extra step
 <script src="extensions/export/bootstrap-table-export.js"></script>
 {% endhighlight %}
 
+## Example
+
+[Export](https://examples.bootstrap-table.com/#extensions/export.html)
+
 ## Options
 
 ### showExport

+ 4 - 2
site/docs/extensions/filter-control.md

@@ -6,8 +6,6 @@ group: extensions
 toc: true
 ---
 
-Use Plugin: [bootstrap-table-filter-control](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/filter-control)
-
 Dependence if you use the datepicker option: [bootstrap-datepicker](https://github.com/eternicode/bootstrap-datepicker) v1.4.0
 
 ## Usage
@@ -17,6 +15,10 @@ Dependence if you use the datepicker option: [bootstrap-datepicker](https://gith
 <script src="extensions/filter-control/bootstrap-table-filter-control.js"></script>
 {% endhighlight %}
 
+## Example
+
+[Filter Control](https://examples.bootstrap-table.com/#extensions/filter-control.html)
+
 ## Options
 
 ### filterControl

+ 4 - 0
site/docs/extensions/fixed-columns.md

@@ -13,6 +13,10 @@ toc: true
 <script src="extensions/fixed-columns/bootstrap-table-fixed-columns.js"></script>
 {% endhighlight %}
 
+## Example
+
+[Fixed Columns](https://examples.bootstrap-table.com/#extensions/fixed-columns.html)
+
 ## Options
 
 ### fixedColumns

+ 5 - 3
site/docs/extensions/group-by-v2.md

@@ -6,15 +6,17 @@ group: extensions
 toc: true
 ---
 
-Use Plugin: [bootstrap-table-group-by-v2](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/group-by-v2) </br>
-You must include the bootstrap-table-group-by.css file in order to get the appropriate style
-
 ## Usage
 
 {% highlight html %}
+<link rel="stylesheet" src="extensions/group-by-v2/bootstrap-table-group-by.css">
 <script src="extensions/group-by-v2/bootstrap-table-group-by.js"></script>
 {% endhighlight %}
 
+## Example
+
+[Group By v2](https://examples.bootstrap-table.com/#extensions/group-by-v2.html)
+
 ## Options
 
 ### groupBy

+ 4 - 2
site/docs/extensions/i18n-enhance.md

@@ -6,14 +6,16 @@ group: extensions
 toc: true
 ---
 
-Use Plugin: [bootstrap-table-i18n-enhance](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/i18n-enhance)
-
 ## Usage
 
 {% highlight html %}
 <script src="extensions/i18n-enhance/bootstrap-table-i18n-enhance.js"></script>
 {% endhighlight %}
 
+## Example
+
+[i18n Enhance](https://examples.bootstrap-table.com/#extensions/i18n-enhance.html)
+
 ## Methods
 
 ### changeLocale

+ 4 - 2
site/docs/extensions/key-events.md

@@ -6,14 +6,16 @@ group: extensions
 toc: true
 ---
 
-Use Plugin: [bootstrap-table-key-events](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/key-events)
-
 ## Usage
 
 {% highlight html %}
 <script src="extensions/key-events/bootstrap-table-key-events.js"></script>
 {% endhighlight %}
 
+## Example
+
+[Key Events](https://examples.bootstrap-table.com/#extensions/key-events.html)
+
 ## Options
 
 ### keyEvents

+ 4 - 2
site/docs/extensions/mobile.md

@@ -6,14 +6,16 @@ group: extensions
 toc: true
 ---
 
-Use Plugin: [bootstrap-table-mobile](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/mobile)
-
 ## Usage
 
 {% highlight html %}
 <script src="extensions/mobile/bootstrap-table-mobile.js"></script>
 {% endhighlight %}
 
+## Example
+
+[Mobile](https://examples.bootstrap-table.com/#extensions/mobile.html)
+
 ## Options
 
 ### mobileResponsive

+ 4 - 2
site/docs/extensions/multiple-sort.md

@@ -6,14 +6,16 @@ group: extensions
 toc: true
 ---
 
-Use Plugin: [bootstrap-table-multiple-sort](https://github.com/dimbslmh/bootstrap-table/tree/master/src/extensions/multiple-sort)
-
 ## Usage
 
 {% highlight html %}
 <script src="extensions/multiple-sort/bootstrap-table-multiple-sort.js"></script>
 {% endhighlight %}
 
+## Example
+
+[Multiple Sort](https://examples.bootstrap-table.com/#extensions/multiple-sort.html)
+
 ## Options
 
 ### showMultiSort

+ 0 - 2
site/docs/extensions/natural-sorting.md

@@ -6,8 +6,6 @@ group: extensions
 toc: true
 ---
 
-Use Plugin: [bootstrap-table-natural-sorting](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/natural-sorting)
-
 ## Usage
 
 {% highlight html %}

+ 4 - 0
site/docs/extensions/page-jump-to.md

@@ -13,6 +13,10 @@ toc: true
 <script src="extensions/page-jump-to/bootstrap-table-jump-to.js"></script>
 {% endhighlight %}
 
+## Example
+
+[Page Jump To](https://examples.bootstrap-table.com/#extensions/page-jump-to.html)
+
 ## Options
 
 ### showJumpTo

+ 4 - 0
site/docs/extensions/print.md

@@ -14,6 +14,10 @@ Adds a button to the toolbar for printing the table in a predefined configurable
 <script src="extensions/print/bootstrap-table-print.js"></script>
 {% endhighlight %}
 
+## Example
+
+[Print](https://examples.bootstrap-table.com/#extensions/print.html)
+
 ## Options
 
 ### showPrint

+ 10 - 6
site/docs/extensions/reorder-columns.md

@@ -6,20 +6,24 @@ group: extensions
 toc: true
 ---
 
-Use Plugin: [bootstrap-table-reorder-columns](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/reorder-columns) </br>
-Dependence: [dragTable](https://github.com/akottr/dragtable/) v2.0.14 (must include the css file), </br>
-[jquery-ui](https://code.jquery.com/ui/) v1.11
+Dependence:
+* [dragTable](https://github.com/akottr/dragtable/) v2.0.14 (must include the css file)
+* [jquery-ui](https://code.jquery.com/ui/) v1.11
 
 
 ## Usage
 
 {% highlight html %}
-<link rel="stylesheet" href=".../dragtable.css">
-<script src=".../jquery-ui.js"></script>
-<script src=".../jquery.dragtable.js"></script>
+<link rel="stylesheet" href="dragtable.css">
+<script src="jquery-ui.js"></script>
+<script src="jquery.dragtable.js"></script>
 <script src="extensions/reorder-columns/bootstrap-table-reorder-columns.js"></script>
 {% endhighlight %}
 
+## Example
+
+[Reorder Columns](https://examples.bootstrap-table.com/#extensions/reorder-columns.html)
+
 ## Options
 
 ### reorderableColumns

+ 8 - 4
site/docs/extensions/reorder-rows.md

@@ -6,19 +6,23 @@ group: extensions
 toc: true
 ---
 
-Use Plugin: [bootstrap-table-reorder-rows](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/reorder-rows) </br>
-Dependence: [tablednd](https://github.com/isocra/TableDnD) v0.9, </br>
-if you want you can include the bootstrap-table-reorder-rows.css file to use the default dragClass
+Dependence: [tablednd](https://github.com/isocra/TableDnD) v0.9
+
+if you want you can include the bootstrap-table-reorder-rows.css file to use the default dragClass.
 
 
 ## Usage
 
 {% highlight html %}
-<link rel="stylesheet" href=".../bootstrap-table-reorder-rows.css">
+<link rel="stylesheet" href="extensions/reorder-rows/bootstrap-table-reorder-rows.css">
 <script src=".../jquery.tablednd.js"></script>
 <script src="extensions/reorder-rows/bootstrap-table-reorder-rows.js"></script>
 {% endhighlight %}
 
+## Example
+
+[Reorder Rows](https://examples.bootstrap-table.com/#extensions/reorder-rows.html)
+
 ## Options
 
 ### reorderableRows

+ 5 - 2
site/docs/extensions/resizable.md

@@ -6,7 +6,6 @@ group: extensions
 toc: true
 ---
 
-Use Plugin: [bootstrap-table-resizable](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/resizable) </br>
 Dependence: [jquery-resizable-columns](https://github.com/dobtco/jquery-resizable-columns) v0.2.3
 
 ## Usage
@@ -15,6 +14,10 @@ Dependence: [jquery-resizable-columns](https://github.com/dobtco/jquery-resizabl
 <script src="extensions/resizable/bootstrap-table-resizable.js"></script>
 {% endhighlight %}
 
+## Example
+
+[Resizable](https://examples.bootstrap-table.com/#extensions/resizable.html)
+
 ## Options
 
 ### resizable
@@ -29,4 +32,4 @@ Dependence: [jquery-resizable-columns](https://github.com/dobtco/jquery-resizabl
 
 ## Known issues
 
-### This plugin does not work when data-height is set.
+- **This plugin does not work when data-height is set.**

+ 4 - 2
site/docs/extensions/toolbar.md

@@ -6,14 +6,16 @@ group: extensions
 toc: true
 ---
 
-Use Plugin: [bootstrap-table-toolbar](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/toolbar)
-
 ## Usage
 
 {% highlight html %}
 <script src="extensions/toolbar/bootstrap-table-toolbar.js"></script>
 {% endhighlight %}
 
+## Example
+
+[Advanced Toolbar](https://examples.bootstrap-table.com/#extensions/toolbar.html)
+
 ## Options
 
 ### advancedSearch

+ 4 - 1
site/docs/extensions/treegrid.md

@@ -6,7 +6,6 @@ group: extensions
 toc: true
 ---
 
-Use Plugin: [bootstrap-table-treegrid](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/treegrid)</br>
 Dependence: [jquery-treegrid](https://github.com/maxazan/jquery-treegrid) v0.3.0
 
 ## Usage
@@ -15,6 +14,10 @@ Dependence: [jquery-treegrid](https://github.com/maxazan/jquery-treegrid) v0.3.0
 <script src="extensions/treegrid/bootstrap-table-treegrid.js"></script>
 {% endhighlight %}
 
+## Example
+
+[Treegrid](https://examples.bootstrap-table.com/#extensions/treegrid.html)
+
 ## Options
 
 ### idField