From 3e464faf8cd4280735cd3d3d07e5c9b967d08fef Mon Sep 17 00:00:00 2001 From: Roman Komarov Date: Thu, 10 Oct 2019 14:54:10 +0200 Subject: [PATCH] Changing the name to react-table-v6 (#1584) Also adds the corresponding changes to the documentation and adds TypeScript definitions. --- README.md | 51 ++-- index.d.ts | 748 ++++++++++++++++++++++++++++++++++++++++++++++ package-lock.json | 4 +- package.json | 8 +- 4 files changed, 783 insertions(+), 28 deletions(-) create mode 100644 index.d.ts diff --git a/README.md b/README.md index 2bc1734..7b7ff23 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@
- React Table Logo + React Table Logo
-# React Table +# React Table v6 `react-table` is a **lightweight, fast and extendable datagrid** built for React @@ -28,6 +28,10 @@

+## v6 + +This is a v6 of react-table, due to the incredibly massive differences from v7 this branch exists as a way to access its docs and source. I do not intend on offering any long-term support for it. If you intend to keep using v6, I recommend maintaining your own fork of the library and keeping it up to date for your version of React. Otherwise, look into using [the most recent version](https://github.com/tannerlinsley/react-table) of react-table! + ## Features - Lightweight at 11kb (and just 2kb more for styles) @@ -66,6 +70,7 @@ ## Versions +- [The most recent version](https://github.com/tannerlinsley/react-table) - This documentation is for version 6 of react-table. - [View the Changelog](https://github.com/react-tools/react-table/blob/master/CHANGELOG.md) - Previous versions: @@ -169,34 +174,36 @@ ## Installation +Note that this installation guide uses the `react-table-v6` version of the package; while you could access the earier versions of the package by `react-table` name, in order to provide a better migration workflow from v6 to the most recent version of the 6.x.x exists as `react-table-v6`. + 1. Install React Table as a dependency ```bash # Yarn -$ yarn add react-table +$ yarn add react-table-v6 # NPM -$ npm install react-table +$ npm install react-table-v6 ``` ## Usage -2. Import the `react-table` module +2. Import the `react-table-v6` module ```javascript // ES6 -import ReactTable from 'react-table' +import ReactTable from 'react-table-v6' // ES5 -var ReactTable = require('react-table').default +var ReactTable = require('react-table-v6').default ``` 3. Import styles by including `react-table.css` ```javascript // JS (Webpack) -import 'react-table/react-table.css' +import 'react-table-v6/react-table.css' // Old-school - + ``` See the example below for further usage. @@ -207,12 +214,12 @@ See the example below for further usage. - - + +