Svelte Example: Column Visibility

Github StackBlitz CodeSandbox

<script lang="ts"> import { writable } from 'svelte/store' import { createSvelteTable, getCoreRowModel, getSortedRowModel, flexRender, } from '@tanstack/svelte-table' import type { ColumnDef, OnChangeFn, TableOptions, VisibilityState, } from '@tanstack/svelte-table' import './index.css' type Person = { firstName: string lastName: string age: number visits: number status: string progress: number } const defaultData: Person[] = [ { firstName: 'tanner', lastName: 'linsley', age: 24, visits: 100, status: 'In Relationship', progress: 50, }, { firstName: 'tandy', lastName: 'miller', age: 40, visits: 40, status: 'Single', progress: 80, }, { firstName: 'joe', lastName: 'dirte', age: 45, visits: 20, status: 'Complicated', progress: 10, }, ] const columns: ColumnDef<Person>[] = [ { header: 'Name', footer: props => props.column.id, columns: [ { accessorKey: 'firstName', cell: info => info.getValue(), footer: props => props.column.id, }, { accessorFn: row => row.lastName, id: 'lastName', cell: info => info.getValue(), header: () => 'Last Name', footer: props => props.column.id, }, ], }, { header: 'Info', footer: props => props.column.id, columns: [ { accessorKey: 'age', header: () => 'Age', footer: props => props.column.id, }, { header: 'More Info', columns: [ { accessorKey: 'visits', header: () => 'Visits', footer: props => props.column.id, }, { accessorKey: 'status', header: 'Status', footer: props => props.column.id, }, { accessorKey: 'progress', header: 'Profile Progress', footer: props => props.column.id, }, ], }, ], }, ] let columnVisibility: VisibilityState = {} const setColumnVisibility: OnChangeFn<VisibilityState> = updater => { if (updater instanceof Function) { columnVisibility = updater(columnVisibility) } else { columnVisibility = updater } options.update(old => ({ ...old, state: { ...old.state, columnVisibility, }, })) } const options = writable<TableOptions<Person>>({ data: defaultData, columns, state: { columnVisibility, }, onColumnVisibilityChange: setColumnVisibility, getCoreRowModel: getCoreRowModel(), getSortedRowModel: getSortedRowModel(), debugTable: true, }) const rerender = () => { options.update(options => ({ ...options, data: defaultData, })) } const table = createSvelteTable(options) </script> <div class="p-2"> <div class="inline-block border border-black shadow rounded"> <div class="px-1 border-b border-black"> <label> <input checked={$table.getIsAllColumnsVisible()} on:change={e => { console.info($table.getToggleAllColumnsVisibilityHandler()(e)) }} type="checkbox" />{' '} Toggle All </label> </div> {#each $table.getAllLeafColumns() as column} <div class="px-1"> <label> <input checked={column.getIsVisible()} on:change={column.getToggleVisibilityHandler()} type="checkbox" />{' '} {column.id} </label> </div> {/each} </div> <div class="h-4" /> <table> <thead> {#each $table.getHeaderGroups() as headerGroup} <tr> {#each headerGroup.headers as header} <th colSpan={header.colSpan}> {#if !header.isPlaceholder} <svelte:component this={flexRender( header.column.columnDef.header, header.getContext() )} /> {/if} </th> {/each} </tr> {/each} </thead> <tbody> {#each $table.getCoreRowModel().rows.slice(0, 20) as row} <tr> {#each row.getVisibleCells() as cell} <td> <svelte:component this={flexRender(cell.column.columnDef.cell, cell.getContext())} /> </td> {/each} </tr> {/each} </tbody> <tfoot> {#each $table.getFooterGroups() as footerGroup} <tr> {#each footerGroup.headers as header} <th colSpan={header.colSpan}> {#if !header.isPlaceholder} <svelte:component this={flexRender( header.column.columnDef.footer, header.getContext() )} /> {/if} </th> {/each} </tr> {/each} </tfoot> </table> <div class="h-4" /> <button on:click={() => rerender()} class="border p-2"> Rerender </button> <div class="h-4" /> <pre>{JSON.stringify($table.getState().columnVisibility, null, 2)}</pre> </div> 

<script lang="ts"> import { writable } from 'svelte/store' import { createSvelteTable, getCoreRowModel, getSortedRowModel, flexRender, } from '@tanstack/svelte-table' import type { ColumnDef, OnChangeFn, TableOptions, VisibilityState, } from '@tanstack/svelte-table' import './index.css' type Person = { firstName: string lastName: string age: number visits: number status: string progress: number } const defaultData: Person[] = [ { firstName: 'tanner', lastName: 'linsley', age: 24, visits: 100, status: 'In Relationship', progress: 50, }, { firstName: 'tandy', lastName: 'miller', age: 40, visits: 40, status: 'Single', progress: 80, }, { firstName: 'joe', lastName: 'dirte', age: 45, visits: 20, status: 'Complicated', progress: 10, }, ] const columns: ColumnDef<Person>[] = [ { header: 'Name', footer: props => props.column.id, columns: [ { accessorKey: 'firstName', cell: info => info.getValue(), footer: props => props.column.id, }, { accessorFn: row => row.lastName, id: 'lastName', cell: info => info.getValue(), header: () => 'Last Name', footer: props => props.column.id, }, ], }, { header: 'Info', footer: props => props.column.id, columns: [ { accessorKey: 'age', header: () => 'Age', footer: props => props.column.id, }, { header: 'More Info', columns: [ { accessorKey: 'visits', header: () => 'Visits', footer: props => props.column.id, }, { accessorKey: 'status', header: 'Status', footer: props => props.column.id, }, { accessorKey: 'progress', header: 'Profile Progress', footer: props => props.column.id, }, ], }, ], }, ] let columnVisibility: VisibilityState = {} const setColumnVisibility: OnChangeFn<VisibilityState> = updater => { if (updater instanceof Function) { columnVisibility = updater(columnVisibility) } else { columnVisibility = updater } options.update(old => ({ ...old, state: { ...old.state, columnVisibility, }, })) } const options = writable<TableOptions<Person>>({ data: defaultData, columns, state: { columnVisibility, }, onColumnVisibilityChange: setColumnVisibility, getCoreRowModel: getCoreRowModel(), getSortedRowModel: getSortedRowModel(), debugTable: true, }) const rerender = () => { options.update(options => ({ ...options, data: defaultData, })) } const table = createSvelteTable(options) </script> <div class="p-2"> <div class="inline-block border border-black shadow rounded"> <div class="px-1 border-b border-black"> <label> <input checked={$table.getIsAllColumnsVisible()} on:change={e => { console.info($table.getToggleAllColumnsVisibilityHandler()(e)) }} type="checkbox" />{' '} Toggle All </label> </div> {#each $table.getAllLeafColumns() as column} <div class="px-1"> <label> <input checked={column.getIsVisible()} on:change={column.getToggleVisibilityHandler()} type="checkbox" />{' '} {column.id} </label> </div> {/each} </div> <div class="h-4" /> <table> <thead> {#each $table.getHeaderGroups() as headerGroup} <tr> {#each headerGroup.headers as header} <th colSpan={header.colSpan}> {#if !header.isPlaceholder} <svelte:component this={flexRender( header.column.columnDef.header, header.getContext() )} /> {/if} </th> {/each} </tr> {/each} </thead> <tbody> {#each $table.getCoreRowModel().rows.slice(0, 20) as row} <tr> {#each row.getVisibleCells() as cell} <td> <svelte:component this={flexRender(cell.column.columnDef.cell, cell.getContext())} /> </td> {/each} </tr> {/each} </tbody> <tfoot> {#each $table.getFooterGroups() as footerGroup} <tr> {#each footerGroup.headers as header} <th colSpan={header.colSpan}> {#if !header.isPlaceholder} <svelte:component this={flexRender( header.column.columnDef.footer, header.getContext() )} /> {/if} </th> {/each} </tr> {/each} </tfoot> </table> <div class="h-4" /> <button on:click={() => rerender()} class="border p-2"> Rerender </button> <div class="h-4" /> <pre>{JSON.stringify($table.getState().columnVisibility, null, 2)}</pre> </div>