Skip to content

Commit ffd3cc1

Browse files
wenzhixinwenzhixin
committed
Update docs.
1 parent ffb5dd4 commit ffd3cc1

36 files changed

+390
-205
lines changed

‎CHANGELOG.md‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@
66
- [enh] Use options for detailView's open/close icons.
77
- [enh] Added `refreshOptions` and `gtHiddenColumns` method.
88
- [enh] Added `datepicker` option to Filter Control.
9-
- [bug] Fix #936 Sort carets shouldn't be inline-styled by JS.
9+
- [bug] Fix #936 Sort carets should not be inline-styled by JS.
1010
- [bug] Fix table header width bug when setting table to no bordered.
1111
- [bug] Fix #938, fix #940: Multiple Sort and Hide/Show column.
12-
- [bug] Fix #970: click and dblclick bug on no-rows table.
12+
- [bug] Fix #970: `click`and `dblclick` bug on no-rows table.
1313
- [bug] Fix #967: unselected column while column sorted display error.
1414
- [enh] Support title feature in cells.
1515
- [enh] Improved cookie, mobile extension.
16-
- [enh] Added groupby, angular extension.
16+
- [enh] Added group-by, angular extension.
1717
- [enh] Added option for setting locale.
1818
- [enh] Added `exportDataType` option for export extension.
1919
- [enh] Add fa-IR, ca-ES, es-ES, et-EE and af-ZA locales.
20-
- [enh] Supported complex header with rowspans and colspans.
20+
- [enh] Supported complex header with `rowspans` and `colspans`.
2121
- [enh] Added `searchFomatter` column option.
2222
- [bug] Fixed ResetRow function and undefined column search bug.
2323
- [bug] Fixed #639: footer resizing problem.
@@ -28,6 +28,9 @@
2828
- [enh] Added fixed-columns extension.
2929
- [enh] Added `$.fn.bootstrapTable.utils` tools.
3030
- [enh] Added `expandRow` and `collapseRow` methods.
31+
- [enh] Updated `showRow`, `hideRow` and `updateCell` methods.
32+
- [bug] Fix #1390: radio maintainSelected bug.
33+
- [bug] Fix #1421: checkBy filter enabled.
3134

3235
### 1.8.1
3336

‎docs/_i18n/en.yml‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
pages:
2+
home:
3+
title: "Bootstrap Table"
4+
lead: "An extended Bootstrap table with radio, checkbox, sort, pagination, and other added features."
5+
sub_title: "Designed for Twitter Bootstrap"
6+
sub_lead: "Bootstrap table has been designed to reduce development time and to require no specific knowledge from developers. It is both featherweight and feature-rich."
7+
download: "Download"
8+
current_version: "Current version:"
29
getting_started:
310
title: "Getting started"
411
lead: "An overview of Bootstrap Table, how to download and use, basic templates, and more."
@@ -13,4 +20,10 @@ pages:
1320
lead: "The extensions of bootstrap table."
1421
faq:
1522
title: "FAQ"
16-
lead: "Frequently Asked Questions."
23+
lead: "Frequently Asked Questions."
24+
donate:
25+
title: "Donate"
26+
lead: "If you like Bootstrap Table, if your project uses Bootstrap Table, if you want Bootstrap Table do better..."
27+
common:
28+
social_tip: "If you like bootstrap table: "
29+
qq_group: "QQ group: "

‎docs/_i18n/en/documentation/methods.md‎

