Skip to main content

Getting started

This page describes how to start with the DataGrid widget by adding a simple table to your Svelte application.

Step 1. Install the package​

SVAR DataGrid is an open-source library distributed under the MIT license.

Install package from NPM. 

npm install wx-svelte-grid

Working with Svelte 4.x​

If you want to use the library with an older version of the Svelte toolkit, you can do so by using the 1.x version of the widget

npm install wx-svelte-grid@1.3.3

Step 2. Create and initialize the Grid​

Import the Grid component to your project:

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

Initialize the Grid properties.

The example below shows how to create a simple table with six columns and two rows.

The data array holds data to be displayed in the table and the columns array includes the table columns. It's necessary to define the components inside the Grid tag. 

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

const data = [{
        id: 1,
        city: "Amieshire",
        email: "Leora13@yahoo.com",
        firstName: "Ernest",
        lastName: "Schuppe",
        companyName: "Lebsack - Nicolas",
    },
    {
        id: 2,
        city: "Gust",
        email: "Mose_Gerhold51@yahoo.com",
        firstName: "Janis",
        lastName: "Vandervort",
        companyName: "Glover - Hermiston",
    },
];

const columns = [{
        id: "id",
        width: 50
    },
    {
        id: "city",
        width: 100,
        header: "City",
        footer: "City",
    },
    {
        id: "firstName",
        header: "First Name",
        footer: "First Name",
        width: 150,
    },
    {
        id: "lastName",
        header: "Last Name",
        footer: "Last Name",
        width: 150,
    },
    {
        id: "email",
        header: "Email",
        footer: "Email"
    },
    {
        id: "companyName",
        header: "Company",
        footer: "Company"
    },
];
</script>

<Grid {data} {columns} />

More instructions about loading data you can see here Loading data.

Step 3. Apply a theme​

To add look and feel to the application, import one of the predefined themes, which will also make all elements display correctly:

  • Material
  • Willow
  • WillowDark
<script>
  import { getData } from "./common/data";
  import { Grid } from "wx-svelte-grid";  

  import { Willow } from "wx-svelte-grid";

</script>

  <Grid {data} {columns} />

Apply the desired theme by wrapping Grid into the required theme tag:

<script>
  import { getData } from "./common/data";
  import { Grid } from "wx-svelte-grid";  

  import { Willow } from "wx-svelte-grid";

</script>

 <Willow>
  <Grid {data} {columns} />
</Willow>

What's next​

Now when you know how to create a simple data table with Svelte DataGrid, you can follow our step-by-step tutorial to build a table with richer functionality, such as sorting, paging, inline editing, and the ability to search users by name.

And you are finally ready to dive deeper into the Grid API and get down to configuring it to your needs:

  • Guides pages provide instructions about installation, loading data, styling, and other helpful tips to go smoothly with the DataGrid configuration
  • DataGrid API reference gives description of the DataGrid functionality
  • Helpers pages describe how to use RestDataProvider that will make the process of working with backend easy and enjoyable