Hire Us Get CoreUI Data Grid →

Data Grid Quickstart

Quickstart

Markdown ChatGPT Claude

Render your first CoreUI Data Grid in a few lines — columns, data, a stable row key, then your first feature.

On this page

This guide builds a working grid from scratch. It assumes you’ve installed @coreui/data-grid and loaded its stylesheet.

1. A container

The grid renders into any element:

<div id="grid"></div>

2. Columns and data

Define columns by key (the property to read from each item) and pass your items:

import { DataGrid } from '@coreui/data-grid'
import '@coreui/data-grid/dist/css/data-grid.css'

const items = [
  { id: 1, name: 'Alice', role: 'admin' },
  { id: 2, name: 'Bob', role: 'editor' },
  { id: 3, name: 'Carol', role: 'viewer' },
]

const grid = new DataGrid(document.getElementById('grid'), {
  columns: [
    { key: 'name', label: 'Name' },
    { key: 'role', label: 'Role' },
  ],
  items,
  itemKey: (item) => String(item.id),
})

itemKey returns a stable id per row. It’s optional, but selection needs it to survive sorting and filtering — set it up front.

3. Turn on a feature

Every feature is a single option. Add filtering and selection:

const grid = new DataGrid(element, {
  columns,
  items,
  itemKey: (item) => String(item.id),
  columnFilters: true,   // per-column filter row
  rowSelection: true,    // checkbox column with select-all
})

Sorting is on by default. From here, explore the feature matrix or jump to any feature page.

4. React to changes

The grid emits namespaced events with structured state:

element.addEventListener('selectionChange.coreui.data-grid', (event) => {
  console.log(event.selectedItems)
})

What’s next