浏览代码

Update docs and README.

zhixin 11 年之前
父节点
当前提交
a22af30bfa

+ 3 - 2
README.md

@@ -27,7 +27,7 @@ Bootstrap table displays data in a tabular format and offers rich support to rad
 - [ ] Fix #144: `onCheck` and `onUncheck` method are reversed when using `clickToSelect` option. (jQuery 1.7.2 bug).
 - [x] Apply `width` column option to row style.
 - [x] Add bootstrap-table-filter extension.
-- [x] Add cs-CZ, es-CR, es-NI, pl-PL, ur-PK and ko-KR locales.
+- [x] Add cs-CZ, es-CR, es-NI, pl-PL, ur-PK, ko-KR, th-TH locales.
 - [x] Fix `minimumCountColumns` option init error.
 - [x] Fix #161: `undefined` or `null` string sort bug.
 - [x] Fix #171: IE disabled button can be clicked bug.
@@ -37,7 +37,8 @@ Bootstrap table displays data in a tabular format and offers rich support to rad
 - [x] Add `searchAlign` and `toolbarAlign` options.
 - [x] Fix #193: Add `dataType` option.
 - [x] Add flatJSON and editable extensions.
-- [ ] Update documentation.
+- [x] Add `rowAttributes` option.
+- [x] Update documentation.
 
 ## Features
 

+ 16 - 0
docs/_includes/examples/events.md

@@ -0,0 +1,16 @@
+# Events []({{ site.repo }}/blob/master/docs/_includes/examples/events.md)
+
+---
+
+## Basic Events
+
+Table events. _by [@wenzhixin](https://github.com/wenzhixin)_
+
+<iframe width="100%" height="500" src="http://jsfiddle.net/wenyi/e3nk137y/36/embedded/html,js,result" allowfullscreen="allowfullscreen" frameborder="0"></iframe>
+
+## Column Events
+
+Use `formatter`, `events` column option to define the custom events. _by [@wenzhixin](https://github.com/wenzhixin)_
+
+<iframe width="100%" height="500" src="http://jsfiddle.net/wenyi/e3nk137y/39/embedded/html,js,css,result" allowfullscreen="allowfullscreen" frameborder="0"></iframe>
+

+ 23 - 0
docs/_includes/examples/methods.md

@@ -0,0 +1,23 @@
+# Methods []({{ site.repo }}/blob/master/docs/_includes/examples/methods.md)
+
+---
+
+## Reset View
+
+The table header does not adjust automatically, We need to call `resetView` method. _by [@wenzhixin](https://github.com/wenzhixin)_
+
+<iframe width="100%" height="300" src="http://jsfiddle.net/wenyi/e3nk137y/40/embedded/html,js,result" allowfullscreen="allowfullscreen" frameborder="0"></iframe>
+
+
+<!--
+## Data Methods
+
+
+## Merge Cells
+
+
+## Check Methods
+
+
+## Column Methods
+-->

+ 9 - 0
docs/_includes/examples/pagination.md

@@ -0,0 +1,9 @@
+# Pagination []({{ site.repo }}/blob/master/docs/_includes/examples/pagination.md)
+
+---
+
+## Client Side
+
+The default side pagination of table is `client`. _by [@wenzhixin](https://github.com/wenzhixin)_
+
+<iframe width="100%" height="400" src="http://jsfiddle.net/wenyi/e3nk137y/42/embedded/html,js,result" allowfullscreen="allowfullscreen" frameborder="0"></iframe>

+ 27 - 0
docs/_includes/examples/select.md

@@ -0,0 +1,27 @@
+# Select []({{ site.repo }}/blob/master/docs/_includes/examples/select.md)
+
+---
+
+## Radio Select
+
+Use `clickToSelect`, `selectItemName` options and `radio` column option to show a radio select table. _by [@wenzhixin](https://github.com/wenzhixin)_
+
+<iframe width="100%" height="300" src="http://jsfiddle.net/wenyi/e3nk137y/29/embedded/html,result" allowfullscreen="allowfullscreen" frameborder="0"></iframe>
+
+## Checkbox Select
+
+Use `clickToSelect` option and `checkbox` column option to show a checkbox select table. _by [@wenzhixin](https://github.com/wenzhixin)_
+
+<iframe width="100%" height="300" src="http://jsfiddle.net/wenyi/e3nk137y/30/embedded/html,result" allowfullscreen="allowfullscreen" frameborder="0"></iframe>
+
+## Disabled Checkbox
+
+Use `checkboxHeader`, `checkboxEnable` options and `formatter` column option to disabled select input. _by [@wenzhixin](https://github.com/wenzhixin)_
+
+<iframe width="100%" height="300" src="http://jsfiddle.net/wenyi/e3nk137y/31/embedded/html,js,result" allowfullscreen="allowfullscreen" frameborder="0"></iframe>
+
+## Single Checkbox
+
+Use `singleSelect` option to allow checkbox selecting only one row. _by [@wenzhixin](https://github.com/wenzhixin)_
+
+<iframe width="100%" height="300" src="http://jsfiddle.net/wenyi/e3nk137y/32/embedded/html,result" allowfullscreen="allowfullscreen" frameborder="0"></iframe>

+ 15 - 0
docs/_includes/examples/toolbar.md

@@ -0,0 +1,15 @@
+# Toolbar []({{ site.repo }}/blob/master/docs/_includes/examples/toolbar.md)
+
+---
+
+## Basic Toolbar
+
+Use `search`, `showColumns`, `showRefresh`, `showToggle` options to show the basic toolbars. _by [@wenzhixin](https://github.com/wenzhixin)_
+
+<iframe width="100%" height="300" src="http://jsfiddle.net/wenyi/e3nk137y/33/embedded/html,result" allowfullscreen="allowfullscreen" frameborder="0"></iframe>
+
+## Custom Toolbar
+
+Use `toolbar` option to define the custom toolbars. _by [@wenzhixin](https://github.com/wenzhixin)_
+
+<iframe width="100%" height="300" src="http://jsfiddle.net/wenyi/e3nk137y/34/embedded/html,result" allowfullscreen="allowfullscreen" frameborder="0"></iframe>

+ 11 - 1
docs/examples.md

@@ -21,4 +21,14 @@ lead: "The examples of bootstrap table."
 
 {% markdown examples/columns.md %}
 
-{% markdown examples/card-view.md %}
+{% markdown examples/card-view.md %}
+
+{% markdown examples/select.md %}
+
+{% markdown examples/toolbar.md %}
+
+{% markdown examples/pagination.md %}
+
+{% markdown examples/events.md %}
+
+{% markdown examples/methods.md %}