Interface TableProps<T, C>

Public

interface TableProps<T, C> {
    addText: ReactNode;
    canAdd?: boolean;
    canCollapseLocked?: boolean;
    canDelete?: boolean;
    cellRenderer?: ((props: TableCellRendererProps<T, C>) => ReactNode);
    cellViewType?: CELL_VIEW_TYPE;
    checkedLockedRows?: number[];
    checkedRows?: number[];
    collapsedRowsText?: string;
    collapseText?: string;
    columnHeights?: {
        [key: string]: number;
    };
    columns: TableColumn<T, C>[];
    columnWidths?: {
        [key: string]: number;
    };
    customHeaderCheckbox?: ReactNode;
    data: T[];
    deleteText: ReactNode;
    disabledForCheckLockedRows?: number[];
    disabledForCheckRows?: number[];
    editableCell?: {
        id: string;
        index: number;
    };
    emptyTableRenderer?: ((isLoading: boolean, emptyTableText: string) => ReactNode);
    emptyTableText?: string;
    expandText?: string;
    filterValues?: {
        [key: string]: any;
    };
    getRowType?: ((rowIndex: number) => ROW_TYPE);
    hasChecked?: boolean;
    hasHeader?: boolean;
    hasHeaderBg?: boolean;
    hasNavigation?: boolean;
    hasPagination?: boolean;
    hideLastRowBorder?: boolean;
    highlightedRows?: number[];
    isAutoHeightFill?: boolean;
    isAutoScrollToSelected?: boolean;
    isChangedAxes?: boolean;
    isEditable?: boolean;
    isHeaderCheckable?: boolean;
    isLoading?: boolean;
    isLockedCollapsed?: boolean;
    isLockedRowsCheckable?: boolean;
    isMultiselect?: boolean;
    isResizable?: boolean;
    isRowsCheckable?: boolean;
    isRowsSelectable?: boolean;
    isSortable?: boolean;
    isStriped?: boolean;
    loadingText: string;
    lockedData?: T[];
    lockedRowActions?: ((rowData: TableRowActionsProps<T>) => ReactNode);
    maxRowsBeforeOverflow?: number;
    noLockedLimit?: boolean;
    onAllCheck?: ((isCheck: boolean) => void);
    onCellEdit?: ((rowIndex: number, columnId: string, newValue: EditableCellValue, cancelEdit?: boolean) => void);
    onCellEditStart?: ((rowIndex: number, columnId: string) => void);
    onChangeColumnHeight?: ((columnId: string, newHeight: number) => void);
    onChangeColumnWidth?: ((columnId: string, newWidth: number) => void);
    onCollapseLocked?: ((isCollapsed: boolean) => void);
    onFilter?: ((columnId: string, isClear?: boolean) => void);
    onLockedRowCheck?: ((rowIndex: number, isCheck: boolean, isShiftPressed?: boolean) => void);
    onLockedRowClick?: ((rowIndex: number, e?: MouseEvent<Element, MouseEvent> | KeyboardEvent<Element>) => void);
    onMove?: ((sortEnd: TableSortEnd) => void);
    onResetFilter?: ((columnId: string) => void);
    onRowAdd?: (() => void);
    onRowCheck?: ((rowIndex: number, isCheck: boolean, isShiftPressed?: boolean) => void);
    onRowClick?: ((rowIndex: number, e?: MouseEvent<Element, MouseEvent> | KeyboardEvent<Element>) => void);
    onRowDoubleClick?: ((rowIndex: number, e: MouseEvent<Element, MouseEvent>) => void);
    onRowMouseEnter?: ((rowIndex: number, e: MouseEvent<Element, MouseEvent>) => void);
    onRowMouseLeave?: ((rowIndex: number, e: MouseEvent<Element, MouseEvent>) => void);
    onRowsDelete?: ((rowIndexes: number[]) => void);
    onSort?: ((columnId: string, newSortDirection: TableSortDirection, currentSortDirection: TableSortDirection, columnData?: C) => void);
    rowActions?: ((rowData: TableRowActionsProps<T>) => ReactNode);
    selectedRows?: number[];
    sortDirection?: {
        [key: string]: TableSortDirection;
    };
    unsetText: string;
}

Type Parameters

  • T = any
  • C = void

Hierarchy

