Vue Data Grid Column Ordering & Visibility

Column ordering & visibility

Let users reorder Data Grid columns by drag-and-drop and hide or show columns through a column chooser.

On this page

Give users control over the layout: drag headers to reorder columns and toggle columns on and off to focus on what matters. Both features are driven through the headless table, so you can wire them into your own toolbar — as the column chooser in this demo does.

Column ordering & visibility

column-order makes headers draggable — drop one onto another to reorder (dragging never crosses a pinning boundary); pass an array for an initial order. column-visibility enables hiding and showing columns through the headless table (column.toggleVisibility(), column.getIsVisible()); pass an object like { email: false } to start with a column hidden. Opt a column out with movable: false / hideable: false. This demo adds a column chooser built entirely with the toolbar slot.

vue

<script setup lang="ts">
import { CDataGrid } from '@coreui/vue-data-grid'

const firstNames = ['Alice', 'Bob', 'Carol', 'Dave', 'Eve', 'Frank', 'Grace', 'Heidi', 'Ivan', 'Judy']
const lastNames = ['Smith', 'Jones', 'Brown', 'Taylor', 'Wilson', 'Davies', 'Evans', 'Thomas']
const roles = ['admin', 'editor', 'viewer']

const items = Array.from({ length: 1000 }, (_, i) => {
  const name = `${firstNames[i % firstNames.length]} ${lastNames[i % lastNames.length]}`
  return {
    id: i + 1,
    name,
    email: `${name.toLowerCase().replace(' ', '.')}${i}@example.com`,
    role: roles[i % roles.length]
  }
})

const columns = [
  // movable/hideable: false keeps the key column in place
  {
    key: 'id', label: '#', width: 90, movable: false, hideable: false
  },
  { key: 'name', label: 'Name' },
  { key: 'email', label: 'Email', style: { width: '30%' } },
  { key: 'role', label: 'Role', width: 110 }
]
</script>

<template>
  <CDataGrid
    :columns="columns"
    :items="items"
    :item-key="(item) => String(item.id)"
    column-order
    column-visibility
    :pagination="{ pageSize: 10 }"
  >
    <!-- Column chooser built with the toolbar slot and the headless table -->
    <template #toolbar="{ table }">
      <div class="d-flex gap-3 mb-2">
        <template v-for="column in table.getAllLeafColumns()" :key="column.id">
          <label v-if="column.getCanHide()" class="form-check form-check-inline m-0">
            <input
              type="checkbox"
              class="form-check-input me-1"
              :checked="column.getIsVisible()"
              @change="(event) => column.toggleVisibility((event.target as HTMLInputElement).checked)"
            />
            {{ column.id }}
          </label>
        </template>
      </div>
    </template>
  </CDataGrid>
</template>

Options

Option	Type	Default	Description
`columnOrder`	`boolean \| string[]`	`false`	Drag-and-drop reordering; an array sets the initial order. Never crosses a pinning boundary.
`columnVisibility`	`boolean \| Record<string, boolean>`	`false`	Enables hiding/showing columns; an object sets the initial visibility.
`movable` (column)	`boolean`	`true`	Set `false` to exclude a column from reordering.
`hideable` (column)	`boolean`	`true`	Set `false` to prevent hiding a column.

Reordering emits order-change with the columnOrder state; toggling visibility emits visibility-change with the columnVisibility state. The column menu offers a keyboard-accessible Move left/right as an alternative to drag-and-drop.