Row Pinning (Angular) Guide

Examples

Want to skip to the implementation? Check out these Angular examples:

Row Pinning

Angular Setup

import { signal } from '@angular/core'
import { injectTable, tableFeatures, rowPinningFeature } from '@tanstack/angular-table'

const features = tableFeatures({ rowPinningFeature })

export class App {
  readonly data = signal(defaultData)

  readonly table = injectTable(() => ({
    features,
    columns,
    data: this.data(),
  }))
}

import { signal } from '@angular/core'
import { injectTable, tableFeatures, rowPinningFeature } from '@tanstack/angular-table'

const features = tableFeatures({ rowPinningFeature })

export class App {
  readonly data = signal(defaultData)

  readonly table = injectTable(() => ({
    features,
    columns,
    data: this.data(),
  }))
}

Row pinning lets you keep selected rows in top or bottom row regions while the rest of the rows render in the center region.

There are 2 table features that can reorder rows, which happen in the following order:

Row Pinning - If pinning, rows are split into top, center (unpinned), and bottom pinned rows.
Sorting

Enable Row Pinning

To use row pinning, add rowPinningFeature to your features. Row pinning does not require a row model factory.

import {
  rowPinningFeature,
  tableFeatures,
  injectTable,
} from '@tanstack/angular-table'

const features = tableFeatures({ rowPinningFeature })

readonly table = injectTable(() => ({
  features,
  columns,
  data,
}))

import {
  rowPinningFeature,
  tableFeatures,
  injectTable,
} from '@tanstack/angular-table'

const features = tableFeatures({ rowPinningFeature })

readonly table = injectTable(() => ({
  features,
  columns,
  data,
}))

Row Pinning State

The rowPinning state stores row IDs in top and bottom arrays:

type RowPinningState = {
  top: string[]
  bottom: string[]
}

type RowPinningState = {
  top: string[]
  bottom: string[]
}

You can pin rows by default with initialState.rowPinning:

readonly table = injectTable(() => ({
  features,
  columns,
  data,
  initialState: {
    rowPinning: {
      top: ['0'],
      bottom: ['3'],
    },
  },
}))

readonly table = injectTable(() => ({
  features,
  columns,
  data,
  initialState: {
    rowPinning: {
      top: ['0'],
      bottom: ['3'],
    },
  },
}))

If you need to manage row pinning outside of the table instance, the recommended v9 approach is an external atom (created with createAtom from @tanstack/angular-store) passed to the table's atoms option. External atoms give you fine-grained subscriptions anywhere in your app, and other code can read or write the pinning state without re-running the injectTable options initializer on every change.

import { createAtom } from '@tanstack/angular-store'
import type { RowPinningState } from '@tanstack/angular-table'

export class App {
  readonly rowPinningAtom = createAtom<RowPinningState>({
    top: [],
    bottom: [],
  })

  readonly table = injectTable(() => ({
    features,
    columns,
    data: this.data(),
    atoms: {
      rowPinning: this.rowPinningAtom,
    },
  }))

  // read this.rowPinningAtom.get() wherever you need the value
}

import { createAtom } from '@tanstack/angular-store'
import type { RowPinningState } from '@tanstack/angular-table'

export class App {
  readonly rowPinningAtom = createAtom<RowPinningState>({
    top: [],
    bottom: [],
  })

  readonly table = injectTable(() => ({
    features,
    columns,
    data: this.data(),
    atoms: {
      rowPinning: this.rowPinningAtom,
    },
  }))

  // read this.rowPinningAtom.get() wherever you need the value
}

Alternatively, the v8-style state.rowPinning plus onRowPinningChange pattern is still supported. In Angular this means owning the slice with an Angular signal. It can be convenient for simple integrations or when migrating v8 code, but it is less fine-grained than external atoms. See the Table State Guide for a deeper comparison.

readonly rowPinning = signal<RowPinningState>({
  top: [],
  bottom: [],
})

readonly table = injectTable(() => ({
  features,
  columns,
  data,
  state: {
    rowPinning: this.rowPinning(),
  },
  onRowPinningChange: (updater) =>
    typeof updater === 'function'
      ? this.rowPinning.update(updater)
      : this.rowPinning.set(updater),
}))

readonly rowPinning = signal<RowPinningState>({
  top: [],
  bottom: [],
})

readonly table = injectTable(() => ({
  features,
  columns,
  data,
  state: {
    rowPinning: this.rowPinning(),
  },
  onRowPinningChange: (updater) =>
    typeof updater === 'function'
      ? this.rowPinning.update(updater)
      : this.rowPinning.set(updater),
}))

