Search
    Preparing search index...

    Interface TableProps<T, C>

    Свойства таблицы

    interface TableProps<T = any, C = void> {
        addText: ReactNode;
        canAdd?: boolean;
        canCollapseLocked?: boolean;
        canDelete?: boolean;
        cellRenderer?: (props: TableCellRendererProps<T, C>) => ReactNode;
        cellViewType?:
            | CELL_VIEW_TYPE
            | (
                (
                    column: TableColumn<T, C>,
                    rowData: T,
                    index: number,
                ) => 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 };
        getRowKey?: (row: T, index: number) => string;
        getRowType?: (rowIndex: number) => ROW_TYPE;
        hasCellPadding?: boolean;
        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;
        isScrollOverflowAuto?: 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) => void;
        onRowMouseEnter?: (rowIndex: number, e: MouseEvent) => void;
        onRowMouseLeave?: (rowIndex: number, e: MouseEvent) => void;
        onRowsDelete?: (rowIndexes: number[]) => void;
        onSort?: (
            columnId: string,
            newSortDirection: TableSortDirection,
            currentSortDirection: TableSortDirection,
            columnData?: C,
        ) => void;
        rowActions?: (rowData: TableRowActionsProps<T>) => ReactNode;
        rowHeights?: { [key: string]: number };
        rowWidths?: { [key: string]: number };
        selectedRows?: number[];
        sortDirection?: { [key: string]: TableSortDirection };
        unsetText: string;
    }

    Type Parameters

    • T = any
    • C = void

    Hierarchy

    Index

    Properties

    addText canAdd? canCollapseLocked? canDelete? cellRenderer? cellViewType? checkedLockedRows? checkedRows? collapsedRowsText? collapseText? columnHeights? columns columnWidths? customHeaderCheckbox? data deleteText disabledForCheckLockedRows? disabledForCheckRows? editableCell? emptyTableRenderer? emptyTableText? expandText? filterValues? getRowKey? getRowType? hasCellPadding? hasChecked? hasHeader? hasHeaderBg? hasNavigation? hasPagination? hideLastRowBorder? highlightedRows? isAutoHeightFill? isAutoScrollToSelected? isChangedAxes? isEditable? isHeaderCheckable? isLoading? isLockedCollapsed? isLockedRowsCheckable? isMultiselect? isResizable? isRowsCheckable? isRowsSelectable? isScrollOverflowAuto? 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? rowHeights? rowWidths? selectedRows? sortDirection? unsetText

    Properties

    addText: ReactNode

    Текст кнопки добавления.

    canAdd?: boolean

    Разрешает добавление новых строк.

    canCollapseLocked?: boolean

    Разрешает сворачивать зафиксированные строки.

    canDelete?: boolean

    Разрешает удаление строк.

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

    Собственный рендерер ячейки таблицы.

    Type declaration

    cellViewType?:
        | CELL_VIEW_TYPE
        | (
            (
                column: TableColumn<T, C>,
                rowData: T,
                index: number,
            ) => 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

    Функция рендера пустого состояния таблицы.

    Type declaration

      • (isLoading: boolean, emptyTableText: string): ReactNode

      • Parameters

        • isLoading: boolean

          Флаг загрузки.

        • emptyTableText: string

          Текст пустого состояния.

        Returns ReactNode

    emptyTableText?: string

    Текст пустого состояния.

    expandText?: string

    Текст кнопки разворачивания.

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

    Значения фильтров для столбцов.

    getRowKey?: (row: T, index: number) => string

    Функция получения ключа для строки.

    Type declaration

      • (row: T, index: number): string

      • Parameters

        • row: T

          Данные строки.

        • index: number

          Индекс строки.

        Returns string

    getRowType?: (rowIndex: number) => ROW_TYPE

    Получение типа строки.

    Type declaration

      • (rowIndex: number): ROW_TYPE

      • Parameters

        • rowIndex: number

          Индекс строки.

        Returns ROW_TYPE

    hasCellPadding?: boolean

    Наличие отступов в ячейках.

    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

    Включает выбор строк (для селекта).

    isScrollOverflowAuto?: boolean

    Включает автопрокрутку при переполнении.

    isSortable?: boolean

    Доступна ли сортировка.

    isStriped?: boolean

    Полосатое оформление строк.

    loadingText: string

    Текст статуса загрузки.

    lockedData?: T[]

    Зафиксированные строки таблицы.

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

    Рендерер действий в зафиксированной строке.

    Type declaration

    maxRowsBeforeOverflow?: number

    Максимальное число строк до появления прокрутки.

    noLockedLimit?: boolean

    Отключает ограничение на количество зафиксированных строк.

    onAllCheck?: (isCheck: boolean) => void

    Отметка всех строк/снятие отметки.

    Type declaration

      • (isCheck: boolean): void

      • Parameters

        • isCheck: boolean

          Флаг отметки.

        Returns void

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

    Обработчик редактирования ячейки.

    Type declaration

      • (
            rowIndex: number,
            columnId: string,
            newValue: EditableCellValue,
            cancelEdit?: boolean,
        ): void

      • Parameters

        • rowIndex: number

          Индекс строки.

        • columnId: string

          Идентификатор столбца.

        • newValue: EditableCellValue

          Новое значение ячейки.

        • OptionalcancelEdit: boolean

          Флаг отмены редактирования.

        Returns void

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

    Вызывается при начале редактирования ячейки.

    Type declaration

      • (rowIndex: number, columnId: string): void

      • Parameters

        • rowIndex: number

          Индекс строки.

        • columnId: string

          Идентификатор столбца.

        Returns void

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

    Изменение высоты столбца.

    Type declaration

      • (columnId: string, newHeight: number): void

      • Parameters

        • columnId: string

          Идентификатор столбца.

        • newHeight: number

          Новая высота.

        Returns void

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

    Изменение ширины столбца.

    Type declaration

      • (columnId: string, newWidth: number): void

      • Parameters

        • columnId: string

          Идентификатор столбца.

        • newWidth: number

          Новая ширина.

        Returns void

    onCollapseLocked?: (isCollapsed: boolean) => void

    Обработчик сворачивания зафиксированных строк.

    Type declaration

      • (isCollapsed: boolean): void

      • Parameters

        • isCollapsed: boolean

          Флаг сворачивания.

        Returns void

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

    Обработчик фильтрации.

    Type declaration

      • (columnId: string, isClear?: boolean): void

      • Parameters

        • columnId: string

          Идентификатор столбца.

        • OptionalisClear: boolean

          Флаг очистки фильтра.

        Returns void

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

    Вызывается при отметке зафиксированной строки.

    Type declaration

      • (rowIndex: number, isCheck: boolean, isShiftPressed?: boolean): void

      • Parameters

        • rowIndex: number

          Индекс зафиксированной строки.

        • isCheck: boolean

          Флаг отметки.

        • OptionalisShiftPressed: boolean

          Флаг нажатия Shift.

        Returns void

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

    Клик по зафиксированной строке.

    Type declaration

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

      • Parameters

        • rowIndex: number

          Индекс зафиксированной строки.

        • Optionale: MouseEvent<Element, MouseEvent> | KeyboardEvent<Element>

          Событие мыши или клавиатуры.

        Returns void

    onMove?: (sortEnd: TableSortEnd) => void

    Обработчик перемещения строк.

    Type declaration

      • (sortEnd: TableSortEnd): void

      • Parameters

        • sortEnd: TableSortEnd

          Параметры окончания сортировки.

        Returns void

    onResetFilter?: (columnId: string) => void

    Сброс фильтра для столбца.

    Type declaration

      • (columnId: string): void

      • Parameters

        • columnId: string

          Идентификатор столбца.

        Returns void

    onRowAdd?: () => void

    Обработчик добавления новой строки.

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

    Вызывается при отметке строки.

    Type declaration

      • (rowIndex: number, isCheck: boolean, isShiftPressed?: boolean): void

      • Parameters

        • rowIndex: number

          Индекс строки.

        • isCheck: boolean

          Флаг отметки.

        • OptionalisShiftPressed: boolean

          Флаг нажатия Shift.

        Returns void

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

    Клик по строке.

    Type declaration

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

      • Parameters

        • rowIndex: number

          Индекс строки.

        • Optionale: MouseEvent<Element, MouseEvent> | KeyboardEvent<Element>

          Событие мыши или клавиатуры.

        Returns void

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

    Двойной клик по строке.

    Type declaration

      • (rowIndex: number, e: MouseEvent): void

      • Parameters

        • rowIndex: number

          Индекс строки.

        • e: MouseEvent

          Событие мыши.

        Returns void

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

    Наведение курсора на строку.

    Type declaration

      • (rowIndex: number, e: MouseEvent): void

      • Parameters

        • rowIndex: number

          Индекс строки.

        • e: MouseEvent

          Событие мыши.

        Returns void

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

    Уход курсора со строки.

    Type declaration

      • (rowIndex: number, e: MouseEvent): void

      • Parameters

        • rowIndex: number

          Индекс строки.

        • e: MouseEvent

          Событие мыши.

        Returns void

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

    Обработчик удаления строк.

    Type declaration

      • (rowIndexes: number[]): void

      • Parameters

        • rowIndexes: number[]

          Индексы удаляемых строк.

        Returns void

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

    Обработчик сортировки.

    Type declaration

      • (
            columnId: string,
            newSortDirection: TableSortDirection,
            currentSortDirection: TableSortDirection,
            columnData?: C,
        ): void

      • Parameters

        • columnId: string

          Идентификатор столбца.

        • newSortDirection: TableSortDirection

          Новое направление сортировки.

        • currentSortDirection: TableSortDirection

          Текущее направление сортировки.

        • OptionalcolumnData: C

          Данные столбца.

        Returns void

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

    Рендерер действий в строке.

    Type declaration

    rowHeights?: { [key: string]: number }

    Текущие высоты строк.

    rowWidths?: { [key: string]: number }

    Текущие ширины строк.

    selectedRows?: number[]

    Индексы выбранных строк.

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

    Текущее направление сортировки по столбцам.

    unsetText: string

    Текст "не установлено".

    On This Page

    Properties
    addTextcanAddcanCollapseLockedcanDeletecellRenderercellViewTypecheckedLockedRowscheckedRowscollapsedRowsTextcollapseTextcolumnHeightscolumnscolumnWidthscustomHeaderCheckboxdatadeleteTextdisabledForCheckLockedRowsdisabledForCheckRowseditableCellemptyTableRendereremptyTableTextexpandTextfilterValuesgetRowKeygetRowTypehasCellPaddinghasCheckedhasHeaderhasHeaderBghasNavigationhasPaginationhideLastRowBorderhighlightedRowsisAutoHeightFillisAutoScrollToSelectedisChangedAxesisEditableisHeaderCheckableisLoadingisLockedCollapsedisLockedRowsCheckableisMultiselectisResizableisRowsCheckableisRowsSelectableisScrollOverflowAutoisSortableisStripedloadingTextlockedDatalockedRowActionsmaxRowsBeforeOverflownoLockedLimitonAllCheckonCellEditonCellEditStartonChangeColumnHeightonChangeColumnWidthonCollapseLockedonFilteronLockedRowCheckonLockedRowClickonMoveonResetFilteronRowAddonRowCheckonRowClickonRowDoubleClickonRowMouseEnteronRowMouseLeaveonRowsDeleteonSortrowActionsrowHeightsrowWidthsselectedRowssortDirectionunsetText