@yarcl/react
    Preparing search index...

    Interface TableColumnOptions<Id>

    Controlled or initial state for useTableColumns.

    interface TableColumnOptions<Id extends string = string> {
        defaultVisibility?: Partial<Record<Id, boolean>>;
        defaultWidths?: Partial<Record<Id, number>>;
        onVisibilityChange?: (visibility: TableColumnVisibility<Id>) => void;
        onWidthsChange?: (widths: TableColumnWidths<Id>) => void;
        visibility?: Partial<Record<Id, boolean>>;
        widths?: Partial<Record<Id, number>>;
    }

    Type Parameters

    • Id extends string = string
    Index
    defaultVisibility? defaultWidths? onVisibilityChange? onWidthsChange? visibility? widths?
    defaultVisibility?: Partial<Record<Id, boolean>>

    Initial uncontrolled visibility.

    all visible
    defaultWidths?: Partial<Record<Id, number>>

    Initial uncontrolled widths.

    column definitions
    onVisibilityChange?: (visibility: TableColumnVisibility<Id>) => void

    Requests updated visibility after checkbox or programmatic changes.

    onWidthsChange?: (widths: TableColumnWidths<Id>) => void

    Requests updated widths after pointer, keyboard or programmatic changes.

    visibility?: Partial<Record<Id, boolean>>

    Controlled visibility. Required columns stay visible, and at least one column remains visible.

    widths?: Partial<Record<Id, number>>

    Controlled column widths in CSS pixels.

    Settings
    Member Visibility

    On This Page
    Properties