@devfamily/admiral/lib/admiral/ui/Table/interfaces.d.ts

Admiral is a frontend framework for creating back office using React. It provides out-of-the-box components and tools that make developing an admin interface easy and fast.

/// <reference types="react" />
import { TableProps as RcTableProps } from 'rc-table/lib/Table';
import { ColumnType as RcColumnType, GetRowKey } from 'rc-table/lib/interface';
import { SorterResult, SortOrder, ControlledSorter } from './hooks/useSorter';
import { CheckboxProps } from '../Checkbox/interfaces';
import { PaginationParam } from './hooks/usePagination';
import { PaginationProps } from '../Pagination/interfaces';
import { SpinProps } from '../Spin/interfaces';
import { DragEndEvent } from '@dnd-kit/core';
import type { TooltipProps } from '../Tooltip/interfaces';
export type { GetRowKey };
export type { SortOrder, SorterResult, ControlledSorter };
export declare type Key = React.Key;
export declare type CompareFn<T> = (a: T, b: T, sortOrder?: SortOrder) => number;
export interface ColumnType<RecordType> extends RcColumnType<RecordType> {
    sorter?: boolean | CompareFn<RecordType>;
    defaultSortOrder?: SortOrder;
    sortDirections?: SortOrder[];
    showSorterTooltip?: boolean | TooltipProps;
}
export declare type ColumnsType<RecordType = unknown> = ColumnType<RecordType>[];
export declare type SizeType = 'small' | 'middle' | 'large';
export interface ChangeEventInfo<RecordType> {
    sorter: SorterResult<RecordType>;
    pagination: {
        current?: number;
        pageSize?: number;
        total?: number;
    };
    resetPagination: Function;
}
declare const TableActions: ["paginate", "sort", "filter"];
export declare type TableAction = typeof TableActions[number];
export interface TableExtra {
    action: TableAction;
}
export declare type SelectionSelectFn<T> = (record: T, selected: boolean, selectedRows: T[], nativeEvent: Event) => void;
export interface TableRowSelection<T> {
    /** Keep the selection keys in list even the key not exist in `dataSource` anymore */
    preserveSelectedRowKeys?: boolean;
    selectedRowKeys?: Key[];
    defaultSelectedRowKeys?: Key[];
    onChange?: (selectedRowKeys: Key[], selectedRows: T[]) => void;
    getCheckboxProps?: (record: T) => Partial<Omit<CheckboxProps, 'checked' | 'defaultChecked'>>;
    getTitleCheckboxProps?: () => Partial<Omit<CheckboxProps, 'checked' | 'defaultChecked'>>;
    onSelect?: SelectionSelectFn<T>;
    onSelectMultiple?: (selected: boolean, selectedRows: T[], changeRows: T[]) => void;
    onSelectNone?: () => void;
    hideSelectAll?: boolean;
    fixed?: boolean;
    columnWidth?: string | number;
    columnTitle?: string | React.ReactNode;
    checkStrictly?: boolean;
}
export declare type TransformColumns<RecordType> = (columns: ColumnsType<RecordType>) => ColumnsType<RecordType>;
export interface TableLocale {
    filterTitle?: string;
    filterConfirm?: React.ReactNode;
    filterReset?: React.ReactNode;
    filterEmptyText?: React.ReactNode;
    filterCheckall?: React.ReactNode;
    filterSearchPlaceholder?: string;
    emptyText?: React.ReactNode | (() => React.ReactNode);
    selectAll?: React.ReactNode;
    selectNone?: React.ReactNode;
    selectInvert?: React.ReactNode;
    selectionAll?: React.ReactNode;
    sortTitle?: string;
    expand?: string;
    collapse?: string;
    triggerDesc?: string;
    triggerAsc?: string;
    cancelSort?: string;
}
export interface TableProps<RecordType> extends Omit<RcTableProps<RecordType>, 'transformColumns' | 'internalHooks' | 'internalRefs' | 'data' | 'columns' | 'emptyText' | 'components'> {
    dataSource?: RcTableProps<RecordType>['data'];
    columns?: ColumnsType<RecordType>;
    pagination?: false | TablePaginationConfig;
    loading?: boolean | SpinProps;
    size?: SizeType;
    bordered?: boolean;
    onChange?: (pagination: Partial<PaginationParam>, sorter: SorterResult<RecordType>, extra: TableExtra) => void;
    rowSelection?: TableRowSelection<RecordType>;
    sortDirections?: SortOrder[];
    sorter?: ControlledSorter | null;
    dndRows?: boolean;
    onDragEnd?: (event: DragEndEvent) => void;
    locale?: TableLocale;
    showSorterTooltip?: boolean | TooltipProps;
}
export declare type TablePaginationPosition = 'topLeft' | 'topCenter' | 'topRight' | 'bottomLeft' | 'bottomCenter' | 'bottomRight';
export interface TablePaginationConfig extends PaginationProps {
    position?: TablePaginationPosition[];
}