---
title: "Data Table"
description: "Filter, sort, select and paginate project budgets."
---

# Data Table

Filter, sort, select and paginate project budgets.

## Installation

Install the shared package once in your Exact app. This version is a beta.

```sh
bun add --exact @rightui/ui@0.4.0-beta.4
```

Or choose another package manager:

```sh
npm install --save-exact @rightui/ui@0.4.0-beta.4
pnpm add --save-exact @rightui/ui@0.4.0-beta.4
yarn add --exact @rightui/ui@0.4.0-beta.4
```

Exact compilation uses Bun 1.4.2. Register Geist and Newsreader, declare the font marker and add the root provider using [Installation](/docs/installation).

### Manual source setup

Install an editable copy of the complete package:

```sh
mkdir -p vendor/rightui vendor/rightui-ui
npm pack @rightui/ui@0.4.0-beta.4 --pack-destination vendor/rightui
tar -xzf ./vendor/rightui/rightui-ui-0.4.0-beta.4.tgz -C vendor/rightui-ui --strip-components=1
bun add file:./vendor/rightui-ui
```

Keep package.json, the Contract files, ui.tamber, assets and licenses together.

### Import

```contract
use DataTable, GridColumn, GridRow, DataGrid from "@rightui/ui"
```

## Usage

Import DataTable, GridColumn from @rightui/ui. Store its value in state and update it through the provided action callback.

## Example

```contract
use GridColumn, GridRow, DataGrid from "@rightui/ui"

component Demo
  props
    width: number
    reduced: bool
  derive narrow = width < 600
  action setSelection(value: string[])
    selected = value
  action openRow(value: string)
    opened = value
  state selected: string[] = []
  state opened = ""
  view
    column gap="ui.space-16" min-width=0 max-width="100%"
      DataGrid(id="advanced-grid", label="Project budgets", columns=[GridColumn(id="name", label="Project", kind="text", align="left", sortable=true, searchable=true), GridColumn(id="status", label="Status", kind="badge", align="left", sortable=true, searchable=true), GridColumn(id="budget", label="Budget", kind="currency", align="right", sortable=true, searchable=false)], rows=[GridRow(id="g1", values=["Atlas", "Active", "12"]), GridRow(id="g2", values=["Boreal", "Pending", "110"]), GridRow(id="g3", values=["Cedar", "Active", "3"]), GridRow(id="g4", values=["Dune", "Pending", "47"]), GridRow(id="g5", values=["Ember", "Active", "90"]), GridRow(id="g6", values=["Fjord", "Done", "28"]), GridRow(id="g7", values=["Grove", "Done", "64"]), GridRow(id="g8", values=["Harbor", "Pending", "36"])], initialPageSize=5, reduced=reduced, selectionChanged=setSelection, openRow=openRow)

```

## API Reference

| Property | Type |
| --- | --- |
| DataGrid.id | string |
| DataGrid.label | string |
| DataGrid.columns | GridColumn[] |
| DataGrid.rows | GridRow[] |
| DataGrid.initialPageSize | number |
| DataGrid.reduced | bool |
| DataGrid.selectionChanged | action |
| DataGrid.openRow | action |
| DataTable.id | string |
| DataTable.rows | DataRow[] |
| DataTable.pageSize | number |

## Source

File: packages/ui/data-table.contract