Properties

addText canAdd? canCollapseLocked? canDelete? cellRenderer? cellViewType? checkedLockedRows? checkedRows? collapsedRowsText? collapseText? columnHeights? columns columnWidths? customHeaderCheckbox? data deleteText disabledForCheckLockedRows? disabledForCheckRows? editableCell? emptyTableRenderer? emptyTableText? expandText? filterValues? getRowType? hasChecked? hasHeader? hasHeaderBg? hasNavigation? hasPagination? hideLastRowBorder? highlightedRows? isAutoHeightFill? isAutoScrollToSelected? isChangedAxes? isEditable? isHeaderCheckable? isLoading? isLockedCollapsed? isLockedRowsCheckable? isMultiselect? isResizable? isRowsCheckable? isRowsSelectable? isSortable? isStriped? loadingText lockedData? lockedRowActions? maxRowsBeforeOverflow? noLockedLimit? onAllCheck? onCellEdit? onCellEditStart? onChangeColumnHeight? onChangeColumnWidth? onCollapseLocked? onFilter? onLockedRowCheck? onLockedRowClick? onMove? onResetFilter? onRowAdd? onRowCheck? onRowClick? onRowDoubleClick? onRowMouseEnter? onRowMouseLeave? onRowsDelete? onSort? rowActions? selectedRows? sortDirection? unsetText

Properties

addText

addText: ReactNode

OptionalcanAdd

canAdd?: boolean

OptionalcanCollapseLocked

canCollapseLocked?: boolean

OptionalcanDelete

canDelete?: boolean

OptionalcellRenderer

cellRenderer?: ((props: TableCellRendererProps<T, C>) => ReactNode)

OptionalcellViewType

cellViewType?: CELL_VIEW_TYPE

OptionalcheckedLockedRows

checkedLockedRows?: number[]

OptionalcheckedRows

checkedRows?: number[]

OptionalcollapsedRowsText

collapsedRowsText?: string

OptionalcollapseText

collapseText?: string

OptionalcolumnHeights

columnHeights?: {
    [key: string]: number;
}

columns

columns: TableColumn<T, C>[]

OptionalcolumnWidths

columnWidths?: {
    [key: string]: number;
}

OptionalcustomHeaderCheckbox

customHeaderCheckbox?: ReactNode

data

data: T[]

deleteText

deleteText: ReactNode

OptionaldisabledForCheckLockedRows

disabledForCheckLockedRows?: number[]

OptionaldisabledForCheckRows

disabledForCheckRows?: number[]

OptionaleditableCell

editableCell?: {
    id: string;
    index: number;
}

OptionalemptyTableRenderer

emptyTableRenderer?: ((isLoading: boolean, emptyTableText: string) => ReactNode)

OptionalemptyTableText

emptyTableText?: string

OptionalexpandText

expandText?: string

OptionalfilterValues

filterValues?: {
    [key: string]: any;
}

OptionalgetRowType

getRowType?: ((rowIndex: number) => ROW_TYPE)

OptionalhasChecked

hasChecked?: boolean

OptionalhasHeader

hasHeader?: boolean

OptionalhasHeaderBg

hasHeaderBg?: boolean

OptionalhasNavigation

hasNavigation?: boolean

OptionalhasPagination

hasPagination?: boolean

OptionalhideLastRowBorder

hideLastRowBorder?: boolean

OptionalhighlightedRows

highlightedRows?: number[]

OptionalisAutoHeightFill

isAutoHeightFill?: boolean

OptionalisAutoScrollToSelected

isAutoScrollToSelected?: boolean

OptionalisChangedAxes

isChangedAxes?: boolean

OptionalisEditable

isEditable?: boolean

OptionalisHeaderCheckable

isHeaderCheckable?: boolean

OptionalisLoading

isLoading?: boolean

OptionalisLockedCollapsed

isLockedCollapsed?: boolean

OptionalisLockedRowsCheckable

isLockedRowsCheckable?: boolean

OptionalisMultiselect

isMultiselect?: boolean

OptionalisResizable

isResizable?: boolean

OptionalisRowsCheckable

isRowsCheckable?: boolean

OptionalisRowsSelectable

isRowsSelectable?: boolean

OptionalisSortable

isSortable?: boolean

OptionalisStriped

