Documentation navigation

Published API · 0.1.0-rc.1

themes · components/data-table

Published themes API declarations for components/data-table.

./components/data-table

@wsagency/wseffect-themes · MIT · source · MIT license · WS-AGENCY-NOTICE

This entry point is published in @wsagency/wseffect-themes@0.1.0-rc.1. Import it from the package subpath shown below; the signatures and documentation are read from the installed package declarations.

import * as Wseffect from '@wsagency/wseffect-themes/components/data-table'

Exported declarations

Column

export type Column<Row> = Readonly<{
    id: string;
    header: Html;
    accessor: (row: Row) => string;
    render?: (row: Row) => Html;
    isSortable: boolean;
    width?: string;
    minWidth?: string;
    align?: 'start' | 'center' | 'end';
    isVisible?: boolean;
    searchText?: (row: Row) => string;
}>;

Config

export type Config<Row> = Readonly<{
    id: string;
    rows: ReadonlyArray<Row>;
    getRowId: (row: Row) => string;
    columns: ReadonlyArray<Column<Row>>;
    caption: Html;
    selectedRowIds: ReadonlySet<string>;
    isGrid: boolean;
    /** Whether to render the row-selection column. Defaults to true. */
    showSelection?: boolean;
    /** Applies the shared Table size and variant styling to the table root. */
    tableStyle?: Readonly<{
        size: '1' | '2' | '3';
        variant: 'surface' | 'ghost';
    }>;
    /**
     * Fixed pixel height for each virtualized data row. Cell content is kept to one line and truncated with an ellipsis.
     */
    rowHeight: number;
    /** Initial virtual viewport height in pixels, before the browser measures it. */
    viewportHeight?: number;
    overscanRows: number;
}>;

init

export declare function init<Row>(config: Config<Row>): Model;

Message

export type Message = typeof Message.Type;

Message

Message: import("@wsagency/wseffect-foldkit/message").MessageUnion<{
    readonly RowsChanged: {};
    readonly FilterChanged: {
        value: Schema.String;
    };
    readonly SortChanged: {
        columnId: Schema.String;
    };
    readonly ToggleRow: {
        rowId: Schema.String;
    };
    readonly SelectVisible: {
        selected: Schema.Boolean;
    };
    readonly ActiveCellChanged: {
        rowId: Schema.String;
        columnId: Schema.String;
    };
    readonly GridKey: {
        key: Schema.String;
        ctrlKey: Schema.Boolean;
    };
    readonly VirtualList: {
        message: import("@wsagency/wseffect-foldkit/message").MessageUnion<{
            readonly ObservedContainerScroll: {
                scrollTop: Schema.Number;
                scrollHeight: Schema.Number;
                containerHeight: Schema.Number;
                anchor: import("@wsagency/wseffect-foldkit/schema").TaggedUnion<{
                    readonly None: {};
                    readonly Row: {
                        key: Schema.String;
                        index: Schema.Number;
                        viewportOffset: Schema.Number;
                    };
                }>;
            };
            readonly ResizedContainer: {
                containerWidth: Schema.Number;
                containerHeight: Schema.Number;
                leadingOffsetPx: Schema.optional<Schema.Number>;
            };
            readonly MeasuredRows: {
                measurements: Schema.$Array<Schema.Struct<{
                    readonly key: Schema.String;
                    readonly height: Schema.Number;
                    readonly layoutVersion: Schema.Number;
                }>>;
            };
            readonly CompletedApplyScroll: {
                version: Schema.Number;
                outcome: import("@wsagency/wseffect-foldkit/schema").TaggedUnion<{
                    readonly Applied: {
                        scrollTop: Schema.Number;
                        scrollHeight: Schema.Number;
                        containerHeight: Schema.Number;
                        anchor: import("@wsagency/wseffect-foldkit/schema").TaggedUnion<{
                            readonly None: {};
                            readonly Row: {
                                key: Schema.String;
                                index: Schema.Number;
                                viewportOffset: Schema.Number;
                            };
                        }>;
                    };
                    readonly Skipped: {};
                }>;
            };
        }>;
    };
    readonly FocusTargetCompleted: {
        rowId: Schema.String;
        columnId: Schema.String;
        scrollTop: Schema.Number;
        scrollHeight: Schema.Number;
        containerHeight: Schema.Number;
        anchor: Schema.Union<readonly [Schema.Struct<{
            readonly _tag: Schema.Literal<"None">;
        }>, Schema.Struct<{
            readonly _tag: Schema.Literal<"Row">;
            readonly key: Schema.String;
            readonly index: Schema.Number;
            readonly viewportOffset: Schema.Number;
        }>]>;
    };
}>

Model

export type Model = typeof Model.Type;

Model