Use table.setRowPinning to update the state directly, and table.resetRowPinning to reset it to initialState.rowPinning. Pass true to resetRowPinning to clear both pinned row arrays.

table.setRowPinning({
  top: ['0', '2'],
  bottom: ['8'],
})

table.resetRowPinning()
table.resetRowPinning(true)

table.setRowPinning({
  top: ['0', '2'],
  bottom: ['8'],
})

table.resetRowPinning()
table.resetRowPinning(true)

Pin Rows With Row APIs

Each row exposes APIs for checking whether it can be pinned, reading its pinned position, and changing its pinned position.

row.getCanPin()
row.getIsPinned() // 'top', 'bottom', or false
row.getPinnedIndex()

row.pin('top')
row.pin('bottom')
row.pin(false)

row.getCanPin()
row.getIsPinned() // 'top', 'bottom', or false
row.getPinnedIndex()

row.pin('top')
row.pin('bottom')
row.pin(false)

You can use these APIs to build pinning controls:

html

@if (row.getCanPin()) {
  <div>
    <button type="button" (click)="row.pin('top')" [disabled]="row.getIsPinned() === 'top'">
      Top
    </button>
    <button type="button" (click)="row.pin(false)" [disabled]="!row.getIsPinned()">
      Center
    </button>
    <button type="button" (click)="row.pin('bottom')" [disabled]="row.getIsPinned() === 'bottom'">
      Bottom
    </button>
  </div>
}

@if (row.getCanPin()) {
  <div>
    <button type="button" (click)="row.pin('top')" [disabled]="row.getIsPinned() === 'top'">
      Top
    </button>
    <button type="button" (click)="row.pin(false)" [disabled]="!row.getIsPinned()">
      Center
    </button>
    <button type="button" (click)="row.pin('bottom')" [disabled]="row.getIsPinned() === 'bottom'">
      Bottom
    </button>
  </div>
}

The row.pin API also accepts includeLeafRows and includeParentRows flags. These can be useful when pinning grouped or expanded rows and deciding whether related parent or leaf rows should move with the row.

Row Pinning Table APIs

Row pinning splits the current row model into 3 row lists:

table.getTopRows()
table.getCenterRows()
table.getBottomRows()

table.getTopRows()
table.getCenterRows()
table.getBottomRows()

If you render pinned rows in separate table sections, use those APIs directly:

html

<tbody>
  @for (row of table.getTopRows(); track row.id) {
    <tr class="pinned"><!-- render pinned row --></tr>
  }
  @for (row of table.getCenterRows(); track row.id) {
    <tr><!-- render center row --></tr>
  }
  @for (row of table.getBottomRows(); track row.id) {
    <tr class="pinned"><!-- render pinned row --></tr>
  }
</tbody>

<tbody>
  @for (row of table.getTopRows(); track row.id) {
    <tr class="pinned"><!-- render pinned row --></tr>
  }
  @for (row of table.getCenterRows(); track row.id) {
    <tr><!-- render center row --></tr>
  }
  @for (row of table.getBottomRows(); track row.id) {
    <tr class="pinned"><!-- render pinned row --></tr>
  }
</tbody>

Use table.getIsSomeRowsPinned() to check whether any rows are pinned, or pass a position to check a specific pinned region.

table.getIsSomeRowsPinned()
table.getIsSomeRowsPinned('top')
table.getIsSomeRowsPinned('bottom')

table.getIsSomeRowsPinned()
table.getIsSomeRowsPinned('top')
table.getIsSomeRowsPinned('bottom')

Disable Row Pinning

By default, all rows can be pinned. You can disable row pinning for the whole table or decide per row with enableRowPinning.

readonly table = injectTable(() => ({
  features,
  columns,
  data,
  enableRowPinning: row => row.original.status !== 'archived',
}))

readonly table = injectTable(() => ({
  features,
  columns,
  data,
  enableRowPinning: row => row.original.status !== 'archived',
}))

Keep Pinned Rows

By default, keepPinnedRows is true, so pinned rows stay visible in their pinned region even when they would otherwise be filtered or paginated out of the center rows.

Set keepPinnedRows to false if pinned rows should only render when they are present in the current filtered and paginated row model.

readonly table = injectTable(() => ({
  features,
  columns,
  data,
  keepPinnedRows: false,
}))

readonly table = injectTable(() => ({
  features,
  columns,
  data,
  keepPinnedRows: false,
}))

Row Pinning (Angular) Guide

Examples#

Angular Setup#