https://github.com/frappe/datatable
The Missing Javascript Datatable for the Web
https://github.com/frappe/datatable
datagrid datatable datatables-library editable-grid editable-table grid interactive modern simple table
Last synced: 7 days ago
JSON representation
The Missing Javascript Datatable for the Web
- Host: GitHub
- URL: https://github.com/frappe/datatable
- Owner: frappe
- License: mit
- Created: 2017-10-07T14:58:02.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-03-13T12:13:17.000Z (about 1 year ago)
- Last Synced: 2024-04-14T03:05:54.525Z (about 1 year ago)
- Topics: datagrid, datatable, datatables-library, editable-grid, editable-table, grid, interactive, modern, simple, table
- Language: JavaScript
- Homepage: https://frappe.io/datatable
- Size: 3.12 MB
- Stars: 967
- Watchers: 44
- Forks: 150
- Open Issues: 57
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- best-of-react - GitHub - 64% open · ⏱️ 17.04.2024): (Data Tables & Grids)
- best-of-react - GitHub - 64% open · ⏱️ 17.04.2024): (Data Tables & Grids)
- best-of-react - GitHub - 64% open · ⏱️ 17.04.2024): (Data Tables & Grids)
README
Frappe DataTable
**A modern datatable library for the web**
[](https://github.com/frappe/datatable/actions?query=workflow%3A%22Test+and+Release%22)
[](https://badge.fury.io/js/frappe-datatable)
## Frappe Datatable
Frappe DataTable is a simple, modern and interactive datatable library for displaying tabular data. Originally built for [ERPNext](https://github.com/frappe/erpnext), it can be used to render large amount of rows without sacrificing performance and has the basic data grid features like inline editing and keyboard navigation. It does not require jQuery, unlike most data grids out there.
### Motivation
I was trying to remove all legacy UI components from the [frappe](https://github.com/frappe/frappe) codebase. We were using [SlickGrid](https://github.com/mleibman/SlickGrid) for rendering tables. It was unmaintained and UI was dated. Other datatable solutions either didn't have the features we needed or were closed source. So we built our own.
### Key Features
- **Cell**: Enable editing within individual cells and features like custom formatters, inline editing, and mouse selection. Users can easily copy cell content, navigate through cells using the keyboard, and take advantage of a custom cell editor for advanced functionality.
- **Column**: Columns are highly flexible, allowing users to reorder, resize, and sort them with ease. Additional features include hiding/removing columns and adding custom actions.
- **Row**: Rows support advanced interactions, including row selection, tree-structured organization, and inline filters for precise control. They handle large datasets efficiently with dynamic row heights.
## Usage
```bash
yarn add frappe-datatable
# or
npm install frappe-datatable
```
> Note: [`sortablejs`](https://github.com/RubaXa/Sortable) is required to be installed as well.
```js
const datatable = new DataTable('#datatable', {
columns: [ 'First Name', 'Last Name', 'Position' ],
data: [
[ 'Don', 'Joe', 'Designer' ],
[ 'Mary', 'Jane', 'Software Developer' ]
]
});
```
## Development Setup
* `yarn start` - Start dev server
* Open `index.html` located in the root folder, and start development.
* Run `yarn lint` before committing changes
* This project uses [commitizen](https://github.com/commitizen/cz-cli) for conventional commit messages, use `yarn commit` command instead of `git commit`
## Links
- [Making a new datatable for the web](https://medium.com/frapp%C3%A9-thoughts/things-i-learned-building-a-library-for-the-web-6846a588bf53)
