From e8de8009274959b7ad04f19a8a6d5cf3a5d6bf88 Mon Sep 17 00:00:00 2001 From: Nicolas Stepien Date: Thu, 9 Sep 2021 14:17:21 +0100 Subject: [PATCH 1/3] README: add features list (#2575) --- README.md | 38 ++++++++++++++++++++++++++++++-------- 1 file changed, 30 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 21ee0d3d25..0f12d14921 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,36 @@ [ci-badge]: https://github.com/adazzle/react-data-grid/workflows/CI/badge.svg [ci-url]: https://github.com/adazzle/react-data-grid/actions +## Features + +- Great performance thanks to virtualization: columns and rows outside the viewport are not rendered +- Strictly typed with TypeScript +- [Keyboard accessibility](<(https://adazzle.github.io/react-data-grid/canary/?path=/story/demos--common-features)>) +- Light and dark mode support out of the box. The light or dark themes can be enforced using the `rdg-light` or `rdg-dark` classes. +- [Frozen columns](https://adazzle.github.io/react-data-grid/canary/?path=/story/demos--common-features) +- [Column resizing](https://adazzle.github.io/react-data-grid/canary/?path=/story/demos--common-features) +- [Multi-column sorting](https://adazzle.github.io/react-data-grid/canary/?path=/story/demos--common-features) + - Click on a sortable column header to toggle between its ascending/descending sort order + - Ctrl+Click / Meta+Click to sort an additional column +- [Column spanning](https://adazzle.github.io/react-data-grid/canary/?path=/story/demos--column-spanning) +- [Row selection](https://adazzle.github.io/react-data-grid/canary/?path=/story/demos--common-features) +- [Row grouping](https://adazzle.github.io/react-data-grid/canary/?path=/story/demos--grouping) +- [Summary rows](https://adazzle.github.io/react-data-grid/canary/?path=/story/demos--common-features) +- [Dynamic row heights](https://adazzle.github.io/react-data-grid/canary/?path=/story/demos--variable-row-height) +- [No rows fallback](https://adazzle.github.io/react-data-grid/canary/?path=/story/demos--no-rows) +- [Cell formatting](https://adazzle.github.io/react-data-grid/canary/?path=/story/demos--common-features) +- [Cell editing](https://adazzle.github.io/react-data-grid/canary/?path=/story/demos--common-features) +- [Cell copy / pasting](https://adazzle.github.io/react-data-grid/canary/?path=/story/demos--all-features) +- [Cell value dragging / filling](https://adazzle.github.io/react-data-grid/canary/?path=/story/demos--all-features) + +## Links + +- [Website](https://adazzle.github.io/react-data-grid/canary/) + - [Source code](stories) +- [Old website for react-data-grid v5](https://adazzle.github.io/react-data-grid/) +- [Changelog](CHANGELOG.md) +- [Contributing](CONTRIBUTING.md) + ## Install ```sh @@ -121,14 +151,6 @@ function App() { } ``` -## Documentation - -- [Website](https://adazzle.github.io/react-data-grid/canary/) - - [Source code](stories) -- [Old website for react-data-grid v5](https://adazzle.github.io/react-data-grid/) -- [Changelog](CHANGELOG.md) -- [Contributing](CONTRIBUTING.md) - ## API ### Components From 1eb8af663821a8e10c40b9e84d70ba4811826fac Mon Sep 17 00:00:00 2001 From: Nicolas Stepien Date: Thu, 9 Sep 2021 14:23:35 +0100 Subject: [PATCH 2/3] Add browser and react support --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 0f12d14921..ef86df538c 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,8 @@ ## Features +- [React 16.14+ & 17.0+](package.json) support +- [Evergreen browsers and server-side rendering](browserslist) support - Great performance thanks to virtualization: columns and rows outside the viewport are not rendered - Strictly typed with TypeScript - [Keyboard accessibility](<(https://adazzle.github.io/react-data-grid/canary/?path=/story/demos--common-features)>) From 3b7b5497417b63db1f261b97d65e5f533ba23443 Mon Sep 17 00:00:00 2001 From: Nicolas Stepien Date: Thu, 9 Sep 2021 14:26:06 +0100 Subject: [PATCH 3/3] Mention tree-shaking and only 1 dep --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index ef86df538c..0b26eb28e3 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ - [React 16.14+ & 17.0+](package.json) support - [Evergreen browsers and server-side rendering](browserslist) support +- Tree-shaking support and only [one npm dependency](package.json) to keep your bundles slim - Great performance thanks to virtualization: columns and rows outside the viewport are not rendered - Strictly typed with TypeScript - [Keyboard accessibility](<(https://adazzle.github.io/react-data-grid/canary/?path=/story/demos--common-features)>)