Installation

Barrel

import { Table, TableBody, TableCell, TableCheckCell, TableCheckHead, TableFooter, TableHead, TableHeader, TableResizeHandle, TableRow } from 'kumo-svelte';

Granular

import { Table, TableBody, TableCell, TableCheckCell, TableCheckHead, TableFooter, TableHead, TableHeader, TableResizeHandle, TableRow } from 'kumo-svelte/components/table';

Usage

<script lang="ts">  import { LayerCard, Table } from 'kumo-svelte';</script><LayerCard class="p-0">  <Table>    <Table.Header>      <Table.Row>        <Table.Head>Name</Table.Head>        <Table.Head>Email</Table.Head>        <Table.Head>Role</Table.Head>      </Table.Row>    </Table.Header>    <Table.Body>      <Table.Row>        <Table.Cell>John Doe</Table.Cell>        <Table.Cell>john@example.com</Table.Cell>        <Table.Cell>Admin</Table.Cell>      </Table.Row>    </Table.Body>  </Table></LayerCard>

Examples

With Checkboxes

Add row selection with Table.CheckHead and Table.CheckCell. Both accept onCheckedChange, which matches the underlying Checkbox component's signature.

The older onValueChange prop still works but is deprecated and will be removed in a future major version. Migrate by renaming the prop:

<!-- Before (deprecated) --><Table.CheckCell onValueChange={(checked) => toggleRow(id)} /><!-- After --><Table.CheckCell onCheckedChange={(checked) => toggleRow(id)} />

Compact Header

Use variant="compact" on Table.Header for a more condensed header style.

Selected Row

Use variant="selected" on Table.Row to highlight selected rows.

Fixed Layout with Column Sizes

For precise control over column widths, set layout="fixed" and use colgroup with col elements.

Sticky Column

Pin a column to the left or right edge of the scroll container with sticky="left" or sticky="right" on Table.Head and Table.Cell. The component automatically adds an opaque background and gradient fade. Wrap the table in an overflow-x-auto container.

Compact Header with Sticky Column

Combining variant="compact" on Table.Header with sticky columns.

Full Example

Complete table with checkboxes, badges, action buttons, and fixed column widths.

API Reference

Table

Root table component. Renders a semantic <table> element.

PropTypeDefaultDescription
layout 'auto' | 'fixed'"auto"Table layout algorithm.
class string-Additional classes merged onto the root element.
children Snippet-Table section and row children.

Table.Header

Table header section. Renders <thead>. Set sticky to pin the header row to the top of the scroll container.

Table.Body

Table body section. Renders <tbody>.

Table.Row

Table row. Supports variant="selected" for highlighting.

PropTypeDefaultDescription
variant 'default' | 'selected'"default"Row visual state.

Table.Head

Header cell. Renders <th>. Accepts sticky="left" or sticky="right" to pin the column.

Table.Cell

Body cell. Renders <td>. Accepts sticky="left" or sticky="right" to pin the column.

Table.CheckHead

Header cell with checkbox for "select all" functionality.

PropTypeDefaultDescription
checked booleanfalseChecked state for the select-all checkbox.
indeterminate booleanfalseIndeterminate state for the select-all checkbox.
onCheckedChange (checked: boolean) => void-Called when the checkbox's checked state changes.
onValueChange (checked: boolean) => void-Deprecated. Use onCheckedChange instead.
label string-Accessible label for the checkbox.
disabled booleanfalseDisables the component.

Table.CheckCell

Body cell with checkbox for row selection.

PropTypeDefaultDescription
checked booleanfalseChecked state for the row checkbox.
indeterminate booleanfalseIndeterminate state for the row checkbox.
onCheckedChange (checked: boolean) => void-Called when the checkbox's checked state changes.
onValueChange (checked: boolean) => void-Deprecated. Use onCheckedChange instead.
label string-Accessible label for the checkbox.
disabled booleanfalseDisables the component.

Table.ResizeHandle

Draggable handle for column resizing. Use with TanStack Table or custom resize logic.

TanStack Table Integration

For advanced features like sorting, filtering, and resizable columns, integrate with TanStack Table. The Table component is designed to work with TanStack's headless API.

<script lang="ts">  import { Table } from 'kumo-svelte';</script><Table layout="fixed">  <colgroup>    {#each table.getAllColumns() as column}      <col style:width={`${column.getSize()}px`} />    {/each}  </colgroup>  <Table.Header>    {#each table.getHeaderGroups() as headerGroup}      <Table.Row>        {#each headerGroup.headers as header}          <Table.Head>            {flexRender(header.column.columnDef.header, header.getContext())}            <Table.ResizeHandle              onmousedown={header.getResizeHandler()}              ontouchstart={header.getResizeHandler()}            />          </Table.Head>        {/each}      </Table.Row>    {/each}  </Table.Header>  <Table.Body>    {#each table.getRowModel().rows as row}      <Table.Row>        {#each row.getVisibleCells() as cell}          <Table.Cell>            {flexRender(cell.column.columnDef.cell, cell.getContext())}          </Table.Cell>        {/each}      </Table.Row>    {/each}  </Table.Body></Table>

Accessibility

Semantic HTML

Table uses semantic <table>, <thead>, <tbody>, <th>, and <td> elements for proper screen reader navigation.

Checkbox Labels

Always provide aria-label for Table.CheckHead and Table.CheckCell to describe their purpose.

Keyboard Navigation

Tab moves focus through interactive elements. Checkboxes respond to Space.