@qin-ui/antd-vue-pro
Version:
70 lines • 2.13 kB
TypeScript
import { ColumnType } from '../../../shared/ui';
import { Data, KeyExpandString, Paths, Path } from '../../../shared/core';
/**
* @qin-ui/antd-vue-pro 表格列配置类型
*
* @description 继承 Ant Design Vue 的 ColumnType 列类型，并添加：
* - 类型安全的 dataIndex（基于泛型 D 推导路径），优先使用
* - key 作为辅助标识，当 dataIndex 不满足需求时使用
* - hidden 属性用于控制列显隐
* - 所有 Ant Design Vue 原生的列属性依然可用（title、width、fixed、align 等）
*
* @template D - 表格行数据类型
* @public
*
* @example
* ```ts
* interface User { name: string; age: number }
*
* const columns: Columns<User> = [
* {
* // dataIndex 是主要字段，关联数据源中对应字段路径
* dataIndex: 'name',
* title: '姓名',
* width: 120,
* },
* {
* dataIndex: 'age',
* title: '年龄',
* width: 80,
* },
* ]
* ```
*/
export type Column<D extends Data = Data> = Omit<ColumnType, 'dataIndex' | 'key'> & {
/**
* @description 列数据路径（主要字段）
* 关联数据源中对应字段的路径，支持点号分隔的深层路径和数组路径。
* 优先使用 dataIndex 进行字段匹配。
*
* @example 'name' | 'address.city' | ['address', 'city']
*/
dataIndex?: KeyExpandString<Extract<keyof D, string>> | Paths<D>;
/**
* @description 列字段标识（辅助字段）
* 仅当 dataIndex 无法满足需求时使用，例如需要在自定义渲染中标识列时。
* 在字段匹配时的优先级低于 dataIndex。
*/
key?: Path<D>;
/**
* @description 是否隐藏该列
* @default false
*/
hidden?: boolean;
};
/**
* @qin-ui/antd-vue-pro 表格列配置数组类型
*
* @template D - 表格行数据类型
* @public
*
* @example
* ```ts
* const columns: Columns<User> = [
* { dataIndex: 'name', title: '姓名' },
* { dataIndex: 'age', title: '年龄' },
* ]
* ```
*/
export type Columns<D extends Data = Data> = Array<Column<D>>;
//# sourceMappingURL=index.d.ts.map