Data Grid Column Pinning

Column pinning

Freeze Data Grid columns to the left or right edge so they stay visible while the rest of the grid scrolls horizontally.

On this page

Keep an identifier or an actions column in view while users scroll a wide grid sideways. Pinning freezes columns against the left or right edge with sticky positioning; everything else scrolls between them.

Column pinning

Freeze columns against the left or right edge with columnPinning: { left, right } — they stay put while the rest of the grid scrolls horizontally. Pass columnPinning: true to enable the feature and pin later through the headless table (grid.table.setColumnPinning(...)). When a column is pinned left and selection is on, the checkbox column travels with it. The last left and first right column cast a shadow over the scrolling content.

Pinning physically moves the column to its edge — the rendered order is always left-pinned, center, right-pinned.

html

<div id="dataGridPinning"></div>

const firstNames = ['Alice', 'Bob', 'Carol', 'Dave', 'Eve']
const lastNames = ['Smith', 'Jones', 'Brown', 'Taylor', 'Wilson']
const countries = ['Poland', 'Germany', 'France', 'Spain', 'Italy']

const items = Array.from({ length: 1000 }, (_, i) => ({
  id: i + 1,
  firstName: firstNames[i % firstNames.length],
  lastName: lastNames[i % lastNames.length],
  email: `user${i + 1}@example.com`,
  country: countries[i % countries.length]
}))

new coreui.DataGrid(document.getElementById('dataGridPinning'), {
  columns: [
    { key: 'id', label: '#', width: 80 },
    { key: 'firstName', label: 'First name', width: 160 },
    { key: 'lastName', label: 'Last name', width: 160 },
    { key: 'email', label: 'Email', width: 260 },
    { key: 'country', label: 'Country', width: 200 },
    {
      key: 'actions',
      label: '',
      sortable: false,
      width: 120,
      render(item) {
        const button = document.createElement('button')
        button.type = 'button'
        button.className = 'btn btn-sm btn-outline-primary'
        button.textContent = 'Edit'
        button.addEventListener('click', () => alert(`Edit ${item.firstName} (#${item.id})`))
        return button
      }
    }
  ],
  items,
  itemKey: item => String(item.id),
  columnPinning: { left: ['id'], right: ['actions'] },
  rowSelection: true,
  pagination: { pageSize: 10 }
})

Options

Option	Type	Default	Description
`columnPinning`	`boolean \| { left?: string[], right?: string[] }`	`false`	Freezes columns (by `key`) to the left/right edge. `true` enables the feature with no initial pins.

Pinning emits pinningChange.coreui.data-grid with the grid’s { columnPinning } state. Reordering via column ordering never crosses a pinning boundary.