```contract
use FontWeights from "./typography-context.contract"
use uiFontFamily from "./typography-context.contract"
use Button from "./button.contract"
use Control, Field from "./styles.contract"
shape DataRow
  id: string
  status: string
  email: string
  amount: number
component DataTable
  props
    id: string
    rows: DataRow[]
    pageSize: number
  inject
    uiWeights: FontWeights
    uiFont: string
  state query = ""
  state sort = "email"
  state descending = false
  state page = 0
  state selected: string[] = []
  derive filtered = rows.filter(r => r.email.toLowerCase().includes(query.toLowerCase()) or r.status.toLowerCase().includes(query.toLowerCase()))
  derive ordered = sort == "amount" ? (descending ? sortBy(filtered, r => r.amount, "desc") : sortBy(filtered, r => r.amount)) : sort == "status" ? (descending ? sortBy(filtered, r => r.status, "desc") : sortBy(filtered, r => r.status)) : (descending ? sortBy(filtered, r => r.email, "desc") : sortBy(filtered, r => r.email))
  derive size = max(1, floor(pageSize))
  derive count = max(1, ceil(filtered.length / size))
  derive currentPage = min(page, count - 1)
  derive visible = ordered.slice(currentPage * size, (currentPage + 1) * size)
  action search(v: string)
    query = v
    page = 0
  action order(v: string)
    descending = sort == v ? not descending : false
    sort = v
    page = 0
  action pick(rowId: string, checked: bool)
    selected = checked ? selected.concat([rowId]) : selected.filter(s => s != rowId)
  action pickAll(checked: bool)
    selected = checked ? selected.filter(s => not visible.map(r => r.id).includes(s)).concat(visible.map(r => r.id)) : selected.filter(s => not visible.map(r => r.id).includes(s))
  action previous
    page = max(0, currentPage - 1)
  action next
    page = min(count - 1, currentPage + 1)
  view
    column id=id testId=id gap="ui.space-16" min-width="0px" color="ui.foreground"
      input id=(id + "-search") testId=(id + "-search") class=Field font-weight=uiWeights.regular value=query input=search placeholder="Filter emails or status..." aria-label="Filter payments" max-width="20rem" font-family=uiFontFamily(uiFont) data-rightui-font="body"
      scroll max-height=480 overflow="auto" border-width="ui.border-width" border-style="solid" border-color="ui.border" border-radius="ui.radius-control" min-width="0px"
        table width="100%" border-spacing=0 font-size="ui.text-sm"
          thead
            tr border-bottom-width="ui.border-width" border-bottom-style="solid" border-bottom-color="ui.border"
              th border-bottom-width="ui.border-width" border-bottom-style="solid" border-bottom-color="ui.border" scope="col" padding="0px ui.space-12" width="ui.space-44"
                DataTableCheck(id=id + "-all", label="Select page", checked=visible.length > 0 and visible.filter(r => selected.includes(r.id)).length == visible.length, disabled=visible.length == 0, change=pickAll)
              for col in ["status", "email", "amount"] key=col
                th border-bottom-width="ui.border-width" border-bottom-style="solid" border-bottom-color="ui.border" scope="col" padding="ui.space-8 ui.space-12" text-align=(col == "amount" ? "right" : "left") aria-sort=(sort == col ? (descending ? "descending" : "ascending") : "none")
                  button class=Control font-weight=uiWeights.medium id=(id + "-sort-" + col) testId=(id + "-sort-" + col) press=order(col) padding="ui.space-4 ui.space-8" border="0" background-color="transparent" color="ui.muted-foreground" min-height="ui.space-32"
                    text ((col == "status" ? "Status" : col == "email" ? "Email" : "Amount") + (sort == col ? (descending ? " ↓" : " ↑") : "")) font-family=uiFontFamily(uiFont) data-rightui-font="body"
          tbody
            for r in visible key=r.id
              tr testId=(id + "-row-" + r.id) border-bottom-width="ui.border-width" border-bottom-style="solid" border-bottom-color="ui.border" background-color=(selected.includes(r.id) ? "ui.muted" : "transparent")
                td border-bottom-width="ui.border-width" border-bottom-style="solid" border-bottom-color="ui.border" padding="ui.space-4 ui.space-12"
                  DataTableCheck(id=id + "-select-" + r.id, label="Select " + r.email, checked=selected.includes(r.id), disabled=false, change=pick(r.id))
                td border-bottom-width="ui.border-width" border-bottom-style="solid" border-bottom-color="ui.border" padding="ui.space-12" text-transform="capitalize"
                  text r.status font-family=uiFontFamily(uiFont) data-rightui-font="body"
                td border-bottom-width="ui.border-width" border-bottom-style="solid" border-bottom-color="ui.border" padding="ui.space-12"
                  text r.email font-family=uiFontFamily(uiFont) data-rightui-font="body"
                td border-bottom-width="ui.border-width" border-bottom-style="solid" border-bottom-color="ui.border" padding="ui.space-12" text-align="right" font-weight=uiWeights.medium
                  text ("$" + r.amount.toFixed(2)) font-family=uiFontFamily(uiFont) data-rightui-font="body"
            if visible.length == 0
              tr
                td colspan=4 padding="ui.space-32" text-align="center"
                  text "No results." testId=(id + "-empty") font-family=uiFontFamily(uiFont) data-rightui-font="body"
      row align-items="center" justify-content="space-between" gap="ui.space-12" flex-wrap="wrap"
        text (selected.filter(s => rows.map(r => r.id).includes(s)).length.toString() + " of " + rows.length.toString() + " row(s) selected.") testId=(id + "-selection") font-size="ui.text-sm" color="ui.muted-foreground" font-family=uiFontFamily(uiFont) data-rightui-font="body"
        row gap="ui.space-8" align-items="center"
          text ("Page " + (currentPage + 1).toString() + " of " + count.toString()) testId=(id + "-page") font-size="ui.text-sm" color="ui.muted-foreground" font-family=uiFontFamily(uiFont) data-rightui-font="body"
          Button(id=id + "-previous", label="Previous", variant="outline", disabled=currentPage == 0, press=previous)
          Button(id=id + "-next", label="Next", variant="outline", disabled=currentPage >= count - 1, press=next)

component DataTableCheck
  props
    id: string
    label: string
    checked: bool
    disabled: bool
    change: action
  action toggle
    if not disabled
      change(not checked)
  inject
    uiWeights: FontWeights
  view
    button id=id testId=id class=Control font-weight=uiWeights.medium press=toggle role="checkbox" aria-checked=checked aria-label=label disabled=disabled
      width="ui.space-32" min-height="ui.space-32" height="ui.space-32" padding="ui.space-8" border="0" background-color="transparent" display="flex" align-items="center" justify-content="center"
      view width="ui.space-16" height="ui.space-16" border-radius="ui.radius-checkbox" border-width="ui.border-width" border-style="solid" border-color="ui.border" background-color=(checked ? "ui.primary" : "ui.surface") display="flex" align-items="center" justify-content="center" aria-hidden=true
        if checked
          svg width="ui.space-12" height="ui.space-12" viewBox="0 0 24 24" fill="none" stroke="ui.primary-foreground" stroke-width="ui.stroke-strong"
            path d="m5 12 4 4L19 6"

```
