Skip to content

svar-widgets/vue-grid

Repository files navigation

SVAR Vue DataGrid | Vue Data Table

npm License npm downloads Last Commit

SVAR Vue DataGrid is a high-performance Vue data grid component for building feature-rich, accessible data tables. It supports sorting, advanced filtering, paging, in-cell editing, and virtual scrolling out of the box. Comes with full TypeScript support and a flexible, developer-friendly API.

The data grid is fully compatible with Vue 3 and suitable for dashboards, admin panels, and data-heavy SaaS applications.

SVAR Vue DataGrid - Screenshot

✨ Key Features

Here is a quick overview of what SVAR Vue DataGrid offers:

  • High performance (virtual scrolling and dynamic loading)
  • Pagination
  • Sorting by multiple columns
  • Advanced filtering (including natural language)
  • In-cell editing (datepicker, combo, select, rich select, or custom editor)
  • External editor for grid data
  • Undo/redo
  • Frozen columns
  • Expandable/collapsible columns
  • Custom HTML for cells
  • Customizable tooltips for grid cells
  • Row reordering with drag-and-drop
  • Built-in context menu & toolbar
  • Tree data
  • Print support, export to CSV
  • Keyboard navigation
  • Accessibility: compatibility with WAI-ARIA standard
  • RestDataProvider for easy backend data binding
  • Light and dark themes

Check the demos to see how these features work.

🛠️ How to Use

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

<script setup>
import { Grid } from "@svar-ui/vue-grid";
import "@svar-ui/vue-grid/all.css";

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>

<template>
  <Grid :data="data" :columns="columns" />
</template>

For further instructions, see the detailed getting started guide.

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

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

Need Help?

Join our community forum to get help or post feature requests.

⭐ Show Your Support

If SVAR Vue DataGrid helps your project, give us a star on GitHub! It helps more developers discover this component and keeps our team motivated to ship new features.