logo

addHiddenColumns

addHiddenColumns hides table columns dynamically.

Options

Information:
Options passed into addHiddenColumns.
const table = createTable(data, {
  hide: addHiddenColumns({ ... }),
});
const table = createTable(data, {
  hide: addHiddenColumns({ ... }),
});

initialHiddenColumnIds?: string[]

Initial hidden column ids.

Column Options

Information:
Options passed into column definitions.
const columns = table.createColumns([
  table.column({
    header: 'Name',
    accessor: 'name',
    plugins: {
      hide: { ... },
    },
  }),
]);
const columns = table.createColumns([
  table.column({
    header: 'Name',
    accessor: 'name',
    plugins: {
      hide: { ... },
    },
  }),
]);

Prop Set

Information:
Extensions to the view model. Subscribe to .props().
{#each $headerRows as headerRow (headerRow.id)}
  <Subscribe rowProps={headerRow.props()} let:rowProps>
    {rowProps.hide}
    {#each headerRow.cells as cell (cell.id)}
      <Subscribe props={cell.props()} let:props>
        {props.hide}
      </Subscribe>
    {/each}
  </Subscribe>
{/each}
{#each $headerRows as headerRow (headerRow.id)}
  <Subscribe rowProps={headerRow.props()} let:rowProps>
    {rowProps.hide}
    {#each headerRow.cells as cell (cell.id)}
      <Subscribe props={cell.props()} let:props>
        {props.hide}
      </Subscribe>
    {/each}
  </Subscribe>
{/each}

Plugin State

Information:
State provided by addHiddenColumns.
const { headerRows, rows, pluginStates } = table.createViewModel(columns);
const { ... } = pluginStates.hide;
const { headerRows, rows, pluginStates } = table.createViewModel(columns);
const { ... } = pluginStates.hide;

hiddenColumnIds: Writable<string[]>

Active hidden column ids.