Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit 0eda54b

Browse files
correct the typo of documents
1 parent 3ed4d87 commit 0eda54b

File tree

4 files changed

+25
-25
lines changed

4 files changed

+25
-25
lines changed

‎docs/README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,14 @@ A special case for remote pagination:
5959
remote={ { pagination: true, filter: false, sort: false } }
6060
```
6161

62-
There is a apecial case for remote pagination, even you only specified the paignation need to handle as remote, `react-bootstrap-table2` will handle all the table changes(filter, sort etc) as remote mode, because `react-bootstrap-table2` only know the data of current page, but filtering, searching or sort need to work on overall datas.
62+
There is a special case for remote pagination, even you only specified the pagination need to handle as remote, `react-bootstrap-table2` will handle all the table changes(filter, sort etc) as remote mode, because `react-bootstrap-table2` only know the data of current page, but filtering, searching or sort need to work on overall data.
6363

6464
### <a name='loading'>loading - [Bool]</a>
6565
Telling if table is loading or not, for example: waiting data loading, filtering etc. It's **only** valid when [`remote`](#remote) is enabled.
6666
When `loading` is `true`, `react-bootstrap-table2` will attend to render a overlay on table via [`overlay`](#overlay) prop, if [`overlay`](#overlay) prop is not given, `react-bootstrap-table2` will ignore the overlay rendering.
6767

6868
### <a name='overlay'>overlay - [Function]</a>
69-
`overlay` accept a factory funtion which should returning a higher order component. By default, `react-bootstrap-table2-overlay` can be a good option for you:
69+
`overlay` accept a factory function which should returning a higher order component. By default, `react-bootstrap-table2-overlay` can be a good option for you:
7070

7171
```sh
7272
$ npm install react-bootstrap-table2-overlay
@@ -163,7 +163,7 @@ const defaultSorted = [{
163163
```
164164

165165
### <a name='pagination'>pagination - [Object]</a>
166-
`pagination` allow user to render a pagination panel on the bottom of table. But pagination funcitonality is separated from core of `react-bootstrap-table2` so that you are suppose to install `react-bootstrap-table2-paginator` additionaly.
166+
`pagination` allow user to render a pagination panel on the bottom of table. But pagination functionality is separated from core of `react-bootstrap-table2` so that you are suppose to install `react-bootstrap-table2-paginator` additionally.
167167

168168
```sh
169169
$ npm install react-bootstrap-table2-paginator --save
@@ -205,15 +205,15 @@ paginator({
205205
prePageTitle: 'Go to previous', // the title of previous page button
206206
firstPageTitle: 'Go to first', // the title of first page button
207207
lastPageTitle: 'Go to last', // the title of last page button
208-
hideSizePerPage: true, // hide the size per page dorpdown
208+
hideSizePerPage: true, // hide the size per page dropdown
209209
hidePageListOnlyOnePage: true, // hide pagination bar when only one page, default is false
210210
onPageChange: (page, sizePerPage) => {}, // callback function when page was changing
211211
onSizePerPageChange: (sizePerPage, page) => {}, // callback function when page size was changing
212212
})
213213
```
214214

215215
### <a name='filter'>filter - [Object]</a>
216-
`filter` allow user to filter data by column. However, filter funcitonality is separated from core of `react-bootstrap-table2` so that you are suppose to install `react-bootstrap-table2-filter` firstly.
216+
`filter` allow user to filter data by column. However, filter functionality is separated from core of `react-bootstrap-table2` so that you are suppose to install `react-bootstrap-table2-filter` firstly.
217217

218218
```sh
219219
$ npm install react-bootstrap-table2-filter --save

‎docs/columns.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ Enable the column sort via a `true` value given.
137137
```
138138

139139
## <a name='classes'>column.classes - [String | Function]</a>
140-
It's availabe to have custom class on table column:
140+
It's available to have custom class on table column:
141141

142142
```js
143143
{
@@ -165,7 +165,7 @@ In addition, `classes` also accept a callback function which have more power to
165165
A new `String` will be the result as element class.
166166

167167
## <a name='headerClasses'>column.headerClasses - [String | Function]</a>
168-
It's similar to [`column.classes`](#classes), `headerClasses` is availabe to have customized class on table header column:
168+
It's similar to [`column.classes`](#classes), `headerClasses` is available to have customized class on table header column:
169169

170170
```js
171171
{
@@ -190,7 +190,7 @@ Furthermore, it also accept a callback function which takes 2 arguments and a `S
190190
A new `String` will be the result of element headerClasses.
191191

192192
## <a name='style'>column.style - [Object | Function]</a>
193-
It's availabe to have custom style on table column:
193+
It's available to have custom style on table column:
194194

195195
```js
196196
{
@@ -220,7 +220,7 @@ A new `Object` will be the result of element style.
220220

221221

222222
## <a name='headerStyle'>column.headerStyle - [Object | Function]</a>
223-
It's availabe to have customized inline-style on table header column:
223+
It's available to have customized inline-style on table header column:
224224

225225
```js
226226
{
@@ -278,7 +278,7 @@ A new `String` will be the result of element title.
278278
}
279279
```
280280

281-
It's also availabe to custom via a callback function:
281+
It's also available to custom via a callback function:
282282
```js
283283
{
284284
headerTitle: function callback(column, colIndex) { ... }
@@ -401,7 +401,7 @@ A new `Object` will be the result of element HTML attributes.
401401

402402
> Caution:
403403
404-
> If `column.classes`, `column.style`, `column.title`, `column.hidden` or `column.align` was given at the same time, property `attrs` has lower priorty and it will be overwrited.
404+
> If `column.classes`, `column.style`, `column.title`, `column.hidden` or `column.align` was given at the same time, property `attrs` has lower priority and it will be overwritten.
405405
406406
```js
407407
{
@@ -412,7 +412,7 @@ A new `Object` will be the result of element HTML attributes.
412412
```
413413

414414
## <a name='headerAttrs'>column.headerAttrs - [Object | Function]</a>
415-
`headerAttrs` is similiar to [`column.attrs`](#attrs) but it works for header column.
415+
`headerAttrs` is similar to [`column.attrs`](#attrs) but it works for header column.
416416
```js
417417
{
418418
// omit...
@@ -444,7 +444,7 @@ A new `Object` will be the result of element headerAttrs.
444444

445445
> Caution:
446446
> Same as [column.attrs](#attrs), it has lower priority and will be
447-
> overwrited when other props related to HTML attributes were given.
447+
> overwritten when other props related to HTML attributes were given.
448448
449449
### <a name='headerSortingClasses'>headerSortingClasses - [String | Function]</a>
450450

@@ -467,7 +467,7 @@ const headerSortingClasses = (column, sortOrder, isLastSorting, colIndex) => { .
467467

468468
### <a name='headerSortingStyle'>headerSortingStyle - [Object | Function]</a>
469469

470-
It's similiar to [headerSortingClasses](#headerSortingClasses). It allows to customize the style of header cell when this column is sorting. A style `Object` and `callback` are acceptable. `callback` takes **4** arguments and an `Object` is expected to return:
470+
It's similar to [headerSortingClasses](#headerSortingClasses). It allows to customize the style of header cell when this column is sorting. A style `Object` and `callback` are acceptable. `callback` takes **4** arguments and an `Object` is expected to return:
471471

472472
```js
473473
const sortingHeaderStyle = {
@@ -502,7 +502,7 @@ If a callback function given, you can control the editable level as cell level:
502502
}
503503
```
504504

505-
The return value can be a bool or an object. If your valiation is pass, return `true` explicitly. If your valiation is invalid, return following object instead:
505+
The return value can be a bool or an object. If your validation is pass, return `true` explicitly. If your validation is invalid, return following object instead:
506506
```js
507507
{
508508
valid: false,
@@ -574,7 +574,7 @@ import { textFilter } from 'react-bootstrap-table2-filter';
574574
For some reason of simple customization, `react-bootstrap-table2` allow you to pass some props to filter factory function. Please check [here](https://github.com/react-bootstrap-table/react-bootstrap-table2/tree/master/packages/react-bootstrap-table2-filter/README.md) for more detail tutorial.
575575

576576
## <a name='filterValue'>column.filterValue - [Function]</a>
577-
Sometimes, if the cell/column value that you don't want to filter on them, you can define `filterValue` to return a actual value you wanna be filterd:
577+
Sometimes, if the cell/column value that you don't want to filter on them, you can define `filterValue` to return a actual value you wanna be filtered:
578578

579579
**Parameters**
580580
* `cell`: The value of current cell.

‎docs/migration.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Migration Guide
22

33
* Please see the [CHANGELOG](https://react-bootstrap-table.github.io/react-bootstrap-table2/blog/2018/01/24/new-version-0.1.0.html) for `react-bootstrap-table2` first drop.
4-
* Please see the [Roadmap](https://react-bootstrap-table.github.io/react-bootstrap-table2/blog/2018/01/24/release-plan.html) for `react-bootstrap-table2` in 2018/Q1.
5-
* Feel free to see the [offical docs](https://react-bootstrap-table.github.io/react-bootstrap-table2/docs/about.html), we list all the basic usage here!!
4+
* Please see the [Road Map](https://react-bootstrap-table.github.io/react-bootstrap-table2/blog/2018/01/24/release-plan.html) for `react-bootstrap-table2` in 2018/Q1.
5+
* Feel free to see the [official docs](https://react-bootstrap-table.github.io/react-bootstrap-table2/docs/about.html), we list all the basic usage here!!
66

77
## Preface
88

@@ -23,11 +23,11 @@ Currently, **I still can't implement all the mainly features in legacy `react-bo
2323
* [`react-bootstrap-table2-overlay`](https://www.npmjs.com/package/react-bootstrap-table2-overlay)
2424
* Overlay/Loading Addons
2525

26-
This can help your application with less bundled size and also help `react-bootstrap-table2` have clean design to avoid handling to much logic in kernal module(SRP). Hence, which means you probably need to install above addons when you need specific features.
26+
This can help your application with less bundled size and also help `react-bootstrap-table2` have clean design to avoid handling to much logic in kernel module(SRP). Hence, which means you probably need to install above addons when you need specific features.
2727

2828
## Core Table Migration
2929

30-
There is a big chagne is that there's no `TableHeaderColumn` in the `react-bootstrap-table2`, instead you are supposed to be define the `columns` prop on `BootstrapTable`:
30+
There is a big change is that there's no `TableHeaderColumn` in the `react-bootstrap-table2`, instead you are supposed to be define the `columns` prop on `BootstrapTable`:
3131

3232
```js
3333
import BootstrapTable from 'react-bootstrap-table-next';
@@ -48,8 +48,8 @@ const columns = [{
4848

4949
The `text` property is just same as the children for the `TableHeaderColumn`, if you want to custom the header, there's a new property is: [`headerFormatter`](https://react-bootstrap-table.github.io/react-bootstrap-table2/docs/column-props.html#columnheaderformatter-function).
5050

51-
* [`BootstrapTable` Definitation](https://react-bootstrap-table.github.io/react-bootstrap-table2/docs/table-props.html)
52-
* [Column Definitation](https://react-bootstrap-table.github.io/react-bootstrap-table2/docs/column-props.html)
51+
* [`BootstrapTable` Definition](https://react-bootstrap-table.github.io/react-bootstrap-table2/docs/table-props.html)
52+
* [Column Definition](https://react-bootstrap-table.github.io/react-bootstrap-table2/docs/column-props.html)
5353

5454
## Table Sort
5555

@@ -65,7 +65,7 @@ Please see [Work with table sort](https://react-bootstrap-table.github.io/react-
6565
- [ ] Sort management
6666
- [ ] Multi sort
6767

68-
Due to no `TableHeaderColumn` so that no `dataSort` here, please add [`sort`](https://react-bootstrap-table.github.io/react-bootstrap-table2/docs/column-props.html#columnsort-bool) property on column definitation.
68+
Due to no `TableHeaderColumn` so that no `dataSort` here, please add [`sort`](https://react-bootstrap-table.github.io/react-bootstrap-table2/docs/column-props.html#columnsort-bool) property on column definition.
6969

7070
## Row Selection
7171

@@ -93,7 +93,7 @@ Please see [available filter configuration](https://react-bootstrap-table.github
9393

9494
Remember to install [`react-bootstrap-table2-filter`](https://www.npmjs.com/package/react-bootstrap-table2-filter) firstly.
9595

96-
Due to no `TableHeaderColumn` so that no `filter` here, please add [`filter`](https://react-bootstrap-table.github.io/react-bootstrap-table2/docs/column-props.html#columnfilter-object) property on column definitation and [`filter`](https://react-bootstrap-table.github.io/react-bootstrap-table2/docs/table-props.html#filter-object) prop on `BootstrapTable`.
96+
Due to no `TableHeaderColumn` so that no `filter` here, please add [`filter`](https://react-bootstrap-table.github.io/react-bootstrap-table2/docs/column-props.html#columnfilter-object) property on column definition and [`filter`](https://react-bootstrap-table.github.io/react-bootstrap-table2/docs/table-props.html#filter-object) prop on `BootstrapTable`.
9797

9898
## Cell Edit
9999

‎docs/row-selection.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ const selectRow = {
102102
```
103103

104104
### <a name='bgColor'>selectRow.bgColor - [String | Function]</a>
105-
The backgroud color when row is selected
105+
The background color when row is selected
106106

107107
```js
108108
const selectRow = {

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /