svar-widgets / grid

Svelte datagrid component. Lightweight, fast, feature-rich.
https://svar.dev/svelte/datagrid/
MIT License
35 stars 0 forks source link
data-grid data-grid-control data-grid-view data-table data-table-component datagrid svelte svelte-component svelte-grid svelte-table svelte-ui-components sveltejs ui-component ui-components
# SVAR Svelte DataGrid | Data Table
:globe_with_meridians: [Website](https://svar.dev/svelte/datagrid/) • :bulb: [Getting Started](https://docs.svar.dev/svelte/grid/getting_started/) • :eyes: [Demos](https://docs.svar.dev/svelte/grid/samples/#/base/willow)
[![npm](https://img.shields.io/npm/v/wx-svelte-grid.svg)](https://www.npmjs.com/package/wx-svelte-grid) [![License](https://img.shields.io/github/license/svar-widgets/grid)](https://github.com/svar-widgets/grid/blob/main/license.txt) [![npm downloads](https://img.shields.io/npm/dm/wx-svelte-grid.svg)](https://www.npmjs.com/package/wx-svelte-grid)

SVAR DataGrid is an advanced Svelte component that enhances standard data tables, enabling you to create high-performance, feature-rich data grids that efficiently handle large data sets. Fully customizable, it supports inline editing with a variety of cell editors to meet diverse project requirements.

SVAR Svelte DataGrid - Screenshot

🔔 Versions for Svelte 4 and 5

There are two versions of SVAR DataGrid:

To use the SVAR DataGrid v.2.0 beta for Svelte 5, install it as follows:

npm install wx-svelte-grid

To use the SVAR DataGrid for Svelte 4:

npm install wx-svelte-grid@1.3.0

:sparkles: Key Features

:hammer_and_wrench: How to Use

To use SVAR DataGrid, simply import the package and include the component in your Svelte file:

<script>
    import { Grid } from "wx-svelte-grid";

    const data = [
        {
            id: 12,
            name: "Alex Brown",
            year: 1974,
        },
    ];
    const columns = [
        {
            id: "name",
            header: "Title",
            flexgrow: 1,
            sort: true,
            editor: "text",
        },
        {
            id: "year",
            header: "Year",
            width: 100,
            sort: true,
            editor: "text",
        },
    ];
</script>

<Grid {data} {columns} />

For further instructions, see the detailed how-to-start guide.

:computer: How to Modify

Typically, you don't need to modify the code. However, if you wish to do so, follow these steps:

  1. Run yarn to install dependencies. Note that this project is a monorepo using yarn workspaces, so npm will not work
  2. Start the project in development mode with yarn start

:white_check_mark: Run Tests

To run the test:

  1. Start the test examples with:
    yarn start:tests
  2. In a separate console, run the end-to-end tests with:
    yarn test:cypress

:speech_balloon: Need Help?

Post an Issue or use our community forum.