浏览代码

Update docs

zhixin 10 年之前
父节点
当前提交
81cb961f2a

+ 3 - 3
docs/_i18n/en/extensions/reordercolumns.md

@@ -1,6 +1,6 @@
-# Table Reorder
+# Table Reorder Columns
 
-Use Plugin: [bootstrap-table-reorder](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/reorder) </br>
+Use Plugin: [bootstrap-table-reorder-columns](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/reordercolumns) </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
 
@@ -11,7 +11,7 @@ Dependence: [dragTable](https://github.com/akottr/dragtable/) v2.0.14 (must incl
 <link rel="stylesheet" href=".../dragtable.css">
 <script src=".../jquery-ui.js"></script>
 <script src=".../jquery.dragtable.js"></script>
-<script src="extensions/cookie/bootstrap-table-reorder-columns.js"></script>
+<script src="extensions/reordercolumns/bootstrap-table-reorder-columns.js"></script>
 ```
 
 ## Options

+ 74 - 0
docs/_i18n/en/extensions/reorderrows.md

@@ -0,0 +1,74 @@
+# Table Reorder Rows
+
+Use Plugin: [bootstrap-table-reorder-rows](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/reorderrows) </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
+
+
+## Usage
+
+```html
+<link rel="stylesheet" href=".../bootstrap-table-reorder-rows.css">
+<script src=".../jquery.tablednd.js"></script>
+<script src="extensions/reorderrows/bootstrap-table-reorder-rows.js"></script>
+```
+
+## Options
+
+### reorderableRows
+
+* type: Boolean
+* description: Set true to allow the reorder feature.
+* default: `false`
+
+### onDragStyle
+
+* type: String
+* description: This is the style that is assigned to the row during drag. There are limitations to the styles that can be associated with a row (such as you can't assign a border—well you can, but it won't be displayed).
+* default: `null`
+
+### onDropStyle
+
+* type: String
+* description: This is the style that is assigned to the row when it is dropped. As for onDragStyle, there are limitations to what you can do. Also this replaces the original style, so again consider using onDragClass which is simply added and then removed on drop.
+* default: `null`
+
+### onDragClass
+
+* type: String
+* description: This class is added for the duration of the drag and then removed when the row is dropped. It is more flexible than using onDragStyle since it can be inherited by the row cells and other content.
+* default: `reorder_rows_onDragClass`
+
+### dragHandle
+
+* type: String
+* description: This is the cursor to use
+* default: `null`
+
+### useRowAttrFunc
+
+* type: Boolean
+* description: This function must be use if your `tr` elements won't have the `id` attribute. If your `tr` elements don't have the `id` attribute this plugin don't fire the onDrop event.
+* default: `false`
+
+### onReorderRowsDrag
+
+* type: Function
+* description: Pass a function that will be called when the user starts dragging. The function takes 2 parameters: the table and the row which the user has started to drag.
+* default: `empty function`
+
+### onReorderRowsDrop
+
+* type: Function
+* description: Pass a function that will be called when the row is dropped. The function takes 2 parameters: the table and the row that was dropped.
+* default: `empty function`
+
+## Events
+
+### onReorderRow(reorder-row.bs.table)
+
+Fired when the row was dropped, receive as parameter the new data order
+
+## The existing problems
+
+* After search if the user reorder the rows the data is not shown properly after that.

+ 53 - 0
docs/_i18n/en/extensions/toolbar.md

@@ -0,0 +1,53 @@
+# Table Toolbar
+
+Use Plugin: [bootstrap-table-toolbar](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/toolbar)
+
+## Usage
+
+```html
+<script src="extensions/toolbar/bootstrap-table-toolbar.js"></script>
+```
+
+## Options
+
+### advancedSearch
+
+* type: Boolean
+* description: Set true to allow the advanced search.
+* default: `false`
+
+### idForm
+
+* type: String
+* description: Must be set to know the idform.
+* default: `advancedSearch`
+
+### actionForm
+
+* type: String
+* description: Set the action of the form (pop-up).
+* default: ``
+
+### idTable
+
+* type: String
+* description: Set the id of the table to create the pop-up form.
+* default: ``
+
+## Locales
+
+### formatAdvancedSearch
+
+* description: Title of the advanced search modal
+* default: `Advanced search`
+
+### formatAdvancedCloseButton
+
+* description: Text of the close button
+* default: `Close`
+
+## Events
+
+### onColumnAdvancedSearch(column-advanced-search.bs.table)
+
+* Fired when we are searching into the advanced search form

+ 3 - 3
docs/_i18n/es/extensions/reordercolumns.md

@@ -1,6 +1,6 @@
-# Table Reorder
+# Table Reorder Columns
 
-Use Plugin: [bootstrap-table-reorder](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/reorder) </br>
+Use Plugin: [bootstrap-table-reorder-columns](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/reordercolumns) </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
 
@@ -11,7 +11,7 @@ Dependence: [dragTable](https://github.com/akottr/dragtable/) v2.0.14 (must incl
 <link rel="stylesheet" href=".../dragtable.css">
 <script src=".../jquery-ui.js"></script>
 <script src=".../jquery.dragtable.js"></script>
-<script src="extensions/cookie/bootstrap-table-reorder-columns.js"></script>
+<script src="extensions/reordercolumns/bootstrap-table-reorder-columns.js"></script>
 ```
 
 ## Options

+ 74 - 0
docs/_i18n/es/extensions/reorderrows.md

@@ -0,0 +1,74 @@
+# Table Reorder Rows
+
+Use Plugin: [bootstrap-table-reorder-rows](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/reorderrows) </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
+
+
+## Usage
+
+```html
+<link rel="stylesheet" href=".../bootstrap-table-reorder-rows.css">
+<script src=".../jquery.tablednd.js"></script>
+<script src="extensions/reorderrows/bootstrap-table-reorder-rows.js"></script>
+```
+
+## Options
+
+### reorderableRows
+
+* type: Boolean
+* description: Set true to allow the reorder feature.
+* default: `false`
+
+### onDragStyle
+
+* type: String
+* description: This is the style that is assigned to the row during drag. There are limitations to the styles that can be associated with a row (such as you can't assign a border—well you can, but it won't be displayed).
+* default: `null`
+
+### onDropStyle
+
+* type: String
+* description: This is the style that is assigned to the row when it is dropped. As for onDragStyle, there are limitations to what you can do. Also this replaces the original style, so again consider using onDragClass which is simply added and then removed on drop.
+* default: `null`
+
+### onDragClass
+
+* type: String
+* description: This class is added for the duration of the drag and then removed when the row is dropped. It is more flexible than using onDragStyle since it can be inherited by the row cells and other content.
+* default: `reorder_rows_onDragClass`
+
+### dragHandle
+
+* type: String
+* description: This is the cursor to use
+* default: `null`
+
+### useRowAttrFunc
+
+* type: Boolean
+* description: This function must be use if your `tr` elements won't have the `id` attribute. If your `tr` elements don't have the `id` attribute this plugin don't fire the onDrop event.
+* default: `false`
+
+### onReorderRowsDrag
+
+* type: Function
+* description: Pass a function that will be called when the user starts dragging. The function takes 2 parameters: the table and the row which the user has started to drag.
+* default: `empty function`
+
+### onReorderRowsDrop
+
+* type: Function
+* description: Pass a function that will be called when the row is dropped. The function takes 2 parameters: the table and the row that was dropped.
+* default: `empty function`
+
+## Events
+
+### onReorderRow(reorder-row.bs.table)
+
+Fired when the row was dropped, receive as parameter the new data order
+
+## The existing problems
+
+* After search if the user reorder the rows the data is not shown properly after that.

+ 53 - 0
docs/_i18n/es/extensions/toolbar.md

@@ -0,0 +1,53 @@
+# Table Toolbar
+
+Use Plugin: [bootstrap-table-toolbar](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/toolbar)
+
+## Usage
+
+```html
+<script src="extensions/toolbar/bootstrap-table-toolbar.js"></script>
+```
+
+## Options
+
+### advancedSearch
+
+* type: Boolean
+* description: Set true to allow the advanced search.
+* default: `false`
+
+### idForm
+
+* type: String
+* description: Must be set to know the idform.
+* default: `advancedSearch`
+
+### actionForm
+
+* type: String
+* description: Set the action of the form (pop-up).
+* default: ``
+
+### idTable
+
+* type: String
+* description: Set the id of the table to create the pop-up form.
+* default: ``
+
+## Locales
+
+### formatAdvancedSearch
+
+* description: Title of the advanced search modal
+* default: `Advanced search`
+
+### formatAdvancedCloseButton
+
+* description: Text of the close button
+* default: `Close`
+
+## Events
+
+### onColumnAdvancedSearch(column-advanced-search.bs.table)
+
+* Fired when we are searching into the advanced search form

+ 3 - 3
docs/_i18n/zh-cn/extensions/reordercolumns.md

@@ -1,6 +1,6 @@
-# Table Reorder
+# Table Reorder Columns
 
-Use Plugin: [bootstrap-table-reorder](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/reorder) </br>
+Use Plugin: [bootstrap-table-reorder-columns](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/reordercolumns) </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
 
@@ -11,7 +11,7 @@ Dependence: [dragTable](https://github.com/akottr/dragtable/) v2.0.14 (must incl
 <link rel="stylesheet" href=".../dragtable.css">
 <script src=".../jquery-ui.js"></script>
 <script src=".../jquery.dragtable.js"></script>
-<script src="extensions/cookie/bootstrap-table-reorder-columns.js"></script>
+<script src="extensions/reordercolumns/bootstrap-table-reorder-columns.js"></script>
 ```
 
 ## Options

+ 74 - 0
docs/_i18n/zh-cn/extensions/reorderrows.md

@@ -0,0 +1,74 @@
+# Table Reorder Rows
+
+Use Plugin: [bootstrap-table-reorder-rows](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/reorderrows) </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
+
+
+## Usage
+
+```html
+<link rel="stylesheet" href=".../bootstrap-table-reorder-rows.css">
+<script src=".../jquery.tablednd.js"></script>
+<script src="extensions/reorderrows/bootstrap-table-reorder-rows.js"></script>
+```
+
+## Options
+
+### reorderableRows
+
+* type: Boolean
+* description: Set true to allow the reorder feature.
+* default: `false`
+
+### onDragStyle
+
+* type: String
+* description: This is the style that is assigned to the row during drag. There are limitations to the styles that can be associated with a row (such as you can't assign a border—well you can, but it won't be displayed).
+* default: `null`
+
+### onDropStyle
+
+* type: String
+* description: This is the style that is assigned to the row when it is dropped. As for onDragStyle, there are limitations to what you can do. Also this replaces the original style, so again consider using onDragClass which is simply added and then removed on drop.
+* default: `null`
+
+### onDragClass
+
+* type: String
+* description: This class is added for the duration of the drag and then removed when the row is dropped. It is more flexible than using onDragStyle since it can be inherited by the row cells and other content.
+* default: `reorder_rows_onDragClass`
+
+### dragHandle
+
+* type: String
+* description: This is the cursor to use
+* default: `null`
+
+### useRowAttrFunc
+
+* type: Boolean
+* description: This function must be use if your `tr` elements won't have the `id` attribute. If your `tr` elements don't have the `id` attribute this plugin don't fire the onDrop event.
+* default: `false`
+
+### onReorderRowsDrag
+
+* type: Function
+* description: Pass a function that will be called when the user starts dragging. The function takes 2 parameters: the table and the row which the user has started to drag.
+* default: `empty function`
+
+### onReorderRowsDrop
+
+* type: Function
+* description: Pass a function that will be called when the row is dropped. The function takes 2 parameters: the table and the row that was dropped.
+* default: `empty function`
+
+## Events
+
+### onReorderRow(reorder-row.bs.table)
+
+Fired when the row was dropped, receive as parameter the new data order
+
+## The existing problems
+
+* After search if the user reorder the rows the data is not shown properly after that.

+ 53 - 0
docs/_i18n/zh-cn/extensions/toolbar.md

@@ -0,0 +1,53 @@
+# Table Toolbar
+
+Use Plugin: [bootstrap-table-toolbar](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/toolbar)
+
+## Usage
+
+```html
+<script src="extensions/toolbar/bootstrap-table-toolbar.js"></script>
+```
+
+## Options
+
+### advancedSearch
+
+* type: Boolean
+* description: Set true to allow the advanced search.
+* default: `false`
+
+### idForm
+
+* type: String
+* description: Must be set to know the idform.
+* default: `advancedSearch`
+
+### actionForm
+
+* type: String
+* description: Set the action of the form (pop-up).
+* default: ``
+
+### idTable
+
+* type: String
+* description: Set the id of the table to create the pop-up form.
+* default: ``
+
+## Locales
+
+### formatAdvancedSearch
+
+* description: Title of the advanced search modal
+* default: `Advanced search`
+
+### formatAdvancedCloseButton
+
+* description: Text of the close button
+* default: `Close`
+
+## Events
+
+### onColumnAdvancedSearch(column-advanced-search.bs.table)
+
+* Fired when we are searching into the advanced search form