浏览代码

Add extensions docs from README.

zhixin 11 年之前
父节点
当前提交
728049b312

+ 17 - 0
docs/_i18n/en/extensions/README.md

@@ -0,0 +1,17 @@
+# Table Filter
+
+Use Plugin: [bootstrap table filters](https://github.com/lukaskral/bootstrap-table-filter)
+
+## Usage
+
+```html
+<script src="extensions/filter/bootstrap-table-filter.js"></script>
+```
+
+## Options
+
+### showFilter
+
+* type: Boolean
+* description: set true to show filter menu.
+* default: `false`

+ 30 - 0
docs/_i18n/en/extensions/cookie.md

@@ -0,0 +1,30 @@
+# Table Cookie
+
+Use Plugin: [bootstrap-table-cookie](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/cookie)
+
+## Usage
+
+```html
+<script src="extensions/cookie/bootstrap-table-cookie.js"></script>
+```
+
+## Options
+
+### stateSave
+
+* type: Boolean
+* description: Set true to save the state of a table (its paging position, ordering state, records per page).
+* default: `false`
+
+### stateSaveExpire
+
+* type: String
+* description: You must set this property if stateSave is enable to know when will expire the cookie created. Must use this format: 'number{letter}' like '2h', in the letter position
+               		you can use: 's','mi','h','d','m','y', these means: 'seconds', 'minutes', 'hours', 'days', 'months', 'years'.
+* default: `2h`
+
+### stateSaveIdTable
+
+* type: String
+* description: You must set this property if stateSave is enable to sets an unique cookie with an identifier for each table in your page or project. You must set this property because we need create cookies with an identifier.
+* default: ``

+ 29 - 0
docs/_i18n/en/extensions/export.md

@@ -0,0 +1,29 @@
+# Table Export
+
+Use Plugin: [tableExport.jquery.plugin](https://github.com/kayalshri/tableExport.jquery.plugin)
+
+## Usage
+
+```html
+<script src="extensions/export/bootstrap-table-export.js"></script>
+```
+
+## Options
+
+### showExport
+
+* type: Boolean
+* description: set `true` to show export button.
+* default: `false`
+
+### exportTypes
+
+* type: Array
+* description: export types, support types: 'json', 'xml', 'png', 'csv', 'txt', 'sql', 'doc', 'excel', 'powerpoint', 'pdf'.
+* default: `['json', 'xml', 'csv', 'txt', 'sql', 'excel']`
+
+### exportOptions
+
+* type: Object
+* description: export [options](https://github.com/kayalshri/tableExport.jquery.plugin#options) of `tableExport.jquery.plugin`
+* default: `{}`

+ 17 - 0
docs/_i18n/en/extensions/filter.md

@@ -0,0 +1,17 @@
+# Table Filter
+
+Use Plugin: [bootstrap table filters](https://github.com/lukaskral/bootstrap-table-filter)
+
+## Usage
+
+```html
+<script src="extensions/filter/bootstrap-table-filter.js"></script>
+```
+
+## Options
+
+### showFilter
+
+* type: Boolean
+* description: set true to show filter menu.
+* default: `false`

+ 17 - 0
docs/_i18n/en/extensions/flatJSON.md

@@ -0,0 +1,17 @@
+# Table flatJSON
+
+Use Plugin: [bootstrap-table-flatJSON](https://github.com/djhvscf/bootstrap-table-flatJSON)
+
+## Usage
+
+```html
+<script src="extensions/flatJSON/bootstrap-table-flatJSON.js"></script>
+```
+
+## Options
+
+### flat
+
+* type: Boolean
+* description: Set true to flat the JSON object.
+* default: `false`

+ 66 - 0
docs/_i18n/en/extensions/resizable.md

@@ -0,0 +1,66 @@
+# Table Resizable
+
+Use Plugin: [bootstrap-table-resizable](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/resizable) </br>
+Dependence: [colResizable](https://github.com/alvaro-prieto/colResizable) v1.5
+
+## Usage
+
+```html
+<script src="extensions/cookie/bootstrap-table-resizable.js"></script>
+```
+
+## Options
+
+### resizable
+
+* type: Boolean
+* description: Set true to allow the resize in each column.
+* default: `false`
+
+### liveDrag
+
+* type: Boolean
+* description: When set to true the table layout is updated while dragging column anchors. liveDrag enabled is more CPU consuming so it is not recommended for slow computers, specially when dealing with huge or extremely complicated tables.
+* default: `false`
+
+### fixed
+
+* type: Boolean
+* description: It is used to set how the resize method works. In fixed mode resizing a column does not alter total table width, which means that when a column is expanded the next one shrinks. If fixed is set to false then table can change its width and each column can shrink or expand independently.
+* default: `true`
+
+### headerOnly
+
+* type: Boolean
+* description: This attribute can be used to prevent vertical expansion of the column anchors to fit the table height. If it is set to true, column handler's size will be bounded to the first row's vertical size.
+* default: `false`
+
+### minWidth
+
+* type: Integer
+* description: This value specifies the minimum width (measured in pixels) that is allowed for the columns.
+* default: `15`
+
+### hoverCursor
+
+* type: String
+* description: This attribute can be used to customize the cursor that will be displayed when the user is positioned on the column anchors.
+* default: `e-resize`
+
+### dragCursor
+
+* type: String
+* description: Defines the cursor that will be used while the user is resizing a column.
+* default: `e-resize`
+
+### onResizableResize
+
+* type: Function
+* description: If a callback function is supplied it will be fired when the user has ended dragging a column anchor altering the previous table layout. The callback function can obtain a reference to the updated table through the currentTarget attribute of the event retrieved by parameters.
+* default: `empty function`
+
+### onResizableDrag
+
+* type: Function
+* description: This event is fired while dragging a column anchor if liveDrag is enabled. It can be useful if the table is being used as a multiple range slider. The callback function can obtain a reference to the updated table through the currentTarget attribute of the event retrieved by parameters
+* default: `empty function`

+ 17 - 0
docs/_i18n/es/extensions/README.md

@@ -0,0 +1,17 @@
+# Table Filter
+
+Use Plugin: [bootstrap table filters](https://github.com/lukaskral/bootstrap-table-filter)
+
+## Usage
+
+```html
+<script src="extensions/filter/bootstrap-table-filter.js"></script>
+```
+
+## Options
+
+### showFilter
+
+* type: Boolean
+* description: set true to show filter menu.
+* default: `false`

+ 30 - 0
docs/_i18n/es/extensions/cookie.md

@@ -0,0 +1,30 @@
+# Table Cookie
+
+Use Plugin: [bootstrap-table-cookie](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/cookie)
+
+## Usage
+
+```html
+<script src="extensions/cookie/bootstrap-table-cookie.js"></script>
+```
+
+## Options
+
+### stateSave
+
+* type: Boolean
+* description: Set true to save the state of a table (its paging position, ordering state, records per page).
+* default: `false`
+
+### stateSaveExpire
+
+* type: String
+* description: You must set this property if stateSave is enable to know when will expire the cookie created. Must use this format: 'number{letter}' like '2h', in the letter position
+               		you can use: 's','mi','h','d','m','y', these means: 'seconds', 'minutes', 'hours', 'days', 'months', 'years'.
+* default: `2h`
+
+### stateSaveIdTable
+
+* type: String
+* description: You must set this property if stateSave is enable to sets an unique cookie with an identifier for each table in your page or project. You must set this property because we need create cookies with an identifier.
+* default: ``

+ 29 - 0
docs/_i18n/es/extensions/export.md

@@ -0,0 +1,29 @@
+# Table Export
+
+Use Plugin: [tableExport.jquery.plugin](https://github.com/kayalshri/tableExport.jquery.plugin)
+
+## Usage
+
+```html
+<script src="extensions/export/bootstrap-table-export.js"></script>
+```
+
+## Options
+
+### showExport
+
+* type: Boolean
+* description: set `true` to show export button.
+* default: `false`
+
+### exportTypes
+
+* type: Array
+* description: export types, support types: 'json', 'xml', 'png', 'csv', 'txt', 'sql', 'doc', 'excel', 'powerpoint', 'pdf'.
+* default: `['json', 'xml', 'csv', 'txt', 'sql', 'excel']`
+
+### exportOptions
+
+* type: Object
+* description: export [options](https://github.com/kayalshri/tableExport.jquery.plugin#options) of `tableExport.jquery.plugin`
+* default: `{}`

+ 17 - 0
docs/_i18n/es/extensions/filter.md

@@ -0,0 +1,17 @@
+# Table Filter
+
+Use Plugin: [bootstrap table filters](https://github.com/lukaskral/bootstrap-table-filter)
+
+## Usage
+
+```html
+<script src="extensions/filter/bootstrap-table-filter.js"></script>
+```
+
+## Options
+
+### showFilter
+
+* type: Boolean
+* description: set true to show filter menu.
+* default: `false`

+ 17 - 0
docs/_i18n/es/extensions/flatJSON.md

@@ -0,0 +1,17 @@
+# Table flatJSON
+
+Use Plugin: [bootstrap-table-flatJSON](https://github.com/djhvscf/bootstrap-table-flatJSON)
+
+## Usage
+
+```html
+<script src="extensions/flatJSON/bootstrap-table-flatJSON.js"></script>
+```
+
+## Options
+
+### flat
+
+* type: Boolean
+* description: Set true to flat the JSON object.
+* default: `false`

+ 66 - 0
docs/_i18n/es/extensions/resizable.md

@@ -0,0 +1,66 @@
+# Table Resizable
+
+Use Plugin: [bootstrap-table-resizable](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/resizable) </br>
+Dependence: [colResizable](https://github.com/alvaro-prieto/colResizable) v1.5
+
+## Usage
+
+```html
+<script src="extensions/cookie/bootstrap-table-resizable.js"></script>
+```
+
+## Options
+
+### resizable
+
+* type: Boolean
+* description: Set true to allow the resize in each column.
+* default: `false`
+
+### liveDrag
+
+* type: Boolean
+* description: When set to true the table layout is updated while dragging column anchors. liveDrag enabled is more CPU consuming so it is not recommended for slow computers, specially when dealing with huge or extremely complicated tables.
+* default: `false`
+
+### fixed
+
+* type: Boolean
+* description: It is used to set how the resize method works. In fixed mode resizing a column does not alter total table width, which means that when a column is expanded the next one shrinks. If fixed is set to false then table can change its width and each column can shrink or expand independently.
+* default: `true`
+
+### headerOnly
+
+* type: Boolean
+* description: This attribute can be used to prevent vertical expansion of the column anchors to fit the table height. If it is set to true, column handler's size will be bounded to the first row's vertical size.
+* default: `false`
+
+### minWidth
+
+* type: Integer
+* description: This value specifies the minimum width (measured in pixels) that is allowed for the columns.
+* default: `15`
+
+### hoverCursor
+
+* type: String
+* description: This attribute can be used to customize the cursor that will be displayed when the user is positioned on the column anchors.
+* default: `e-resize`
+
+### dragCursor
+
+* type: String
+* description: Defines the cursor that will be used while the user is resizing a column.
+* default: `e-resize`
+
+### onResizableResize
+
+* type: Function
+* description: If a callback function is supplied it will be fired when the user has ended dragging a column anchor altering the previous table layout. The callback function can obtain a reference to the updated table through the currentTarget attribute of the event retrieved by parameters.
+* default: `empty function`
+
+### onResizableDrag
+
+* type: Function
+* description: This event is fired while dragging a column anchor if liveDrag is enabled. It can be useful if the table is being used as a multiple range slider. The callback function can obtain a reference to the updated table through the currentTarget attribute of the event retrieved by parameters
+* default: `empty function`

+ 17 - 0
docs/_i18n/zh-cn/extensions/README.md

@@ -0,0 +1,17 @@
+# Table Filter
+
+Use Plugin: [bootstrap table filters](https://github.com/lukaskral/bootstrap-table-filter)
+
+## Usage
+
+```html
+<script src="extensions/filter/bootstrap-table-filter.js"></script>
+```
+
+## Options
+
+### showFilter
+
+* type: Boolean
+* description: set true to show filter menu.
+* default: `false`

+ 30 - 0
docs/_i18n/zh-cn/extensions/cookie.md

@@ -0,0 +1,30 @@
+# Table Cookie
+
+Use Plugin: [bootstrap-table-cookie](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/cookie)
+
+## Usage
+
+```html
+<script src="extensions/cookie/bootstrap-table-cookie.js"></script>
+```
+
+## Options
+
+### stateSave
+
+* type: Boolean
+* description: Set true to save the state of a table (its paging position, ordering state, records per page).
+* default: `false`
+
+### stateSaveExpire
+
+* type: String
+* description: You must set this property if stateSave is enable to know when will expire the cookie created. Must use this format: 'number{letter}' like '2h', in the letter position
+               		you can use: 's','mi','h','d','m','y', these means: 'seconds', 'minutes', 'hours', 'days', 'months', 'years'.
+* default: `2h`
+
+### stateSaveIdTable
+
+* type: String
+* description: You must set this property if stateSave is enable to sets an unique cookie with an identifier for each table in your page or project. You must set this property because we need create cookies with an identifier.
+* default: ``

+ 29 - 0
docs/_i18n/zh-cn/extensions/export.md

@@ -0,0 +1,29 @@
+# Table Export
+
+Use Plugin: [tableExport.jquery.plugin](https://github.com/kayalshri/tableExport.jquery.plugin)
+
+## Usage
+
+```html
+<script src="extensions/export/bootstrap-table-export.js"></script>
+```
+
+## Options
+
+### showExport
+
+* type: Boolean
+* description: set `true` to show export button.
+* default: `false`
+
+### exportTypes
+
+* type: Array
+* description: export types, support types: 'json', 'xml', 'png', 'csv', 'txt', 'sql', 'doc', 'excel', 'powerpoint', 'pdf'.
+* default: `['json', 'xml', 'csv', 'txt', 'sql', 'excel']`
+
+### exportOptions
+
+* type: Object
+* description: export [options](https://github.com/kayalshri/tableExport.jquery.plugin#options) of `tableExport.jquery.plugin`
+* default: `{}`

+ 17 - 0
docs/_i18n/zh-cn/extensions/filter.md

@@ -0,0 +1,17 @@
+# Table Filter
+
+Use Plugin: [bootstrap table filters](https://github.com/lukaskral/bootstrap-table-filter)
+
+## Usage
+
+```html
+<script src="extensions/filter/bootstrap-table-filter.js"></script>
+```
+
+## Options
+
+### showFilter
+
+* type: Boolean
+* description: set true to show filter menu.
+* default: `false`

+ 17 - 0
docs/_i18n/zh-cn/extensions/flatJSON.md

@@ -0,0 +1,17 @@
+# Table flatJSON
+
+Use Plugin: [bootstrap-table-flatJSON](https://github.com/djhvscf/bootstrap-table-flatJSON)
+
+## Usage
+
+```html
+<script src="extensions/flatJSON/bootstrap-table-flatJSON.js"></script>
+```
+
+## Options
+
+### flat
+
+* type: Boolean
+* description: Set true to flat the JSON object.
+* default: `false`

+ 66 - 0
docs/_i18n/zh-cn/extensions/resizable.md

@@ -0,0 +1,66 @@
+# Table Resizable
+
+Use Plugin: [bootstrap-table-resizable](https://github.com/wenzhixin/bootstrap-table/tree/master/src/extensions/resizable) </br>
+Dependence: [colResizable](https://github.com/alvaro-prieto/colResizable) v1.5
+
+## Usage
+
+```html
+<script src="extensions/cookie/bootstrap-table-resizable.js"></script>
+```
+
+## Options
+
+### resizable
+
+* type: Boolean
+* description: Set true to allow the resize in each column.
+* default: `false`
+
+### liveDrag
+
+* type: Boolean
+* description: When set to true the table layout is updated while dragging column anchors. liveDrag enabled is more CPU consuming so it is not recommended for slow computers, specially when dealing with huge or extremely complicated tables.
+* default: `false`
+
+### fixed
+
+* type: Boolean
+* description: It is used to set how the resize method works. In fixed mode resizing a column does not alter total table width, which means that when a column is expanded the next one shrinks. If fixed is set to false then table can change its width and each column can shrink or expand independently.
+* default: `true`
+
+### headerOnly
+
+* type: Boolean
+* description: This attribute can be used to prevent vertical expansion of the column anchors to fit the table height. If it is set to true, column handler's size will be bounded to the first row's vertical size.
+* default: `false`
+
+### minWidth
+
+* type: Integer
+* description: This value specifies the minimum width (measured in pixels) that is allowed for the columns.
+* default: `15`
+
+### hoverCursor
+
+* type: String
+* description: This attribute can be used to customize the cursor that will be displayed when the user is positioned on the column anchors.
+* default: `e-resize`
+
+### dragCursor
+
+* type: String
+* description: Defines the cursor that will be used while the user is resizing a column.
+* default: `e-resize`
+
+### onResizableResize
+
+* type: Function
+* description: If a callback function is supplied it will be fired when the user has ended dragging a column anchor altering the previous table layout. The callback function can obtain a reference to the updated table through the currentTarget attribute of the event retrieved by parameters.
+* default: `empty function`
+
+### onResizableDrag
+
+* type: Function
+* description: This event is fired while dragging a column anchor if liveDrag is enabled. It can be useful if the table is being used as a multiple range slider. The callback function can obtain a reference to the updated table through the currentTarget attribute of the event retrieved by parameters
+* default: `empty function`