Lines changed: 28 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -22,70 +22,77 @@ The calling method syntax: `$('#table').bootstrapTable('method', parameter);`.
2222
<td>getOptions</td>
2323
<td>none</td>
2424
<td>Return the options object.</td>
25+
<td>getOptions</td>
2526
</tr>
2627
<tr>
2728
<td>getSelections</td>
2829
<td>none</td>
2930
<td>Return selected rows, when no record selected, am empty array will return.</td>
31+
<td>getSelections</td>
3032
</tr>
3133
<tr>
3234
<td>getAllSelections</td>
3335
<td>none</td>
34-
<td>Return selected rows in all pages, when no record selected, am empty array will return.</td>
36+
<td>Return all selected rows contain search or filter, when no record selected, am empty array will return.</td>
37+
<td>getAllSelections</td>
3538
</tr>
3639
<tr>
3740
<td>getData</td>
3841
<td>useCurrentPage</td>
39-
<td>Get the loaded data of table at the moment that this method is called. If you set the useCurrentPage to true the method will return the data in the current page</td>
42+
<td>Get the loaded data of table at the moment that this method is called. If you set the useCurrentPage to true the method will return the data in the current page.</td>
43+
<td>getData</td>
44+
</tr>
45+
<tr>
46+
<td>getRowByUniqueId</td>
47+
<td>id</td>
48+
<td>
49+
Get data from table, the row that contains the id passed by parameter.
50+
</td>
51+
<td>getRowByUniqueId</td>
4052
</tr>
4153
<tr>
4254
<td>load</td>
4355
<td>data</td>
4456
<td>Load the data to table, the old rows will be removed.</td>
57+
<td>load</td>
4558
</tr>
4659
<tr>
4760
<td>append</td>
4861
<td>data</td>
4962
<td>Append the data to table.</td>
63+
<td>append</td>
5064
</tr>
5165
<tr>
5266
<td>prepend</td>
5367
<td>data</td>
5468
<td>Prepend the data to table.</td>
69+
<td>prepend</td>
5570
</tr>
5671
<tr>
5772
<td>remove</td>
5873
<td>params</td>
5974
<td>
6075
Remove data from table, the params contains two properties: <br>
6176
field: the field name of remove rows. <br>
62-
values: the array of values for rows which should be removed. <br>
63-
Example: $('#myTable').bootstrapTable('remove', {field: 'id', values: ["73", "74"]})
77+
values: the array of values for rows which should be removed.
78+
<td>remove</td>
6479
</td>
6580
</tr>
6681
<tr>
6782
<td>removeAll</td>
6883
<td>-</td>
6984
<td>
70-
Remove all data from table<br>
71-
Example: $('#myTable').bootstrapTable('removeAll')
85+
Remove all data from table.
7286
</td>
87+
<td>removeAll</td>
7388
</tr>
7489
<tr>
7590
<td>removeByUniqueId</td>
7691
<td>id</td>
7792
<td>
78-
Remove data from table, the row that contains the id passed by parameter<br>
79-
Example: $('#myTable').bootstrapTable('removeByUniqueId', "122")
80-
</td>
81-
</tr>
82-
<tr>
83-
<td>getRowByUniqueId</td>
84-
<td>id</td>
85-
<td>
86-
Get data from table, the row that contains the id passed by parameter<br>
87-
Example: $('#myTable').bootstrapTable('getRowByUniqueId', "122")
93+
Remove data from table, the row that contains the id passed by parameter.
8894
</td>
95+
<td>removeByUniqueId</td>
8996
</tr>
9097
<tr>
9198
<td>insertRow</td>
@@ -141,9 +148,9 @@ The calling method syntax: `$('#table').bootstrapTable('method', parameter);`.
141148
<td>params</td>
142149
<td>
143150
Update one cell, the params contains following properties: <br>
144-
rowIndex: the row index. <br>
145-
fieldName: the field name.<br>
146-
fieldValue: the new field value. <br>
151+
index: the row index. <br>
152+
field: the field name.<br>
153+
value: the new field value.
147154
</td>
148155
</tr>
149156
<tr>
@@ -241,12 +248,12 @@ The calling method syntax: `$('#table').bootstrapTable('method', parameter);`.
241248
<tr>
242249
<td>scrollTo</td>
243250
<td>value</td>
244-
<td>Scroll to the number value position, set 'bottom' means scroll to the bottom.</td>
251+
<td>Scroll to the number value position, the unit is 'px', set 'bottom' means scroll to the bottom.</td>
245252
</tr>
246253
<tr>
247254
<td>getScrollPosition</td>
248255
<td>none</td>
249-
<td>Get the current scroll position.</td>
256+
<td>Get the current scroll position, the unit is 'px'.</td>
250257
</tr>
251258
<tr>
252259
<td>filterBy</td>
@@ -277,16 +284,6 @@ The calling method syntax: `$('#table').bootstrapTable('method', parameter);`.
277284
<td>toggleView</td>
278285
<td>none</td>
279286
<td>Toggle the card/table view.</td>
280-
</tr>
281-
<tr>
282-
<td>expandRow</td>
283-
<td>index</td>
284-
<td>Expand a row, the row index start with 0.</td>
285-
</tr>
286-
<tr>
287-
<td>collapseRow</td>
288-
<td>index</td>
289-
<td>Collapse a row, the row index start with 0.</td>
290287
</tr>
291288
<tr>
292289
<td>expandRow</td>