isStriped?: boolean

loadingText

loadingText: string

OptionallockedData

lockedData?: T[]

OptionallockedRowActions

lockedRowActions?: ((rowData: TableRowActionsProps<T>) => ReactNode)

OptionalmaxRowsBeforeOverflow

maxRowsBeforeOverflow?: number

OptionalnoLockedLimit

noLockedLimit?: boolean

OptionalonAllCheck

onAllCheck?: ((isCheck: boolean) => void)

OptionalonCellEdit

onCellEdit?: ((rowIndex: number, columnId: string, newValue: EditableCellValue, cancelEdit?: boolean) => void)

OptionalonCellEditStart

onCellEditStart?: ((rowIndex: number, columnId: string) => void)

OptionalonChangeColumnHeight

onChangeColumnHeight?: ((columnId: string, newHeight: number) => void)

OptionalonChangeColumnWidth

onChangeColumnWidth?: ((columnId: string, newWidth: number) => void)

OptionalonCollapseLocked

onCollapseLocked?: ((isCollapsed: boolean) => void)

OptionalonFilter

onFilter?: ((columnId: string, isClear?: boolean) => void)

OptionalonLockedRowCheck

onLockedRowCheck?: ((rowIndex: number, isCheck: boolean, isShiftPressed?: boolean) => void)

OptionalonLockedRowClick

onLockedRowClick?: ((rowIndex: number, e?: MouseEvent<Element, MouseEvent> | KeyboardEvent<Element>) => void)

OptionalonMove

onMove?: ((sortEnd: TableSortEnd) => void)

OptionalonResetFilter

onResetFilter?: ((columnId: string) => void)

OptionalonRowAdd

onRowAdd?: (() => void)

OptionalonRowCheck

onRowCheck?: ((rowIndex: number, isCheck: boolean, isShiftPressed?: boolean) => void)

OptionalonRowClick

onRowClick?: ((rowIndex: number, e?: MouseEvent<Element, MouseEvent> | KeyboardEvent<Element>) => void)

OptionalonRowDoubleClick

onRowDoubleClick?: ((rowIndex: number, e: MouseEvent<Element, MouseEvent>) => void)

OptionalonRowMouseEnter

onRowMouseEnter?: ((rowIndex: number, e: MouseEvent<Element, MouseEvent>) => void)

OptionalonRowMouseLeave

onRowMouseLeave?: ((rowIndex: number, e: MouseEvent<Element, MouseEvent>) => void)

OptionalonRowsDelete

onRowsDelete?: ((rowIndexes: number[]) => void)

OptionalonSort

onSort?: ((columnId: string, newSortDirection: TableSortDirection, currentSortDirection: TableSortDirection, columnData?: C) => void)

OptionalrowActions

rowActions?: ((rowData: TableRowActionsProps<T>) => ReactNode)

OptionalselectedRows

selectedRows?: number[]

OptionalsortDirection

sortDirection?: {
    [key: string]: TableSortDirection;
}

unsetText

unsetText: string

On This Page

Properties
addTextcanAddcanCollapseLockedcanDeletecellRenderercellViewTypecheckedLockedRowscheckedRowscollapsedRowsTextcollapseTextcolumnHeightscolumnscolumnWidthscustomHeaderCheckboxdatadeleteTextdisabledForCheckLockedRowsdisabledForCheckRowseditableCellemptyTableRendereremptyTableTextexpandTextfilterValuesgetRowTypehasCheckedhasHeaderhasHeaderBghasNavigationhasPaginationhideLastRowBorderhighlightedRowsisAutoHeightFillisAutoScrollToSelectedisChangedAxesisEditableisHeaderCheckableisLoadingisLockedCollapsedisLockedRowsCheckableisMultiselectisResizableisRowsCheckableisRowsSelectableisSortableisStripedloadingTextlockedDatalockedRowActionsmaxRowsBeforeOverflownoLockedLimitonAllCheckonCellEditonCellEditStartonChangeColumnHeightonChangeColumnWidthonCollapseLockedonFilteronLockedRowCheckonLockedRowClickonMoveonResetFilteronRowAddonRowCheckonRowClickonRowDoubleClickonRowMouseEnteronRowMouseLeaveonRowsDeleteonSortrowActionsselectedRowssortDirectionunsetText