@humanspeak/svelte-headless-table/dist/bodyCells.d.ts

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 type { BodyRow } from './bodyRows.js';
import type { DataColumn, DisplayColumn, FlatColumn } from './columns.js';
import { TableComponent } from './tableComponent.js';
import type { DataLabel, DisplayLabel } from './types/Label.js';
import type { AnyPlugins } from './types/TablePlugin.js';
import type { RenderConfig } from '@humanspeak/svelte-render';
import { type Readable } from 'svelte/store';
/**
 * Initialization options for creating a BodyCell.
 *
 * @template Item - The type of data items in the table.
 * @template Plugins - The plugins used by the table.
 */
export type BodyCellInit<Item, Plugins extends AnyPlugins = AnyPlugins> = {
    id: string;
    row: BodyRow<Item, Plugins>;
};
/**
 * HTML attributes for a body cell element.
 *
 * @template Item - The type of data items in the table.
 * @template Plugins - The plugins used by the table.
 */
export type BodyCellAttributes<Item, Plugins extends AnyPlugins = AnyPlugins> = {
    role: 'cell';
};
/**
 * Abstract base class representing a cell in the table body.
 * Extended by DataBodyCell for data cells and DisplayBodyCell for display-only cells.
 *
 * @template Item - The type of data items in the table.
 * @template Plugins - The plugins used by the table.
 */
export declare abstract class BodyCell<Item, Plugins extends AnyPlugins = AnyPlugins> extends TableComponent<Item, Plugins, 'tbody.tr.td'> {
    abstract column: FlatColumn<Item, Plugins>;
    row: BodyRow<Item, Plugins>;
    constructor({ id, row }: BodyCellInit<Item, Plugins>);
    abstract render(): RenderConfig;
    attrs(): Readable<BodyCellAttributes<Item, Plugins>>;
    abstract clone(): BodyCell<Item, Plugins>;
    /**
     * Gets a unique identifier combining the row ID and column ID.
     *
     * @returns A string in the format "rowId:columnId".
     */
    rowColId(): string;
    /**
     * Gets a unique identifier combining the data row ID and column ID.
     * Only available for cells in data rows.
     *
     * @returns A string in the format "dataId:columnId", or undefined if not a data row.
     */
    dataRowColId(): string | undefined;
    /**
     * Type guard to check if this cell is a data cell.
     *
     * @returns True if this is a DataBodyCell.
     */
    isData(): this is DataBodyCell<Item, Plugins>;
    /**
     * Type guard to check if this cell is a display cell.
     *
     * @returns True if this is a DisplayBodyCell.
     */
    isDisplay(): this is DisplayBodyCell<Item, Plugins>;
}
/**
 * Initialization options for creating a DataBodyCell.
 *
 * @template Item - The type of data items in the table.
 * @template Plugins - The plugins used by the table.
 * @template Value - The type of the cell value.
 */
export type DataBodyCellInit<Item, Plugins extends AnyPlugins = AnyPlugins, Value = unknown> = Omit<BodyCellInit<Item, Plugins>, 'id'> & {
    /** The data column this cell belongs to. */
    column: DataColumn<Item, Plugins>;
    /** Optional custom label renderer for the cell. */
    label?: DataLabel<Item, Plugins, Value>;
    /** The cell's value. */
    value: Value;
};
/**
 * HTML attributes for a data body cell element.
 *
 * @template Item - The type of data items in the table.
 * @template Plugins - The plugins used by the table.
 */
export type DataBodyCellAttributes<Item, Plugins extends AnyPlugins = AnyPlugins> = BodyCellAttributes<Item, Plugins>;
/**
 * A body cell that contains actual data from the data source.
 * Provides access to the cell value and custom rendering.
 *
 * @template Item - The type of data items in the table.
 * @template Plugins - The plugins used by the table.
 * @template Value - The type of the cell value.
 */
export declare class DataBodyCell<Item, Plugins extends AnyPlugins = AnyPlugins, Value = unknown> extends BodyCell<Item, Plugins> {
    __data: boolean;
    /** The data column this cell belongs to. */
    column: DataColumn<Item, Plugins>;
    /** Optional custom label renderer for the cell. */
    label?: DataLabel<Item, Plugins, Value>;
    /** The cell's value. */
    value: Value;
    /**
     * Creates a new DataBodyCell.
     *
     * @param init - Initialization options.
     */
    constructor({ row, column, label, value }: DataBodyCellInit<Item, Plugins, Value>);
    /**
     * Renders the cell content using the label function or the raw value.
     *
     * @returns The render configuration for displaying this cell.
     * @throws Error if state reference is missing when using a custom label.
     */
    render(): RenderConfig;
    /**
     * Creates a copy of this cell.
     *
     * @returns A cloned DataBodyCell.
     */
    clone(): DataBodyCell<Item, Plugins>;
}
/**
 * Initialization options for creating a DisplayBodyCell.
 *
 * @template Item - The type of data items in the table.
 * @template Plugins - The plugins used by the table.
 */
export type DisplayBodyCellInit<Item, Plugins extends AnyPlugins = AnyPlugins> = Omit<BodyCellInit<Item, Plugins>, 'id'> & {
    /** The display column this cell belongs to. */
    column: DisplayColumn<Item, Plugins>;
    /** The label renderer for the cell. */
    label: DisplayLabel<Item, Plugins>;
};
/**
 * A body cell used for display purposes only (e.g., action buttons, checkboxes).
 * Does not contain direct data from the data source.
 *
 * @template Item - The type of data items in the table.
 * @template Plugins - The plugins used by the table.
 */
export declare class DisplayBodyCell<Item, Plugins extends AnyPlugins = AnyPlugins> extends BodyCell<Item, Plugins> {
    __display: boolean;
    /** The display column this cell belongs to. */
    column: DisplayColumn<Item, Plugins>;
    /** The label renderer for the cell. */
    label: DisplayLabel<Item, Plugins>;
    /**
     * Creates a new DisplayBodyCell.
     *
     * @param init - Initialization options.
     */
    constructor({ row, column, label }: DisplayBodyCellInit<Item, Plugins>);
    /**
     * Renders the cell content using the label function.
     *
     * @returns The render configuration for displaying this cell.
     * @throws Error if state reference is missing.
     */
    render(): RenderConfig;
    /**
     * Creates a copy of this cell.
     *
     * @returns A cloned DisplayBodyCell.
     */
    clone(): DisplayBodyCell<Item, Plugins>;
}