Skip to content

Commit

Permalink
#919: added multiple sort docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
wenzhixin committed May 25, 2015
1 parent ce1c076 commit f2974ea
Show file tree
Hide file tree
Showing 4 changed files with 276 additions and 1 deletion.
91 changes: 91 additions & 0 deletions docs/_i18n/en/extensions/multiple-sort.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# Table Multiple Sort

Use Plugin: [bootstrap-table-multiple-sort](https://github.com/dimbslmh/bootstrap-table/tree/master/src/extensions/multiple-sort)

## Usage

```html
<script src="extensions/multiple-sort/bootstrap-table-multiple-sort.js"></script>
```

## Options

### showMultiSort

* type: Boolean
* description: Set true to allow the multiple sort.
* default: `false`

### sortPriority

* type: Object
* description: Set one or multiple sort priority. Example: '[{"sortName": "forks_count","sortOrder":"desc"},{"sortName":"stargazers_count","sortOrder":"desc"}]'
* default: null

### Icons
* sort: `glyphicon-sort`
* plus: `glyphicon-plus`
* minus: `glyphicon-minus`

## Locales

### formatMultipleSort

* description: Title of the advanced search modal
* default: `Multiple Sort`

### formatAddLevel

* description: Text of the add level button
* default: `Add Level`

### formatDeleteLevel

* description: Text of the delete level button
* default: `Delete Level`

### formatColumn

* description: Text of Column header
* default: `Column`

### formatOrder

* description: Text of the delete level button
* default: `Order`

### formatSortBy

* description: Text of the delete level button
* default: `Sort by`

### formatThenBy

* description: Text of the delete level button
* default: `Then by`

### formatSort

* description: Text of the delete level button
* default: `Sort`

### formatCancel

* description: Text of the delete level button
* default: `Cancel`

### formatDuplicateAlertTitle

* description: Title of the duplicate alert
* default: `Duplicate(s) detected!`

### formatDuplicateAlertDescription

* description: Text of the duplicate alert
* default: `Please remove or change any duplicate column.`

## Events

### onMultipleSort(multiple-sort.bs.table)

* Fires when sorting with one or multiple Sort Priority.
91 changes: 91 additions & 0 deletions docs/_i18n/es/extensions/multiple-sort.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# Table Multiple Sort

Use Plugin: [bootstrap-table-multiple-sort](https://github.com/dimbslmh/bootstrap-table/tree/master/src/extensions/multiple-sort)

## Usage

```html
<script src="extensions/multiple-sort/bootstrap-table-multiple-sort.js"></script>
```

## Options

### showMultiSort

* type: Boolean
* description: Set true to allow the multiple sort.
* default: `false`

### sortPriority

* type: Object
* description: Set one or multiple sort priority. Example: '[{"sortName": "forks_count","sortOrder":"desc"},{"sortName":"stargazers_count","sortOrder":"desc"}]'
* default: null

### Icons
* sort: `glyphicon-sort`
* plus: `glyphicon-plus`
* minus: `glyphicon-minus`

## Locales

### formatMultipleSort

* description: Title of the advanced search modal
* default: `Multiple Sort`

### formatAddLevel

* description: Text of the add level button
* default: `Add Level`

### formatDeleteLevel

* description: Text of the delete level button
* default: `Delete Level`

### formatColumn

* description: Text of Column header
* default: `Column`

### formatOrder

* description: Text of the delete level button
* default: `Order`

### formatSortBy

* description: Text of the delete level button
* default: `Sort by`

### formatThenBy

* description: Text of the delete level button
* default: `Then by`

### formatSort

* description: Text of the delete level button
* default: `Sort`

### formatCancel

* description: Text of the delete level button
* default: `Cancel`

### formatDuplicateAlertTitle

* description: Title of the duplicate alert
* default: `Duplicate(s) detected!`

### formatDuplicateAlertDescription

* description: Text of the duplicate alert
* default: `Please remove or change any duplicate column.`

## Events

### onMultipleSort(multiple-sort.bs.table)

* Fires when sorting with one or multiple Sort Priority.
91 changes: 91 additions & 0 deletions docs/_i18n/zh-cn/extensions/multiple-sort.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
# Table Multiple Sort

Use Plugin: [bootstrap-table-multiple-sort](https://github.com/dimbslmh/bootstrap-table/tree/master/src/extensions/multiple-sort)

## Usage

```html
<script src="extensions/multiple-sort/bootstrap-table-multiple-sort.js"></script>
```

## Options

### showMultiSort

* type: Boolean
* description: Set true to allow the multiple sort.
* default: `false`

### sortPriority

* type: Object
* description: Set one or multiple sort priority. Example: '[{"sortName": "forks_count","sortOrder":"desc"},{"sortName":"stargazers_count","sortOrder":"desc"}]'
* default: null

### Icons
* sort: `glyphicon-sort`
* plus: `glyphicon-plus`
* minus: `glyphicon-minus`

## Locales

### formatMultipleSort

* description: Title of the advanced search modal
* default: `Multiple Sort`

### formatAddLevel

* description: Text of the add level button
* default: `Add Level`

### formatDeleteLevel

* description: Text of the delete level button
* default: `Delete Level`

### formatColumn

* description: Text of Column header
* default: `Column`

### formatOrder

* description: Text of the delete level button
* default: `Order`

### formatSortBy

* description: Text of the delete level button
* default: `Sort by`

### formatThenBy

* description: Text of the delete level button
* default: `Then by`

### formatSort

* description: Text of the delete level button
* default: `Sort`

### formatCancel

* description: Text of the delete level button
* default: `Cancel`

### formatDuplicateAlertTitle

* description: Title of the duplicate alert
* default: `Duplicate(s) detected!`

### formatDuplicateAlertDescription

* description: Text of the duplicate alert
* default: `Please remove or change any duplicate column.`

## Events

### onMultipleSort(multiple-sort.bs.table)

* Fires when sorting with one or multiple Sort Priority.
4 changes: 3 additions & 1 deletion docs/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ lead: pages.extensions.lead

{% tf extensions/mobile.md %}

{% tf extensions/multiple-sort.md %}

{% tf extensions/natural-sorting.md %}

{% tf extensions/reorder-columns.md %}
Expand All @@ -29,4 +31,4 @@ lead: pages.extensions.lead

{% tf extensions/resizable.md %}

{% tf extensions/toolbar.md %}
{% tf extensions/toolbar.md %}

0 comments on commit f2974ea

Please sign in to comment.