Model: Schema.Struct<{
    readonly filter: Schema.String;
    readonly sort: Schema.NullOr<Schema.Struct<{
        readonly columnId: Schema.String;
        readonly direction: Schema.Literals<readonly ["ascending", "descending"]>;
    }>>;
    readonly orderedRowIds: Schema.$Array<Schema.String>;
    readonly activeCell: Schema.NullOr<Schema.Struct<{
        readonly rowId: Schema.String;
        readonly columnId: Schema.String;
    }>>;
    readonly pendingFocus: Schema.NullOr<Schema.Struct<{
        readonly rowId: Schema.String;
        readonly columnId: Schema.String;
    }>>;
    readonly virtualList: Schema.Struct<{
        readonly id: Schema.String;
        readonly rowHeightPx: Schema.Number;
        readonly scrollTop: Schema.Number;
        readonly measurement: import("@wsagency/wseffect-foldkit/schema").TaggedUnion<{
            readonly Unmeasured: {};
            readonly Measured: {
                containerWidth: Schema.Number;
                containerHeight: Schema.Number;
            };
        }>;
        readonly initialContainerHeight: Schema.optional<Schema.Number>;
        readonly leadingOffsetPx: Schema.optional<Schema.Number>;
        readonly viewportAnchor: import("@wsagency/wseffect-foldkit/schema").TaggedUnion<{
            readonly Offset: {
                scrollTop: Schema.Number;
            };
            readonly Row: {
                key: Schema.String;
                index: Schema.Number;
                viewportOffset: Schema.Number;
            };
            readonly End: {};
        }>;
        readonly measuredRowHeights: Schema.$Record<Schema.String, Schema.Number>;
        readonly layoutVersion: Schema.Number;
        readonly initialScroll: import("@wsagency/wseffect-foldkit/schema").TaggedUnion<{
            readonly Applied: {};
            readonly Pending: {
                target: import("@wsagency/wseffect-foldkit/schema").TaggedUnion<{
                    readonly Index: {
                        index: Schema.Number;
                    };
                    readonly Key: {
                        key: Schema.String;
                    };
                    readonly Offset: {
                        offset: Schema.Number;
                    };
                    readonly End: {};
                }>;
                alignment: Schema.Literals<readonly ["Start", "Center", "End", "Nearest"]>;
            };
        }>;
        readonly endBehavior: import("@wsagency/wseffect-foldkit/schema").TaggedUnion<{
            readonly PreserveAnchor: {};
            readonly Follow: {
                thresholdPx: Schema.Number;
            };
        }>;
        readonly pendingScroll: import("@wsagency/wseffect-foldkit/schema").TaggedUnion<{
            readonly Idle: {};
            readonly Pending: {
                request: import("@wsagency/wseffect-foldkit/schema").TaggedUnion<{
                    readonly Target: {
                        target: import("@wsagency/wseffect-foldkit/schema").TaggedUnion<{
                            readonly Index: {
                                index: Schema.Number;
                            };
                            readonly Key: {
                                key: Schema.String;
                            };
                            readonly Offset: {
                                offset: Schema.Number;
                            };
                            readonly End: {};
                        }>;
                        alignment: Schema.Literals<readonly ["Start", "Center", "End", "Nearest"]>;
                    };
                    readonly Anchor: {
                        anchor: import("@wsagency/wseffect-foldkit/schema").TaggedUnion<{
                            readonly Offset: {
                                scrollTop: Schema.Number;
                            };
                            readonly Row: {
                                key: Schema.String;
                                index: Schema.Number;
                                viewportOffset: Schema.Number;
                            };
                            readonly End: {};
                        }>;
                    };
                }>;
                version: Schema.Number;
            };
        }>;
        readonly pendingScrollVersion: Schema.Number;
    }>;
}>

OutMessage

export type OutMessage = typeof OutMessage.Type;

OutMessage

OutMessage: import("@wsagency/wseffect-foldkit/message").MessageUnion<{
    readonly SelectionChanged: {
        ids: Schema.$Array<Schema.String>;
    };
    readonly FocusCell: {
        rowId: Schema.String;
        columnId: Schema.String;
    };
}>

update

export declare function update<Row>(model: Model, config: Config<Row>, message: Message): Update.ReturnWithOutMessage<Model, Message, OutMessage>;

view

export declare function view<Row>(model: Model, config: Config<Row>, h: HtmlBuilder<Message>): Html;

Rendered component example

DataTable
Team members
Jordan Doe
Example usage
import * as Themes from '@wsagency/wseffect-themes'
import * as SliderRange from '@wsagency/wseffect-themes/components/slider/range'
import * as Option from 'effect/Option'
import { defineView } from '@wsagency/wseffect-foldkit/submodel'
import { inertHtml, type HtmlBuilder } from '@wsagency/wseffect-foldkit/html'

const example = (h: HtmlBuilder<unknown>) => (() => { type TeamRow = { id: string; name: string }; const rows: TeamRow[] = [{ id: 'jordan', name: 'Jordan Doe' }]; const columns: ReadonlyArray<Themes.DataTable.Column<TeamRow>> = [{ id: 'name', header: inertHtml.span([], ['Name']), accessor: (row) => row.name, isSortable: true }]; const config = (selectedRowIds: ReadonlyArray<string>): Themes.DataTable.Config<TeamRow> => ({ id: 'team-table-example', rows, getRowId: (row) => row.id, columns, caption: inertHtml.span([], ['Team members']), selectedRowIds: new Set(selectedRowIds), isGrid: false, rowHeight: 44, viewportHeight: 160, overscanRows: 2 }); type ViewInputs = { selectedRowIds: ReadonlyArray<string> }; const view = defineView<Themes.DataTable.Model, Themes.DataTable.Message, ViewInputs>((model, inputs, builder) => Themes.DataTable.view(model, config(inputs.selectedRowIds), builder)); return h.submodel({ slotId: 'team-table-example', model: Themes.DataTable.init(config([])), view, viewInputs: { selectedRowIds: [] }, toParentMessage: (message) => message }) })()