@humanspeak/svelte-headless-table/dist/plugins/addHiddenColumns.js

A powerful, headless table library for Svelte that provides complete control over table UI while handling complex data operations like sorting, filtering, pagination, grouping, and row expansion. Build custom, accessible data tables with zero styling opin

import { derived, writable } from 'svelte/store';
/**
 * Creates a hidden columns plugin that enables showing/hiding table columns.
 *
 * @template Item - The type of data items in the table.
 * @param config - Configuration options.
 * @returns A TablePlugin that provides column visibility control.
 * @example
 * ```typescript
 * const table = createTable(data, {
 *   hide: addHiddenColumns({
 *     initialHiddenColumnIds: ['internalId', 'createdAt']
 *   })
 * })
 *
 * // Hide/show columns dynamically
 * const { hiddenColumnIds } = table.pluginStates.hide
 * hiddenColumnIds.update(ids => [...ids, 'newColumn'])
 * ```
 */
export const addHiddenColumns = ({ initialHiddenColumnIds = [] } = {}) => () => {
    const hiddenColumnIds = writable(initialHiddenColumnIds);
    const pluginState = { hiddenColumnIds };
    const deriveFlatColumns = (flatColumns) => {
        return derived([flatColumns, hiddenColumnIds], ([$flatColumns, $hiddenColumnIds]) => {
            if ($hiddenColumnIds.length === 0) {
                return $flatColumns;
            }
            return $flatColumns.filter((c) => !$hiddenColumnIds.includes(c.id));
        });
    };
    return {
        pluginState,
        deriveFlatColumns
    };
};