Kottster Packages API Reference
    Preparing search index...

    Interface TablePageProps

    interface TablePageProps {
        columnOverrides?: Record<string, TableColumn | TableColumnTransformer>;
        columns?: TableColumn[];
        columnTransformer?: (columns: TableColumn[]) => TableColumn[];
        customActions?: TableAction[];
        customBulkActions?: TableBulkAction[];
        customColumns?: TableColumn[];
        form?: Pick<ModalProps, "width" | "maxWidth">;
        headerBottomSection?: ReactNode;
        headerRightSection?: ReactNode;
        maxContentWidth?: number;
        nested?: Record<string, TableProps>;
        title?: string;
        withSearch?: boolean;
    }

    Hierarchy

    • Pick<
          TableProps,
          | "columns"
          | "customColumns"
          | "customActions"
          | "customBulkActions"
          | "columnTransformer"
          | "columnOverrides"
          | "form"
          | "withSearch"
          | "nested",
      >
    • Pick<
          PageProps,
          "title"
          | "headerRightSection"
          | "headerBottomSection"
          | "maxContentWidth",
      >
      • TablePageProps
    Index

    Properties

    columnOverrides? columns? columnTransformer? customActions? customBulkActions? customColumns? form? headerBottomSection? headerRightSection? maxContentWidth? nested? title? withSearch?

    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

    headerBottomSection?: ReactNode
    headerRightSection?: ReactNode
    maxContentWidth?: number
    nested?: Record<string, TableProps>
    title?: string
    withSearch?: boolean

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

    Settings

    Member Visibility

    On This Page

    Properties