Skip to content

Latest commit

 

History

History
146 lines (104 loc) · 6.92 KB

migration.md

File metadata and controls

146 lines (104 loc) · 6.92 KB
Raw

Migration Guide

  • Please see the CHANGELOG for react-bootstrap-table2 first drop.
  • Please see the Road Map for react-bootstrap-table2 in 2018/Q1.
  • Feel free to see the official docs, we list all the basic usage here!!

Preface

Currently, I still can't implement all the mainly features in legacy react-bootstrap-table, so please watch our github repo or blog to make sure the legacy features you wanted are already implemented on react-bootstrap-table2. Anyway, ask me by open issue is ok.

react-bootstrap-table2 separate some functionalities from core modules to other modules like following:

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.

Core Table Migration

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:

import BootstrapTable from 'react-bootstrap-table-next';

const columns = [{
  dataField: 'id',
  text: 'Product ID'
}, {
  dataField: 'name',
  text: 'Product Name'
}, {
  dataField: 'price',
  text: 'Product Price'
}];

<BootstrapTable keyField='id' data={ products } columns={ columns } />

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.

Table Sort

Please see Work with table sort.

  • Basic sorting
  • Custom sort function
  • Default Sort
  • Remote mode
  • Custom the sorting header
  • Sort event listener
  • Custom the sort caret
  • Sort management
  • Multi sort

Due to no TableHeaderColumn so that no dataSort here, please add sort property on column definition.

Row Selection

Please see Work with selection.
Please see available selectRow configurations.

No huge change for row selection.

Column Filter

Please see Work with column filter.
Please see available filter configuration.

  • Text Filter
  • Custom Text Filter
  • Remote Filter
  • Custom Filter Component
  • Regex Filter
  • Select Filter
  • Custom Select Filter
  • Number Filter
  • Date Filter
  • Array Filter
  • Programmatically Filter

Remember to install react-bootstrap-table2-filter firstly.

Due to no TableHeaderColumn so that no filter here, please add filter property on column definition and filter prop on BootstrapTable.

Cell Edit

Please see Work with cell edit.
Please see available cell edit configurations.

Remember to install react-bootstrap-table2-editor firstly.

No big changes for cell editing, validator will not support the async call(Promise).

Pagination

Please see Work with pagination.
Please see available pagination configurations.

Remember to install react-bootstrap-table2-paginator firstly.

Table Search

Ｔhe usage of search functionality is a little bit different from legacy search. The mainly different thing is developer have to render the search input field, we do believe it will be very flexible for all the developers who want to custom the search position or search field itself.

  • Custom search component and position
  • Custom search value
  • Clear search
  • Multiple search
  • Strict search

Row Expand

  • Expand Row Events
  • Expand Row Indicator
  • Expand Row Management
  • Custom Expand Row Indicators
  • Compatiable with Row Selection
  • Expand Column position
  • Expand Column Style/Class

Export CSV

Export CSV functionality is like search, which is one of functionality in the react-bootstrap-table2-toolkit. All of the legacy functions we already implemented.

Remote

It's totally different in react-bootstrap-table2. Please see.

Row insert/Delete

Not support yet

Keyboard Navigation

Not support yet