mirror of
https://github.com/gosticks/react-bootstrap-table2.git
synced 2026-08-11 19:50:17 +00:00
close #1005
This commit is contained in:
@@ -32,6 +32,7 @@
|
||||
* [defaultSortDirection](#defaultSortDirection)
|
||||
* [pagination](#pagination)
|
||||
* [filter](#filter)
|
||||
* [filterPosition](filterPosition)
|
||||
* [onTableChange](#onTableChange)
|
||||
* [onDataSizeChange](#onDataSizeChange)
|
||||
|
||||
@@ -329,6 +330,9 @@ Following is a shape of `newState`
|
||||
}
|
||||
```
|
||||
|
||||
### <a name='filterPosition'>filterPosition - [String]</a>
|
||||
Available value is `inline`, `top` and `bottom`, default is `inline`. This prop decide where `react-bootstrap-table` render column filter.
|
||||
|
||||
### <a name='onDataSizeChange'>onDataSizeChange - [Function]</a>
|
||||
This callback function will be called only when data size change by search/filter etc. This function have one argument which is an object contains below props:
|
||||
|
||||
|
||||
+93
@@ -0,0 +1,93 @@
|
||||
import React from 'react';
|
||||
import BootstrapTable from 'react-bootstrap-table-next';
|
||||
import filterFactory, { textFilter } from 'react-bootstrap-table2-filter';
|
||||
import Code from 'components/common/code-block';
|
||||
import { productsGenerator } from 'utils/common';
|
||||
|
||||
const products = productsGenerator(8);
|
||||
|
||||
const columns = [{
|
||||
dataField: 'id',
|
||||
text: 'Product ID'
|
||||
}, {
|
||||
dataField: 'name',
|
||||
text: 'Product Name',
|
||||
filter: textFilter()
|
||||
}, {
|
||||
dataField: 'price',
|
||||
text: 'Product Price',
|
||||
filter: textFilter()
|
||||
}];
|
||||
|
||||
const sourceCode1 = `\
|
||||
import BootstrapTable from 'react-bootstrap-table-next';
|
||||
import filterFactory, { textFilter } from 'react-bootstrap-table2-filter';
|
||||
|
||||
const columns = [{
|
||||
dataField: 'id',
|
||||
text: 'Product ID',
|
||||
}, {
|
||||
dataField: 'name',
|
||||
text: 'Product Name',
|
||||
filter: textFilter()
|
||||
}, {
|
||||
dataField: 'price',
|
||||
text: 'Product Price',
|
||||
filter: textFilter()
|
||||
}];
|
||||
|
||||
<BootstrapTable
|
||||
keyField='id'
|
||||
data={ products }
|
||||
columns={ columns }
|
||||
filter={ filterFactory() }
|
||||
filterPosition="top"
|
||||
/>
|
||||
`;
|
||||
|
||||
const sourceCode2 = `\
|
||||
import BootstrapTable from 'react-bootstrap-table-next';
|
||||
import filterFactory, { textFilter } from 'react-bootstrap-table2-filter';
|
||||
|
||||
const columns = [{
|
||||
dataField: 'id',
|
||||
text: 'Product ID',
|
||||
}, {
|
||||
dataField: 'name',
|
||||
text: 'Product Name',
|
||||
filter: textFilter()
|
||||
}, {
|
||||
dataField: 'price',
|
||||
text: 'Product Price',
|
||||
filter: textFilter()
|
||||
}];
|
||||
|
||||
<BootstrapTable
|
||||
keyField='id'
|
||||
data={ products }
|
||||
columns={ columns }
|
||||
filter={ filterFactory() }
|
||||
filterPosition="bottom"
|
||||
/>
|
||||
`;
|
||||
|
||||
export default () => (
|
||||
<div>
|
||||
<BootstrapTable
|
||||
keyField="id"
|
||||
data={ products }
|
||||
columns={ columns }
|
||||
filter={ filterFactory() }
|
||||
filterPosition="top"
|
||||
/>
|
||||
<Code>{ sourceCode1 }</Code>
|
||||
<BootstrapTable
|
||||
keyField="id"
|
||||
data={ products }
|
||||
columns={ columns }
|
||||
filter={ filterFactory() }
|
||||
filterPosition="bottom"
|
||||
/>
|
||||
<Code>{ sourceCode2 }</Code>
|
||||
</div>
|
||||
);
|
||||
+11
-1
@@ -8,14 +8,17 @@ const products = productsGenerator(8);
|
||||
|
||||
const columns = [{
|
||||
dataField: 'id',
|
||||
text: 'Product ID'
|
||||
text: 'Product ID',
|
||||
footer: 'hello'
|
||||
}, {
|
||||
dataField: 'name',
|
||||
text: 'Product Name',
|
||||
footer: 'hello',
|
||||
filter: textFilter()
|
||||
}, {
|
||||
dataField: 'price',
|
||||
text: 'Product Price',
|
||||
footer: 'hello',
|
||||
filter: textFilter()
|
||||
}];
|
||||
|
||||
@@ -39,6 +42,11 @@ const columns = [{
|
||||
<BootstrapTable keyField='id' data={ products } columns={ columns } filter={ filterFactory() } />
|
||||
`;
|
||||
|
||||
const selectRow = {
|
||||
mode: 'checkbox',
|
||||
clickToSelect: true
|
||||
};
|
||||
|
||||
export default () => (
|
||||
<div>
|
||||
<BootstrapTable
|
||||
@@ -46,6 +54,8 @@ export default () => (
|
||||
data={ products }
|
||||
columns={ columns }
|
||||
filter={ filterFactory() }
|
||||
filterPosition="bottom"
|
||||
selectRow={ selectRow }
|
||||
/>
|
||||
<Code>{ sourceCode }</Code>
|
||||
</div>
|
||||
|
||||
@@ -92,6 +92,7 @@ import AdvanceCustomFilter from 'examples/column-filter/advance-custom-filter';
|
||||
import ClearAllFilters from 'examples/column-filter/clear-all-filters';
|
||||
import FilterHooks from 'examples/column-filter/filter-hooks';
|
||||
import CustomFilterLogic from 'examples/column-filter/custom-filter-logic';
|
||||
import FilterPosition from 'examples/column-filter/filter-position';
|
||||
|
||||
// work on rows
|
||||
import RowStyleTable from 'examples/rows/row-style';
|
||||
@@ -314,6 +315,7 @@ storiesOf('Column Filter', module)
|
||||
.add('Number Filter with Default Value', () => <NumberFilterWithDefaultValue />)
|
||||
.add('Date Filter', () => <DateFilter />)
|
||||
.add('Date Filter with Default Value', () => <DateFilterWithDefaultValue />)
|
||||
.add('Filter Position', () => <FilterPosition />)
|
||||
.add('Custom Text Filter', () => <CustomTextFilter />)
|
||||
.add('Custom Select Filter', () => <CustomSelectFilter />)
|
||||
.add('Custom Number Filter', () => <CustomNumberFilter />)
|
||||
|
||||
@@ -330,3 +330,29 @@ Following properties is valid in `FILTER_TYPES`:
|
||||
* NUMBER
|
||||
* DATE
|
||||
* MULTISELECT
|
||||
|
||||
### Position
|
||||
Default filter is rendered inside the table column header, but you can choose to render them as a row by `filterPosition`:
|
||||
|
||||
#### Render in the top of table body
|
||||
|
||||
```js
|
||||
<BootstrapTable
|
||||
keyField='id'
|
||||
data={ products }
|
||||
columns={ columns }
|
||||
filter={ filterFactory() }
|
||||
filterPosition="top"
|
||||
/>
|
||||
```
|
||||
|
||||
#### Render in the bottom of table body
|
||||
```js
|
||||
<BootstrapTable
|
||||
keyField='id'
|
||||
data={ products }
|
||||
columns={ columns }
|
||||
filter={ filterFactory() }
|
||||
filterPosition="bottom"
|
||||
/>
|
||||
```
|
||||
|
||||
+12
-5
@@ -66,7 +66,8 @@ class BootstrapTable extends PropsBaseResolver(Component) {
|
||||
rowEvents,
|
||||
selectRow,
|
||||
expandRow,
|
||||
cellEdit
|
||||
cellEdit,
|
||||
filterPosition
|
||||
} = this.props;
|
||||
|
||||
const tableWrapperClass = cs('react-bootstrap-table', wrapperClasses);
|
||||
@@ -94,17 +95,21 @@ class BootstrapTable extends PropsBaseResolver(Component) {
|
||||
sortField={ this.props.sortField }
|
||||
sortOrder={ this.props.sortOrder }
|
||||
onSort={ this.props.onSort }
|
||||
onFilter={ this.props.onFilter }
|
||||
currFilters={ this.props.currFilters }
|
||||
onExternalFilter={ this.props.onExternalFilter }
|
||||
selectRow={ selectRow }
|
||||
expandRow={ expandRow }
|
||||
filterPosition={ filterPosition }
|
||||
/>
|
||||
{hasFilters && (
|
||||
{hasFilters && filterPosition !== Const.FILTERS_POSITION_INLINE && (
|
||||
<Filters
|
||||
columns={ columns }
|
||||
className={ this.props.filtersClasses }
|
||||
onSort={ this.props.onSort }
|
||||
onFilter={ this.props.onFilter }
|
||||
currFilters={ this.props.currFilters }
|
||||
position={ this.props.filtersPosition }
|
||||
filterPosition={ this.props.filterPosition }
|
||||
onExternalFilter={ this.props.onExternalFilter }
|
||||
/>
|
||||
)}
|
||||
@@ -211,8 +216,9 @@ BootstrapTable.propTypes = {
|
||||
rowClasses: PropTypes.oneOfType([PropTypes.string, PropTypes.func]),
|
||||
headerClasses: PropTypes.string,
|
||||
filtersClasses: PropTypes.string,
|
||||
filtersPosition: PropTypes.oneOf([
|
||||
filterPosition: PropTypes.oneOf([
|
||||
Const.FILTERS_POSITION_TOP,
|
||||
Const.FILTERS_POSITION_INLINE,
|
||||
Const.FILTERS_POSITION_BOTTOM
|
||||
]),
|
||||
footerClasses: PropTypes.string,
|
||||
@@ -256,7 +262,8 @@ BootstrapTable.defaultProps = {
|
||||
cellEdit: {
|
||||
mode: null,
|
||||
nonEditableRows: []
|
||||
}
|
||||
},
|
||||
filterPosition: Const.FILTERS_POSITION_INLINE
|
||||
};
|
||||
|
||||
export default BootstrapTable;
|
||||
|
||||
@@ -13,6 +13,7 @@ export default {
|
||||
TYPE_NUMBER: 'number',
|
||||
TYPE_BOOLEAN: 'bool',
|
||||
TYPE_DATE: 'date',
|
||||
FILTERS_POSITION_INLINE: 'inline',
|
||||
FILTERS_POSITION_TOP: 'top',
|
||||
FILTERS_POSITION_BOTTOM: 'bottom'
|
||||
};
|
||||
|
||||
+8
-7
@@ -10,7 +10,7 @@ const Filters = (props) => {
|
||||
columns,
|
||||
onFilter,
|
||||
currFilters,
|
||||
position,
|
||||
filterPosition,
|
||||
onExternalFilter,
|
||||
className
|
||||
} = props;
|
||||
@@ -35,25 +35,26 @@ const Filters = (props) => {
|
||||
});
|
||||
|
||||
return (
|
||||
<tfoot
|
||||
<tbody
|
||||
className={ className }
|
||||
style={ {
|
||||
display:
|
||||
position === Const.FILTERS_POSITION_TOP
|
||||
? 'table-header-group'
|
||||
: 'table-footer-group'
|
||||
filterPosition === Const.FILTERS_POSITION_TOP
|
||||
? 'table-header-group'
|
||||
: 'table-footer-group'
|
||||
} }
|
||||
>
|
||||
<tr>{filterColumns}</tr>
|
||||
</tfoot>
|
||||
</tbody>
|
||||
);
|
||||
};
|
||||
|
||||
Filters.propTypes = {
|
||||
columns: PropTypes.array.isRequired,
|
||||
onFilter: PropTypes.func,
|
||||
position: PropTypes.oneOf([
|
||||
filterPosition: PropTypes.oneOf([
|
||||
Const.FILTERS_POSITION_TOP,
|
||||
Const.FILTERS_POSITION_INLINE,
|
||||
Const.FILTERS_POSITION_BOTTOM
|
||||
]),
|
||||
currFilters: PropTypes.object,
|
||||
|
||||
+17
-12
@@ -21,6 +21,7 @@ class HeaderCell extends eventDelegater(React.Component) {
|
||||
isLastSorting,
|
||||
onFilter,
|
||||
currFilters,
|
||||
filterPosition,
|
||||
onExternalFilter
|
||||
} = this.props;
|
||||
|
||||
@@ -104,18 +105,20 @@ class HeaderCell extends eventDelegater(React.Component) {
|
||||
if (cellClasses) cellAttrs.className = cs(cellAttrs.className, cellClasses);
|
||||
if (!_.isEmptyObject(cellStyle)) cellAttrs.style = cellStyle;
|
||||
|
||||
if (filterRenderer) {
|
||||
const onCustomFilter = onExternalFilter(column, filter.props.type);
|
||||
filterElm = filterRenderer(onCustomFilter, column);
|
||||
} else if (filter) {
|
||||
filterElm = (
|
||||
<filter.Filter
|
||||
{ ...filter.props }
|
||||
filterState={ currFilters[column.dataField] }
|
||||
onFilter={ onFilter }
|
||||
column={ column }
|
||||
/>
|
||||
);
|
||||
if (filterPosition === Const.FILTERS_POSITION_INLINE) {
|
||||
if (filterRenderer) {
|
||||
const onCustomFilter = onExternalFilter(column, filter.props.type);
|
||||
filterElm = filterRenderer(onCustomFilter, column);
|
||||
} else if (filter) {
|
||||
filterElm = (
|
||||
<filter.Filter
|
||||
{ ...filter.props }
|
||||
filterState={ currFilters[column.dataField] }
|
||||
onFilter={ onFilter }
|
||||
column={ column }
|
||||
/>
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
const children = headerFormatter ?
|
||||
@@ -180,6 +183,8 @@ HeaderCell.propTypes = {
|
||||
sortCaret: PropTypes.func,
|
||||
isLastSorting: PropTypes.bool,
|
||||
onFilter: PropTypes.func,
|
||||
filterPosition: PropTypes.oneOf([Const.FILTERS_POSITION_INLINE,
|
||||
Const.FILTERS_POSITION_BOTTOM, Const.FILTERS_POSITION_TOP]),
|
||||
currFilters: PropTypes.object,
|
||||
onExternalFilter: PropTypes.func
|
||||
};
|
||||
|
||||
+18
-2
@@ -14,10 +14,14 @@ const Header = (props) => {
|
||||
className,
|
||||
columns,
|
||||
onSort,
|
||||
onFilter,
|
||||
sortField,
|
||||
sortOrder,
|
||||
selectRow,
|
||||
expandRow
|
||||
expandRow,
|
||||
currFilters,
|
||||
onExternalFilter,
|
||||
filterPosition
|
||||
} = props;
|
||||
|
||||
let SelectionHeaderCellComp = () => null;
|
||||
@@ -49,6 +53,10 @@ const Header = (props) => {
|
||||
sorting={ currSort }
|
||||
sortOrder={ sortOrder }
|
||||
isLastSorting={ isLastSorting }
|
||||
onFilter={ onFilter }
|
||||
currFilters={ currFilters }
|
||||
onExternalFilter={ onExternalFilter }
|
||||
filterPosition={ filterPosition }
|
||||
/>);
|
||||
})
|
||||
];
|
||||
@@ -81,11 +89,19 @@ const Header = (props) => {
|
||||
Header.propTypes = {
|
||||
columns: PropTypes.array.isRequired,
|
||||
onSort: PropTypes.func,
|
||||
onFilter: PropTypes.func,
|
||||
sortField: PropTypes.string,
|
||||
sortOrder: PropTypes.string,
|
||||
selectRow: PropTypes.object,
|
||||
currFilters: PropTypes.object,
|
||||
onExternalFilter: PropTypes.func,
|
||||
className: PropTypes.string,
|
||||
expandRow: PropTypes.object
|
||||
expandRow: PropTypes.object,
|
||||
filterPosition: PropTypes.oneOf([
|
||||
Const.FILTERS_POSITION_TOP,
|
||||
Const.FILTERS_POSITION_INLINE,
|
||||
Const.FILTERS_POSITION_BOTTOM
|
||||
])
|
||||
};
|
||||
|
||||
export default Header;
|
||||
|
||||
Reference in New Issue
Block a user