‎docs/_i18n/en/donate.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Bootstrap Table is a free plug-in which be made in my spare time.
2+
3+
If your project get the help from Bootstrap Table, you can donate to Bootstrap Table.
4+
5+
With your help, I believe that I will continue to strive to let Bootstrap Table be better.

‎docs/_i18n/en/faq/faq.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,10 @@ $table.on('load-success.bs.table column-switch.bs.table page-change.bs.table sea
2828
});
2929
```
3030

31-
### Export extension does not support unicode characters?
31+
---
32+
33+
### How can I support development of bootstrap-table?
34+
35+
All your ideas and feedback are very appreciated! Please feel free to open issues on GitHub or send me email.
3236

33-
The extension is using the Plugin: [tableExport.jquery.plugin](https://github.com/kayalshri/tableExport.jquery.plugin), because this plugin has [this same problem](https://github.com/carlo/jquery-base64/issues/1), so it doesn't belong to the category of the bootstrap-table, but I think we can try to use this: [jquery.base64.js](https://gist.github.com/wenzhixin/09e218c884f4f380b68a) to replace the base64 plugin.
37+
I'm also grateful for your donations: <a href="donate">{% t pages.donate.title %}</a>

‎docs/_i18n/en/footer.html‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<footer class="bs-docs-footer" role="contentinfo">
2+
<div class="container">
3+
{% include social-buttons.html %}
4+
5+
<p>Designed and built with all the love in the world by <a href="https://github.com/wenzhixin" target="_blank">@wenzhixin</a>.</p>
6+
<p>Maintained by <a href="https://github.com/wenzhixin" target="_blank">@wenzhixin</a> with the help of <a href="https://github.com/wenzhixin/bootstrap-table/graphs/contributors" target="_blank">our contributors</a>.</p>
7+
<p>Code licensed under <a href="https://github.com/wenzhixin/bootstrap-table/blob/master/LICENSE" target="_blank">MIT</a>, documentation under <a href="http://creativecommons.org/licenses/by/3.0/">CC BY 3.0</a>.</p>
8+
<ul class="bs-docs-footer-links muted">
9+
<li>Currently v{{ site.current_version }}</li>
10+
<li>&middot;</li>
11+
<li><a href="{{ site.repo }}">GitHub</a></li>
12+
<li>&middot;</li>
13+
<li><a href="{{ site.website }}">My website</a></li>
14+
<li>&middot;</li>
15+
<li><a href="{{ site.repos }}">My repos</a></li>
16+
<li>&middot;</li>
17+
<li><a href="http://stackoverflow.com/questions/tagged/bootstrap-table">Questions / Helps</a></li>
18+
<li>&middot;</li>
19+
<li><a href="{{ site.repo }}/issues">Issues</a></li>
20+
<li>&middot;</li>
21+
<li><a href="{{ site.repo }}/releases">Releases</a></li>
22+
<li>&middot;</li>
23+
<li><a href="mailto:{{ site.email }}">Email</a></li>
24+
</ul>
25+
</div>
26+
</footer>

docs/_includes/feature.md renamed to docs/_i18n/en/home/feature.md

File renamed without changes.

‎docs/_i18n/es.yml‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
11
pages:
2+
home:
3+
title: "Bootstrap Table"
4+
lead: "An extended Bootstrap table with radio, checkbox, sort, pagination, and other added features."
5+
sub_title: "Designed for Twitter Bootstrap"
6+
sub_lead: "Bootstrap table has been designed to reduce development time and to require no specific knowledge from developers. It is both featherweight and feature-rich."
7+
download: "Download"
8+
current_version: "Current version:"
29
getting_started:
310
title: "Iniciar con Bootstrap-table"
411
lead: "Una visión de Bootstrap Table, cómo descargarlo, usarlo, templates básicos, y más."
@@ -13,4 +20,10 @@ pages:
1320
lead: "Extensiones de bootstrap table."
1421
faq:
1522
title: "FAQ"
16-
lead: "Preguntas frecuentes."
23+
lead: "Preguntas frecuentes."
24+
donate:
25+
title: "Donate"
26+
lead: "If you like Bootstrap Table, if your project uses Bootstrap Table, if you want Bootstrap Table do better..."
27+
common:
28+
social_tip: "If you like bootstrap table: "
29+
qq_group: "QQ group: "

‎docs/_i18n/es/documentation/methods.md‎

Lines changed: 9 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,15 @@ Sintaxis para llamar a un método: `$('#table').bootstrapTable('method', paramet
3131
<tr>
3232
<td>getData</td>
3333
<td>useCurrentPage</td>
34-
<td>Retorna los datos cargados en la tabla en el momento que se llama este método. Si se setea useCurrentPage a true se devolverá los datos mostrados en la página
35-
actual</td>
34+
<td>Retorna los datos cargados en la tabla en el momento que se llama este método. Si se setea useCurrentPage a true se devolverá los datos mostrados en la página actual.</td>
35+
</tr>
36+
<tr>
37+
<td>getRowByUniqueId</td>
38+
<td>id</td>
39+
<td>
40+
Se obtiene el dato de la tabla que contiene el id pasado por parámetro<br>
41+
Ejemplo: $('#myTable').bootstrapTable('getRowByUniqueId', "122")
42+
</td>
3643
</tr>
3744
<tr>
3845
<td>load</td>
@@ -75,14 +82,6 @@ Sintaxis para llamar a un método: `$('#table').bootstrapTable('method', paramet
7582
Ejemplo: $('#myTable').bootstrapTable('removeByUniqueId', "122")
7683
</td>
7784
</tr>
78-
<tr>
79-
<td>getRowByUniqueId</td>
80-
<td>id</td>
81-
<td>
82-
Se obtiene el dato de la tabla que contiene el id pasado por parámetro<br>
83-
Ejemplo: $('#myTable').bootstrapTable('getRowByUniqueId', "122")
84-
</td>
85-
</tr>
8685
<tr>
8786
<td>insertRow</td>
8887
<td>params</td>
@@ -268,16 +267,6 @@ Sintaxis para llamar a un método: `$('#table').bootstrapTable('method', paramet
268267
<td>toggleView</td>
269268
<td>none</td>
270269
<td>Alterna la vista entre tabla y tarjeta.</td>
271-
</tr>
272-
<tr>
273-
<td>expandRow</td>
274-
<td>index</td>
275-
<td>Expand a row, the row index start with 0.</td>
276-
</tr>
277-
<tr>
278-
<td>collapseRow</td>
279-
<td>index</td>
280-
<td>Collapse a row, the row index start with 0.</td>
281270
</tr>
282271
<tr>
283272
<td>expandRow</td>

‎docs/_i18n/es/donate.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Bootstrap Table is a free plug-in which be made in my spare time.
2+
3+
If your project get the help from Bootstrap Table, you can donate to Bootstrap Table.
4+
5+
With your help, I believe that I will continue to strive to let Bootstrap Table be better.

0 commit comments

Comments
 (0)