Skip to content

README: add features list (#2575) #2642

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 9, 2021
Merged

README: add features list (#2575) #2642

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e8de800
README: add features list (#2575)
nstepien Sep 9, 2021
1eb8af6
Add browser and react support
nstepien Sep 9, 2021
3b7b549
Mention tree-shaking and only 1 dep
nstepien Sep 9, 2021
676281f
Merge branch 'main' into feats
nstepien Sep 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 33 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,39 @@
[ci-badge]: https://github.com/adazzle/react-data-grid/workflows/CI/badge.svg
[ci-url]: https://github.com/adazzle/react-data-grid/actions

## Features

- [React 16.14+ & 17.0+](package.json) support
- [Evergreen browsers and server-side rendering](browserslist) support
Copy link
Collaborator

@amanmahajan7 amanmahajan7 Sep 9, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if RDG supports server side rendering. I think useLayoutEffect may show a warning

- 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)>)
- 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
Expand Down Expand Up @@ -121,14 +154,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
Expand Down