Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ $ cd react-bootstrap-table2
# Install all dependencies with yarn
$ yarn install

# Start the stroybook server, then go to localhost:6006
# Start the storybook server, then go to localhost:6006
$ yarn storybook

```
Expand Down
2 changes: 1 addition & 1 deletion docs/columns.md
Original file line number Diff line number Diff line change
Expand Up @@ -760,7 +760,7 @@ The return value can be a bool or an object. If your validation is pass, return
}
```

If you want to perform a asycn validation, you can do it like this:
If you want to perform a async validation, you can do it like this:
```js
{
// omit...
Expand Down
2 changes: 1 addition & 1 deletion docs/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Remember to install [`react-bootstrap-table2-paginator`](https://www.npmjs.com/p
- [x] Expand Row Indicator
- [x] Expand Row Management
- [x] Custom Expand Row Indicators
- [ ] Compatiable with Row Selection
- [ ] Compatible with Row Selection
- [ ] Expand Column position
- [ ] Expand Column Style/Class

Expand Down
4 changes: 2 additions & 2 deletions docs/row-expand.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ const expandRow = {
Provide a callback function which allow you to custom the expand indicator. This callback only have one argument which is an object and contain these properties:
* `expanded`: If current row is expanded or not
* `rowKey`: Current row key
* `expandable`: If currnet row is expandable or not
* `expandable`: If current row is expandable or not


```js
Expand Down Expand Up @@ -178,7 +178,7 @@ const expandRow = {
className: 'foo'
};
```
following usage is more flexible way for customing the class name:
following usage is more flexible way for customizing the class name:

```js
const expandRow = {
Expand Down
6 changes: 3 additions & 3 deletions docs/row-selection.md
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ const selectRow = {


### <a name='headerColumnStyle'>selectRow.headerColumnStyle - [Object | Function]</a>
A way to custome the selection header cell. `headerColumnStyle` not only accept a simple style object but also a callback function for more flexible customization:
A way to customize the selection header cell. `headerColumnStyle` not only accept a simple style object but also a callback function for more flexible customization:

### Style Object

Expand All @@ -277,7 +277,7 @@ const selectRow = {
```

### <a name='selectColumnStyle'>selectRow.selectColumnStyle - [Object | Function]</a>
A way to custome the selection cell. `selectColumnStyle` not only accept a simple style object but also a callback function for more flexible customization:
A way to customize the selection cell. `selectColumnStyle` not only accept a simple style object but also a callback function for more flexible customization:

### Style Object

Expand All @@ -291,7 +291,7 @@ const selectRow = {
### Callback Function
If a callback function present, you can get below information to custom the selection cell:

* `checked`: Whether current row is seleccted or not
* `checked`: Whether current row is selected or not
* `disabled`: Whether current row is disabled or not
* `rowIndex`: Current row index
* `rowKey`: Current row key
Expand Down
2 changes: 1 addition & 1 deletion packages/react-bootstrap-table2-editor/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ We have [two ways](https://react-bootstrap-table.github.io/react-bootstrap-table
* click
* dbclick

That's look into how we enable the cell edit on tabe:
That's look into how we enable the cell edit on table:

```js
import cellEditFactory from 'react-bootstrap-table2-editor';
Expand Down
6 changes: 3 additions & 3 deletions packages/react-bootstrap-table2-filter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ const columns = [
}];
```

The benifit is `react-bootstrap-table2` will render the select options by the order of array.
The benefit is `react-bootstrap-table2` will render the select options by the order of array.

## MultiSelect Filter

Expand Down Expand Up @@ -219,7 +219,7 @@ const columns = [..., {
<BootstrapTable keyField='id' data={ products } columns={ columns } filter={ filterFactory() } />
```

Numner filter is same as other filter, you can custom the number filter via `numberFilter` factory function:
Number filter is same as other filter, you can custom the number filter via `numberFilter` factory function:

```js
import filterFactory, { selectFilter, Comparator, numberFilter } from 'react-bootstrap-table2-filter';
Expand All @@ -230,7 +230,7 @@ const numberFilter = numberFilter({
delay: 600, // how long will trigger filtering after user typing, default is 500 ms
placeholder: 'custom placeholder', // placeholder for number input
withoutEmptyComparatorOption: true, // dont render empty option for comparator
withoutEmptyNumberOption: true, // dont render empty option for numner select if it is defined
withoutEmptyNumberOption: true, // dont render empty option for number select if it is defined
comparators: [Comparator.EQ, Comparator.GT, Comparator.LT], // Custom the comparators
style: { display: 'inline-grid' }, // custom the style on number filter
className: 'custom-numberfilter-class', // custom the class on number filter
Expand Down
6 changes: 3 additions & 3 deletions packages/react-bootstrap-table2-overlay/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# react-bootstrap-table2-overlay
In `react-bootstrap-table2`, you will be easier to custom the loading or lverlay on table no matter if remote enabled or not. In the following, we have two way to do it:
In `react-bootstrap-table2`, you will be easier to custom the loading or overlay on table no matter if remote enabled or not. In the following, we have two way to do it:

-----

## Empty Table
[**`noDataIndication`**](https://react-bootstrap-table.github.io/react-bootstrap-table2/docs/table-props.html#nodataindication-function) is a simple case you can take it, if current data size is empty, `react-bootstrap-table2` will call the `noDataIndication` prop and get the result to display on the table.

[**Here**](https://react-bootstrap-table.github.io/react-bootstrap-table2/storybook/index.html?selectedKind=EmptyTableOverlay) is a quick exmaple for `noDataIndication`.
[**Here**](https://react-bootstrap-table.github.io/react-bootstrap-table2/storybook/index.html?selectedKind=EmptyTableOverlay) is a quick example for `noDataIndication`.

## Loading Table
In the most of case for remote mode, you need the loading animation to tell the user the table is loading or doing some action in the background. Hence, you can lervarge [**`overlay`**](https://react-bootstrap-table.github.io/react-bootstrap-table2/docs/table-props.html#overlay-function) prop.
In the most of case for remote mode, you need the loading animation to tell the user the table is loading or doing some action in the background. Hence, you can leverage [**`overlay`**](https://react-bootstrap-table.github.io/react-bootstrap-table2/docs/table-props.html#overlay-function) prop.

[**Here**](https://react-bootstrap-table.github.io/react-bootstrap-table2/storybook/index.html?selectedKind=EmptyTableOverlay) is also a example for `overlay`
12 changes: 6 additions & 6 deletions packages/react-bootstrap-table2-paginator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ const paginationOption = {
</PaginationProvider>
```

`PaginationProvider` actually is a wrapper for the concumser of react context, so that now you have to get the props from context provide then render to your compoennt and `BootstrapTable`:
`PaginationProvider` actually is a wrapper for the consumer of react context, so that now you have to get the props from context provide then render to your component and `BootstrapTable`:

* `paginationProps`: this include everything about pagination, you will use it when you render standalone component or your custom component.
* `paginationTableProps`: you don't need to know about this, but you have to render this as props to `BootstrapTable`.
Expand Down Expand Up @@ -145,7 +145,7 @@ Now, you have to choose which solution you like: standalone or non-standalone ?
#### 4.1 Use Standalone Component
`react-bootstrap-table2-paginator` provider three standalone components:

* Size Per Page Dropdwn Standalone
* Size Per Page Dropdown Standalone
* Pagination List Standalone
* Pagination Total Standalone

Expand Down Expand Up @@ -189,7 +189,7 @@ import paginationFactory, {
</PaginationProvider>
```

That's it!! The benifit for using standalone is you can much easier to render the standalone component in any posistion. In the future, we will implement more featue like applying `style`, `className` etc on standalone components.
That's it!! The benefit for using standalone is you can much easier to render the standalone component in any position. In the future, we will implement more features like applying `style`, `className` etc on standalone components.

##### Customizable props for `PaginationListStandalone`
* N/A
Expand All @@ -206,7 +206,7 @@ That's it!! The benifit for using standalone is you can much easier to render t

#### 4.2 Customization Everything

If you choose to custom the pagination component by yourself, the `paginationProps` will be important for you. Becasue you have to know for example how to change page or what's the current page etc. Hence, following is all the props in `paginationProps` object:
If you choose to custom the pagination component by yourself, the `paginationProps` will be important for you. Because you have to know for example how to change page or what's the current page etc. Hence, following is all the props in `paginationProps` object:

```js
page,
Expand Down Expand Up @@ -242,7 +242,7 @@ In most of case, `page`, `sizePerPage`, `onPageChange` and `onSizePerPageChange`

* `page`: Current page.
* `sizePerPage`: Current size per page.
* `onPageChange`: Call it when you nede to change page. This function accept one number argument which indicate the new page
* `onSizePerPageChange`: Call it when you nede to change size per page. This function accept two number argument which indicate the new sizePerPage and new page
* `onPageChange`: Call it when you need to change page. This function accept one number argument which indicate the new page
* `onSizePerPageChange`: Call it when you need to change size per page. This function accept two number argument which indicate the new sizePerPage and new page

[Here](https://react-bootstrap-table.github.io/react-bootstrap-table2/storybook/index.html?selectedKind=Pagination&selectedStory=Fully%20Custom%20Pagination&full=0&addons=1&stories=1&panelRight=0&addonPanel=storybook%2Factions%2Factions-panel) is a online example.
2 changes: 1 addition & 1 deletion packages/react-bootstrap-table2-toolkit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Accept a string that will be used for default searching when first time table re
```

#### onColumnMatch - [function]
Acccpt a function which will be called when table try to match every cells when search happening. This function accept an object like below example:
Accept a function which will be called when table try to match every cells when search happening. This function accept an object like below example:

```js
function onColumnMatch({
Expand Down