UNPKG

@infinite-table/infinite-react

Version:
126 lines (86 loc) โ€ข 7 kB
<div align="center"> <h1> <b>Infinite Table</b> </h1> <h3>One Table โ€” Infinite Applications</h3> <a href="https://infinite-table.com"> <img width="150px" height="170px" alt="InfiniteTable Logo" src="https://infinite-table.com/logo-infinite.svg" /> </a> <h4 >Infinite Table is the modern DataGrid for building React apps โ€” faster.</h4> <br /> <br /> </div> ![Infinite Table for React configured with grouping, multi-selection, aggregations and custom styling.](https://infinite-table.com/full-demo-image.png "Infinite Table demo") ## Table Of Contents <!-- START doctoc generated TOC please keep comment here to allow auto update --> <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> - [๐Ÿค” What is Infinite Table?](#-what-is-infinite-table) - [๐Ÿ“ฆ Installation](#-installation) - [๐Ÿ“„ Extensive documentation](#-extensive-documentation) - [โค๏ธ TypeScript](#-typescript) - [๐Ÿข Enterprise-ready](#-enterprise-ready) - [๐Ÿ”’ Secure by default](#-secure-by-default) - [๐Ÿšซ No dependencies](#-no-dependencies) - [๐Ÿ“ฆ Small bundle size](#-small-bundle-size) - [๐Ÿงช Automated end-to-end tests](#-automated-end-to-end-tests) - [๐ŸŽจ Themable](#-themable) - [๐Ÿš€ Releases](#-releases) - [๐Ÿ“‘ License](#-license) <!-- END doctoc generated TOC please keep comment here to allow auto update --> ## ๐Ÿค” What is Infinite Table? `Infinite Table` is a React DataGrid component for displaying virtualized tabular data. It helps you display huge datasets and get the most out of them by providing you the right tools to do so: * [<img src="https://infinite-table.com/icons/sorting.svg" align="center" /> sorting](https://infinite-table.com/docs/learn/sorting/overview) * [<img src="https://infinite-table.com/icons/row-grouping.svg" align="center" /> row grouping](https://infinite-table.com/docs/learn/grouping-and-pivoting/grouping-rows) - both server-side and client-side * [<img src="https://infinite-table.com/icons/pivoting.svg" align="center" /> pivoting](https://infinite-table.com/docs/learn/grouping-and-pivoting/pivoting/overview) - both server-side and client-side * [<img src="https://infinite-table.com/icons/aggregations.svg" align="center" /> aggregations](https://infinite-table.com/docs/learn/grouping-and-pivoting/grouping-rows#aggregations) * [<img src="https://infinite-table.com/icons/live-pagination.svg" align="center" /> live pagination](https://infinite-table.com/docs/learn/working-with-data/live-pagination) * [<img src="https://infinite-table.com/icons/lazy-loading.svg" align="center" /> lazy loading](https://infinite-table.com/docs/learn/working-with-data/lazy-loading) * [<img src="https://infinite-table.com/icons/keyboard-navigation.svg" align="center" /> keyboard navigation for cells and rows](https://infinite-table.com/docs/learn/keyboard-navigation/navigating-cells) * [<img src="https://infinite-table.com/icons/fixed-flex-cols.svg" align="center" /> fixed and flexible columns](https://infinite-table.com/docs/learn/columns/fixed-and-flexible-size) * [<img src="https://infinite-table.com/icons/column-grouping.svg" align="center" /> column grouping](https://infinite-table.com/docs/learn/column-groups) * [<img src="https://infinite-table.com/icons/filtering.svg" align="center" /> filtering](https://infinite-table.com/docs/learn/filtering) * [<img src="https://infinite-table.com/icons/theming.svg" align="center" /> theming](https://infinite-table.com/docs/learn/theming) <!-- * [๐Ÿ—ƒ filtering](https://infinite-table.com/docs/learn/filtering) --> ## ๐Ÿ“ฆ Installation ```bash npm install @infinite-table/infinite-react --save ``` ## [๐Ÿ“„ Extensive documentation](https://infinite-table.com/docs) Our approach with the `InfiniteTable` is to go documentation first. From our developer experience we know that most software products lack a good documentation. So we want to be different and start with the documentation first since our purpose is to have an outstanding documentation that developers can actually use. **[Visit our docs and getting-started guide](https://infinite-table.com/docs)** ## โค๏ธ TypeScript It's fully typed and offers you great developer experience to help you get up and running quickly > The TypeScript typings file is included in the npm package - you don't have to download an additional **@types** package. ## ๐Ÿข Enterprise-ready Infinite Table is ready to power your enterprise apps, as it supports advanced [data fetching](https://infinite-table.com/docs/learn/working-with-data#data-loading-strategies), [filtering](https://infinite-table.com/docs/learn/filtering), [sorting](https://infinite-table.com/docs/learn/sorting/overview), [grouping](https://infinite-table.com/docs/learn/grouping-and-pivoting/grouping-rows), [pivoting](https://infinite-table.com/docs/learn/grouping-and-pivoting/pivoting/overview), [aggregations](https://infinite-table.com/docs/learn/grouping-and-pivoting/group-aggregations), [row & cell selection](https://infinite-table.com/docs/learn/selection/row-selection), [live pagination](https://infinite-table.com/docs/learn/working-with-data/live-pagination), [lazy loading](https://infinite-table.com/docs/learn/working-with-data/lazy-loading) - all of those with support for both client-side and server-side implementations. You can choose to leverage our built-in implementations in the browser or you can process your data on the server with full support from our-side. ### ๐Ÿ”’ Secure by default We take security seriously and we're not installing any dependencies. No extra fluff to slow down your code or make installs less secure. ### ๐Ÿšซ No dependencies We don't depend on any external package, so you can be sure that you're not introducing any security vulnerabilities in your app. ### ๐Ÿ“ฆ Small bundle size Our bundle size is under `400kB` (without gzip) and we're [keeping it small](https://bundlephobia.com/package/@infinite-table/infinite-react). ### ๐Ÿงช Automated end-to-end tests Our releases are automated and we have [end-to-end tests](https://github.com/infinite-table/infinite-react/tree/master/examples/src/pages/tests) that ensure we're delivering to our standards. Real-browser tests help us move with confidence and continue to ship great features. ## ๐ŸŽจ Themable `Infinite Table` is fully customizable, via CSS variables. It ships with both a **light** and a **dark** theme - you have to import the CSS file from the package. ```js import "@infinite-table/infinite-react/index.css" ``` This file includes both the light and the dark themes. ## ๐Ÿš€ Releases We release often - see [what each release contains here](https://infinite-table.com/docs/releases). Due to our automated releases which have integrated tests, we're confident that we're delivering the best possible experience to our users. ## ๐Ÿ“‘ License Both Open and [Commercial License](https://infinite-table.com/eula) For commercial license and support, see our [Pricing page](https://infinite-table.com/pricing).