Kottster Packages API Reference
    Preparing search index...

    Interface TableProps

    interface TableProps {
        columnOverrides?: Record<string, TableColumn | TableColumnTransformer>;
        columns?: TableColumn[];
        columnTransformer?: (columns: TableColumn[]) => TableColumn[];
        customActions?: TableAction[];
        customBulkActions?: TableBulkAction[];
        customColumns?: TableColumn[];
        form?: Pick<ModalProps, "width" | "maxWidth">;
        getByForeignRecord?: {
            recordPrimaryKeyValue: string | number;
            relationship: OneToManyRelationship;
        };
        inModal?: boolean;
        nested?: Record<string, TableProps>;
        nestedTableKey?: TablePageNestedTableKey;
        onRecordSelect?: (record: TablePageRecord) => void;
        pageTitle?: string;
        selectedPrimeryKeyValues?: string[];
        withSavedFilters?: boolean;
        withSearch?: boolean;
        withSelection?: boolean;
    }
    Index

    Properties

    columnOverrides? columns? columnTransformer? customActions? customBulkActions? customColumns? form? getByForeignRecord? inModal? nested? nestedTableKey? onRecordSelect? pageTitle? selectedPrimeryKeyValues? withSavedFilters? withSearch? withSelection?

    Properties

    columnOverrides?: Record<string, TableColumn | TableColumnTransformer>

    Object with column keys as properties and column overrides as values. Use this to override specific properties of individual columns.

    columns?: TableColumn[]
    columnTransformer?: (columns: TableColumn[]) => TableColumn[]

    Function to transform all columns. Executes after columns are auto-generated or provided via the columns prop.

    Type Declaration

    customActions?: TableAction[]

    Custom actions to be added to the table. These actions will be available in the end of each row.

    customBulkActions?: TableBulkAction[]

    Custom bulk actions to be added to the table. These actions will be available in the top of the table when any records are selected.

    customColumns?: TableColumn[]

    Custom columns to be added to the table. These columns will be merged with the regular columns.

    form?: Pick<ModalProps, "width" | "maxWidth">

    Form layout options

    getByForeignRecord?: {
        recordPrimaryKeyValue: string | number;
        relationship: OneToManyRelationship;
    }
    inModal?: boolean
    nested?: Record<string, TableProps>
    nestedTableKey?: TablePageNestedTableKey
    onRecordSelect?: (record: TablePageRecord) => void
    pageTitle?: string
    selectedPrimeryKeyValues?: string[]
    withSavedFilters?: boolean
    withSearch?: boolean

    Whether to enable search functionality. By default, it will be enabled only if there are searchable columns defined in the tablePageConfig

    withSelection?: boolean

    Settings

    Member Visibility

    On This Page

    Properties