import type { VueNode } from '@v-c/util' /** * ColumnType which applied in antd: https://ant.design/components/table-cn/#Column * - defaultSortOrder * - filterDropdown * - filterDropdownVisible * - filtered * - filteredValue * - filterIcon * - filterMultiple * - filters * - sorter * - sortOrder * - sortDirections * - onFilter * - onFilterDropdownVisibleChange */ import type { CSSProperties, HTMLAttributes, Ref, TdHTMLAttributes, Component as VueComponent } from 'vue' import type { DeepNamePath } from './namePathType' export type Key = string | number /** * Use `start` or `end` instead. `left` or `right` is deprecated. */ export type FixedType = 'start' | 'end' | 'left' | 'right' | boolean export type DefaultRecordType = Record export type TableLayout = 'auto' | 'fixed' export interface ScrollConfig { /** The index of the row to scroll to */ index?: number /** The key of the row to scroll to */ key?: Key /** The absolute scroll position from top */ top?: number /** * Additional offset in pixels to apply to the scroll position. * Only effective when using `key` or `index` mode. * Ignored when using `top` mode. * In `key` / `index` mode, `offset` is added to the position resolved by `align`. */ offset?: number align?: ScrollLogicalPosition } export type VirtualScrollConfig = ScrollConfig & { align?: Exclude } export interface Reference { nativeElement: HTMLDivElement scrollTo: (config: ScrollConfig) => void } // ==================== Row ===================== export type RowClassName = ( record: RecordType, index: number, indent: number, ) => string // =================== Column =================== export interface CellType { key?: Key className?: string style?: CSSProperties children?: VueNode column?: ColumnsType[number] colSpan?: number rowSpan?: number /** Only used for table header */ hasSubColumns?: boolean colStart?: number colEnd?: number } export interface RenderedCell { props?: CellType children?: VueNode } export type Direction = 'ltr' | 'rtl' // SpecialString will be removed in antd@6 export type SpecialString = T | (string & NonNullable) export type DataIndex = | DeepNamePath | SpecialString | number | (SpecialString | number)[] export type CellEllipsisType = { showTitle?: boolean } | boolean export type ColScopeType = 'col' | 'colgroup' export type RowScopeType = 'row' | 'rowgroup' export type ScopeType = ColScopeType | RowScopeType interface ColumnSharedType { title?: VueNode key?: Key className?: string hidden?: boolean fixed?: FixedType onHeaderCell?: GetComponentProps[number]> ellipsis?: CellEllipsisType align?: AlignType rowScope?: RowScopeType } export interface ColumnGroupType extends ColumnSharedType { children: ColumnsType } export type AlignType = 'start' | 'end' | 'left' | 'right' | 'center' | 'justify' | 'match-parent' export interface ColumnType> extends ColumnSharedType { colSpan?: number dataIndex?: DataIndex render?: ( value: any, record: RecordType, index: number, ) => VueNode | RenderedCell shouldCellUpdate?: (record: RecordType, prevRecord: RecordType) => boolean rowSpan?: number width?: number | string minWidth?: number /** * Render a drag handle on the header cell so the user can resize the column. * Only leaf headers spanning a single column get a handle; group headers * resize through their leaves. * * - Widths are tracked by `key`, falling back to the column's position * (`key-0`, `key-1-0`, ...), so give the column a stable `key` if columns * can be reordered, added or removed. * - `minWidth` is the drag lower bound (default 40). * - Any `resizable` column switches the whole table to horizontal scrolling * (as if `scroll.x` were set, so `fixed` columns become sticky) and to * `tableLayout: 'fixed'` unless `tableLayout` is given. Resizing needs the * fixed layout: with `'auto'` (explicit, or `scroll.x: 'max-content'` with * fixed columns) a column cannot be dragged narrower than its content. * - Columns without `width` keep the width they had before the drag (at * least their `minWidth`) when a sibling is widened: the table grows and * scrolls instead of squeezing them. Narrowing a sibling still lets them * take up the freed space. * - Without `onResizeColumn` updating `columns`, the dragged width is kept * internally until the column's own `width` changes. */ resizable?: boolean onCell?: GetComponentProps /** @deprecated Please use `onCell` instead */ onCellClick?: (record: RecordType, e: MouseEvent) => void } export type ColumnsType> = readonly ( | ColumnGroupType | ColumnType )[] export type GetRowKey> = (record: RecordType, index?: number) => Key // ================= Fix Column ================= export interface StickyOffsets { start: readonly number[] end: readonly number[] widths: readonly number[] isSticky?: boolean } // ================= Customized ================= export type CellAttributes = HTMLAttributes & TdHTMLAttributes & { colSpan?: number rowSpan?: number colspan?: number rowspan?: number className?: string } // Bivariant to allow narrower record types in callbacks like onCell/onRow. export type GetComponentProps> = { bivarianceHack: (data: DataType, index?: number) => Partial }['bivarianceHack'] type Component = any export type CustomizeComponent = Component export type OnCustomizeScroll = (info: { currentTarget?: HTMLElement scrollLeft?: number }) => void export type CustomizeScrollBody> = ( data: readonly RecordType[], info: { scrollbarSize: number ref: Ref<{ scrollLeft: number, scrollTo?: (scrollConfig: ScrollConfig) => void } | null> onScroll: OnCustomizeScroll }, ) => any export interface TableComponents { ExpandIcon?: ExpandIconComponent table?: CustomizeComponent header?: { table?: CustomizeComponent wrapper?: CustomizeComponent row?: CustomizeComponent cell?: CustomizeComponent } body?: | CustomizeScrollBody | { wrapper?: CustomizeComponent row?: CustomizeComponent cell?: CustomizeComponent } } export type GetComponent = ( path: readonly string[], defaultComponent?: CustomizeComponent, ) => CustomizeComponent // =================== Expand =================== export type ExpandableType = false | 'row' | 'nest' export interface LegacyExpandableProps { /** @deprecated Use `expandable.expandedRowKeys` instead */ expandedRowKeys?: Key[] /** @deprecated Use `expandable.defaultExpandedRowKeys` instead */ defaultExpandedRowKeys?: Key[] /** @deprecated Use `expandable.expandedRowRender` instead */ expandedRowRender?: ExpandedRowRender /** @deprecated Use `expandable.expandRowByClick` instead */ expandRowByClick?: boolean /** @deprecated Use `components.ExpandIcon` instead */ expandIcon?: RenderExpandIcon /** @deprecated Use `expandable.onExpand` instead */ onExpand?: (expanded: boolean, record: RecordType) => void /** @deprecated Use `expandable.onExpandedRowsChange` instead */ onExpandedRowsChange?: (expandedKeys: Key[]) => void /** @deprecated Use `expandable.defaultExpandAllRows` instead */ defaultExpandAllRows?: boolean /** @deprecated Use `expandable.indentSize` instead */ indentSize?: number /** @deprecated Use `expandable.expandIconColumnIndex` instead */ expandIconColumnIndex?: number /** @deprecated Use `expandable.expandedRowClassName` instead */ expandedRowClassName?: RowClassName /** @deprecated Use `expandable.childrenColumnName` instead */ childrenColumnName?: string title?: PanelRender } export type ExpandedRowRender = ( record: ValueType, index: number, indent: number, expanded: boolean, ) => any export interface RenderExpandIconProps { prefixCls: string expanded: boolean record: RecordType expandable: boolean onExpand: TriggerEventHandler } export type RenderExpandIcon = ( props: RenderExpandIconProps, ) => any export type ExpandIconProps = { prefixCls: string expanded: boolean expandable: boolean onClick: (event: MouseEvent) => void } & ( | { type: 'row' record: RecordType } | { type: 'all' record?: never } ) export type ExpandIconComponent = VueComponent> export interface ExpandColumnTitleProps { expandIcon: VueNode } export type ExpandColumnTitle = VueNode | ((props: ExpandColumnTitleProps) => VueNode) export interface ExpandableConfig { expandedRowKeys?: readonly Key[] defaultExpandedRowKeys?: readonly Key[] expandedRowRender?: ExpandedRowRender forceRender?: boolean columnTitle?: ExpandColumnTitle expandRowByClick?: boolean /** @deprecated Please use `components.ExpandIcon` instead. This only customizes row icons. */ expandIcon?: RenderExpandIcon onExpand?: (expanded: boolean, record: RecordType) => void onExpandAll?: (expanded: boolean) => void onExpandedRowsChange?: (expandedKeys: readonly Key[]) => void defaultExpandAllRows?: boolean indentSize?: number /** @deprecated Please use `EXPAND_COLUMN` in `columns` directly */ expandIconColumnIndex?: number showExpandColumn?: boolean showExpandAll?: boolean expandedRowClassName?: string | RowClassName childrenColumnName?: string rowExpandable?: (record: RecordType) => boolean columnWidth?: number | string fixed?: FixedType expandedRowOffset?: number } // =================== Render =================== export type PanelRender = (data: readonly RecordType[]) => any // =================== Events =================== export type TriggerEventHandler = ( record: RecordType, event: MouseEvent, ) => void // =================== Sticky =================== export interface TableSticky { offsetHeader?: number offsetSummary?: number offsetScroll?: number getContainer?: () => Window | HTMLElement }