@timlassiter11/yatl
    Preparing search index...

    Interface TableOptions<T>

    Options for configuring the table.

    interface TableOptions<T> {
        classes?: TableClasses;
        emptyValuePlaceholder?: string;
        enableSearchScoring?: boolean;
        extraSearchFields?: NestedKeyOf<T>[];
        highlightSearch?: boolean;
        noDataText?: string;
        noMatchText?: string;
        rearrangeable?: boolean;
        rowFormatter?: null | RowFormatterCallback<T>;
        tokenizer?: TokenizerCallback;
        tokenizeSearch?: boolean;
        virtualScroll?: number | boolean;
        virtualScrollClass?: IVirtualScrollConstructor;
    }

    Type Parameters

    • T
    Index

    Properties

    classes? emptyValuePlaceholder? enableSearchScoring? extraSearchFields? highlightSearch? noDataText? noMatchText? rearrangeable? rowFormatter? tokenizer? tokenizeSearch? virtualScroll? virtualScrollClass?

    Properties

    classes?: TableClasses

    Custom CSS classes to apply to various table elements.

    emptyValuePlaceholder?: string

    A placeholder to use for null or undefined values.

    enableSearchScoring?: boolean

    Whether search results should be scored or not. Scoring is very computationally expensive...

    extraSearchFields?: NestedKeyOf<T>[]

    Additional fields to include in the search. Used for fields that are not displayed as columns.

    highlightSearch?: boolean

    Whether to highlight search results in the table cells.

    noDataText?: string

    The text to display when there is no data in the table.

    noMatchText?: string

    The text to display when there are no matching records after filtering or searching.

    rearrangeable?: boolean

    Whether columns should be rearrangeable by drag and drop.

    rowFormatter?: null | RowFormatterCallback<T>

    A function to format each row's HTML element.

    tokenizer?: TokenizerCallback

    A function to use for tokenizing values for searching.

    tokenizeSearch?: boolean

    Whether the search query should be tokenized.

    virtualScroll?: number | boolean

    Configures virtual scrolling.

    virtualScrollClass?: IVirtualScrollConstructor

    A specific virtual scroll class to use

    Settings

    Member Visibility

    On This Page

    Properties