fast-element-plus 1.0.0 → 1.0.2

package/es/components/table/src/table.type.d.ts

@@ -0,0 +1,316 @@
+import { FaTableState } from './table.state';
+import { FaLayoutGridBreakPoint, FaLayoutGridItemResponsive } from '../../layoutGrid';
+import { TableColumnCtx } from 'element-plus';
+import { VNode } from 'vue';
+/** @description FaTable 默认插槽返回 */
+export type FaTableDefaultSlotsResult = {
+    loading: boolean;
+    searchParam: any;
+    selected: boolean;
+    selectedList: any[];
+    selectedListIds: (string | number)[];
+    indeterminateSelectedListIds: (string | number)[];
+    /** @description 可能为空 */
+    search?: () => void;
+};
+/** @description 获取 FaTable 默认插槽返回数据 */
+export declare const getTableDefaultSlots: (state: FaTableState) => FaTableDefaultSlotsResult;
+/** @description 日期范围 */
+export type FaTableDataRange = "Past1D" | "Past3D" | "Past1W" | "Past1M" | "Past3M" | "Past6M" | "Past1Y" | "Past3Y";
+/** @description FaTable 表格枚举列上下文 */
+export type FaTableEnumColumnCtx = {
+    /**
+     * 选项框显示的文字
+     */
+    label: string;
+    /**
+     * 选项框值
+     */
+    value: string | number | boolean;
+    /**
+     * 显示
+     */
+    show?: boolean;
+    /**
+     * 是否禁用此选项
+     */
+    disabled?: boolean;
+    /**
+     * 为树形选择是，可以通过 children 属性指定子选项
+     */
+    children?: FaTableEnumColumnCtx[];
+    /**
+     * 提示
+     */
+    tips?: string;
+    /**
+     * Tag的类型，默认 "primary"
+     */
+    type?: "primary" | "success" | "info" | "warning" | "danger";
+};
+/** @description FaTable 表格枚举列类型 */
+export type FaTableEnumColumnType = FaTableEnumColumnCtx[] | ((...args: any[]) => Promise<FaTableEnumColumnCtx[]>);
+/** @description FaTable 表格搜素列组件 */
+export type FaTableSearchColumnEl = "" | "el-input" | "el-input-number" | "el-select" | "el-select-v2" | "el-tree-select" | "el-cascader" | "el-date-picker" | "el-time-picker" | "el-time-select" | "el-switch" | "el-slider" | "slot";
+/** @description FaTable 表格搜素列上下文 */
+export type FaTableSearchColumnCtx = Partial<Record<FaLayoutGridBreakPoint, FaLayoutGridItemResponsive>> & {
+    /**
+     * 当前项搜索框的类型
+     */
+    el: FaTableSearchColumnEl | string;
+    /**
+     * 搜索项参数，根据 element plus 官方文档来传递，该属性所有值会透传到组件
+     */
+    props?: any;
+    /**
+     * 当搜索项 label 不为列 label 属性时，可通过 label 指定
+     */
+    label?: string;
+    /**
+     * 当搜索项 key 不为 prop 属性时，可通过 key 指定
+     */
+    key?: string;
+    /**
+     * 搜索项排序（从大到小）
+     */
+    order?: number;
+    /**
+     * 搜索项所占用的列数，默认为1列
+     */
+    span?: number;
+    /**
+     * 搜索字段左侧偏移列数
+     */
+    offset?: number;
+    /**
+     * 插槽名称
+     */
+    slot?: string;
+    /**
+     * 搜索项默认值
+     */
+    defaultValue?: string | number | boolean | any[];
+};
+/**
+ * @description 表格列类型
+ * @property default     默认
+ * @property selection	 选择列
+ * @property expand      可展开按钮列
+ * @property expand      可展开按钮列
+ * @property image       图片列
+ * @property date        日期显示（格式 "YYYY-MM-DD"）
+ * @property time        时间显示（格式 "HH:mm:ss"）
+ * @property dateTime    日期时间显示（格式 "YYYY-MM-DD HH:mm:ss"）
+ * @property d2          数值列，保留 2 位小数，不带千分位
+ * @property d4          数值列，保留 4 位小数，不带千分位
+ * @property d6          数值列，保留 6 位小数，不带千分位
+ * @property gd2         数值列，保留 2 位小数，带千分位
+ * @property gd4         数值列，保留 4 位小数，带千分位
+ * @property gd6         数值列，保留 6 位小数，带千分位
+ * @property submitInfo  提交信息列
+ */
+export type FaTableColumnType = "default" | "selection" | "index" | "expand" | "image" | "date" | "time" | "dateTime" | "d2" | "d4" | "d6" | "gd2" | "gd4" | "gd6" | "submitInfo";
+/** @description FaTable 表格列日期格式化 */
+export type FaTableColumnDateFormat = "YYYY-MM-DD HH:mm:ss" | "YYYY-MM-DD HH:mm" | "YYYY-MM-DD" | "YYYY-MM" | "YYYY" | "MM" | "DD" | "MM-DD" | "HH:mm:ss" | "HH:mm" | "HH" | "mm:ss" | "mm" | "ss";
+/** @description FaTable 表格列上下文 */
+export type FaTableColumnCtx<T = any> = Partial<Omit<TableColumnCtx<T>, "order" | "type" | "prop" | "sortable" | "_children">> & {
+    /**
+     * 内部的计算属性，一般不做使用
+     * @description FaTable
+     */
+    multiOrder?: "" | "ascending" | "descending";
+    /**
+     * 列ID
+     * @description FaTable
+     */
+    columnID?: number;
+    /**
+     * 排序
+     * @description FaTable
+     */
+    order?: number;
+    /**
+     * 排序字段
+     * @description FaTable
+     */
+    sortableField?: string;
+    /**
+     * 禁用排序配置
+     * @description FaTable
+     */
+    disabledSortable?: boolean;
+    /**
+     * 合并行字段
+     * @description FaTable
+     */
+    spanProp?: string;
+    /**
+     * 纯搜索
+     * @description FaTable
+     */
+    pureSearch?: boolean;
+    /**
+     * 搜索项配置
+     * @description FaTable
+     */
+    search?: FaTableSearchColumnCtx;
+    /** 上面所有属性，全部非 FaTableColumns props，均为计算属性 */
+    /**
+     * 对应列的类型
+     */
+    type?: FaTableColumnType;
+    /**
+     * 字段名称
+     */
+    prop?: string;
+    /**
+     * 是否显示在表格当中，默认 true
+     */
+    show?: boolean;
+    /**
+     * 对应列是否可以排序，
+     * 默认为 'custom' 模式，即远程排序，
+     * 需要监听 Table 的 sort-change 事件
+     */
+    sortable?: boolean;
+    /**
+     * 小页面的宽度，如果为空，则继承默认宽度
+     */
+    smallWidth?: string | number;
+    /**
+     * 自适应宽度
+     */
+    autoWidth?: boolean;
+    /**
+     * 插槽名称
+     */
+    slot?: string;
+    /**
+     * 表格头部插槽名称
+     */
+    headerSlot?: string;
+    /**
+     * 自定义表头内容渲染（tsx语法）
+     */
+    headerRender?: ({ column, $index }: {
+        column: TableColumnCtx<any>;
+        $index: number;
+    } & FaTableDefaultSlotsResult) => VNode[];
+    /**
+     * 自定义单元格内容渲染（tsx语法）
+     */
+    render?: ({ row, column, $index }: {
+        row: any;
+        column: FaTableColumnCtx;
+        $index: number;
+    } & FaTableDefaultSlotsResult) => VNode[];
+    /**
+     * 多级表头
+     */
+    _children?: FaTableColumnCtx<T>[];
+    /**
+     * 复制
+     */
+    copy?: boolean;
+    /**
+     * 是否为 Link Button
+     */
+    link?: boolean;
+    /**
+     * 点击事件，优先级最高
+     */
+    click?: ({ row, $index }: {
+        row: T;
+        $index?: number;
+    } & FaTableDefaultSlotsResult) => void;
+    /**
+     * 点击Emits事件回调
+     */
+    clickEmit?: string;
+    /**
+     * 显示时间格式化字符串，默认 false
+     */
+    dateFix?: boolean;
+    /**
+     * 显示在页面中的日期格式
+     */
+    dateFormat?: FaTableColumnDateFormat;
+    /**
+     * 是否是标签展示，默认 false
+     */
+    tag?: boolean;
+    /**
+     * 枚举类型（渲染值的字典）
+     */
+    enum?: FaTableEnumColumnType;
+    /**
+     * 数据删除字段，如果为 true 会显示遮罩层
+     */
+    dataDeleteField?: string;
+    /**
+     * 提交信息字段
+     */
+    submitInfoField?: {
+        submitClerkName?: string;
+        submitTime?: string;
+    };
+};
+/** @description FaTable 表格列改变上下文 */
+export type FaTableChangeColumnsCtx = {
+    /**
+     * 列ID
+     */
+    columnID?: number;
+    /**
+     * 名称
+     */
+    label?: string;
+    /**
+     * 固定(可空)
+     * left：左侧
+     * right：右侧
+     */
+    fixed?: any;
+    /**
+     * 宽度
+     */
+    width?: string | number;
+    /**
+     * 小的宽度
+     */
+    smallWidth?: string | number;
+    /**
+     * 顺序
+     */
+    order?: number;
+    /**
+     * 是否排序
+     */
+    sortable?: boolean;
+    /**
+     * 复制
+     */
+    copy?: boolean;
+    /**
+     * 自动宽度
+     */
+    autoWidth?: boolean;
+    /**
+     * 是否显示
+     */
+    show?: boolean;
+    /**
+     * 搜索项配置
+     * @description FaTable
+     */
+    search?: {
+        /**
+         * 名称
+         */
+        label?: string;
+        /**
+         * 顺序
+         */
+        order?: number;
+    };
+};

package/es/components/table/src/table.type.mjs

@@ -0,0 +1,2 @@
+const e=e=>({loading:e.loading,searchParam:e.searchParam,selected:e.selected,selectedList:e.selectedList,selectedListIds:e.selectedListIds,indeterminateSelectedListIds:e.indeterminateSelectedListIds});export{e as getTableDefaultSlots};
+//# sourceMappingURL=table.type.mjs.map

package/es/components/table/src/table.type.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"table.type.mjs","sources":["../../../../../packages/components/table/src/table.type.ts"],"sourcesContent":["import type { FaTableState } from \"./table.state\";\nimport type { FaLayoutGridBreakPoint, FaLayoutGridItemResponsive } from \"@fast-element-plus/components/layoutGrid\";\nimport type { TableColumnCtx } from \"element-plus\";\nimport type { VNode } from \"vue\";\n\n/** @description FaTable 默认插槽返回 */\nexport type FaTableDefaultSlotsResult = {\n\tloading: boolean;\n\tsearchParam: any;\n\tselected: boolean;\n\tselectedList: any[];\n\tselectedListIds: (string | number)[];\n\tindeterminateSelectedListIds: (string | number)[];\n\t/** @description 可能为空 */\n\tsearch?: () => void;\n};\n\n/** @description 获取 FaTable 默认插槽返回数据 */\nexport const getTableDefaultSlots = (state: FaTableState): FaTableDefaultSlotsResult => {\n\treturn {\n\t\tloading: state.loading,\n\t\tsearchParam: state.searchParam,\n\t\tselected: state.selected,\n\t\tselectedList: state.selectedList,\n\t\tselectedListIds: state.selectedListIds,\n\t\tindeterminateSelectedListIds: state.indeterminateSelectedListIds,\n\t};\n};\n\n/** @description 日期范围 */\nexport type FaTableDataRange = \"Past1D\" | \"Past3D\" | \"Past1W\" | \"Past1M\" | \"Past3M\" | \"Past6M\" | \"Past1Y\" | \"Past3Y\";\n\n/** @description FaTable 表格枚举列上下文 */\nexport type FaTableEnumColumnCtx = {\n\t/**\n\t * 选项框显示的文字\n\t */\n\tlabel: string;\n\t/**\n\t * 选项框值\n\t */\n\tvalue: string | number | boolean;\n\t/**\n\t * 显示\n\t */\n\tshow?: boolean;\n\t/**\n\t * 是否禁用此选项\n\t */\n\tdisabled?: boolean;\n\t/**\n\t * 为树形选择是，可以通过 children 属性指定子选项\n\t */\n\tchildren?: FaTableEnumColumnCtx[];\n\t/**\n\t * 提示\n\t */\n\ttips?: string;\n\t/**\n\t * Tag的类型，默认 \"primary\"\n\t */\n\ttype?: \"primary\" | \"success\" | \"info\" | \"warning\" | \"danger\";\n};\n\n/** @description FaTable 表格枚举列类型 */\nexport type FaTableEnumColumnType = FaTableEnumColumnCtx[] | ((...args) => Promise<FaTableEnumColumnCtx[]>);\n\n/** @description FaTable 表格搜素列组件 */\nexport type FaTableSearchColumnEl =\n\t| \"\"\n\t| \"el-input\"\n\t| \"el-input-number\"\n\t| \"el-select\"\n\t| \"el-select-v2\"\n\t| \"el-tree-select\"\n\t| \"el-cascader\"\n\t| \"el-date-picker\"\n\t| \"el-time-picker\"\n\t| \"el-time-select\"\n\t| \"el-switch\"\n\t| \"el-slider\"\n\t| \"slot\";\n\n/** @description FaTable 表格搜素列上下文 */\nexport type FaTableSearchColumnCtx = Partial<Record<FaLayoutGridBreakPoint, FaLayoutGridItemResponsive>> & {\n\t/**\n\t * 当前项搜索框的类型\n\t */\n\tel: FaTableSearchColumnEl | string;\n\t/**\n\t * 搜索项参数，根据 element plus 官方文档来传递，该属性所有值会透传到组件\n\t */\n\tprops?: any;\n\t/**\n\t * 当搜索项 label 不为列 label 属性时，可通过 label 指定\n\t */\n\tlabel?: string;\n\t/**\n\t * 当搜索项 key 不为 prop 属性时，可通过 key 指定\n\t */\n\tkey?: string;\n\t/**\n\t * 搜索项排序（从大到小）\n\t */\n\torder?: number;\n\t/**\n\t * 搜索项所占用的列数，默认为1列\n\t */\n\tspan?: number;\n\t/**\n\t * 搜索字段左侧偏移列数\n\t */\n\toffset?: number;\n\t/**\n\t * 插槽名称\n\t */\n\tslot?: string;\n\t/**\n\t * 搜索项默认值\n\t */\n\tdefaultValue?: string | number | boolean | any[];\n};\n\n/**\n * @description 表格列类型\n * @property default     默认\n * @property selection\t 选择列\n * @property expand      可展开按钮列\n * @property expand      可展开按钮列\n * @property image       图片列\n * @property date        日期显示（格式 \"YYYY-MM-DD\"）\n * @property time        时间显示（格式 \"HH:mm:ss\"）\n * @property dateTime    日期时间显示（格式 \"YYYY-MM-DD HH:mm:ss\"）\n * @property d2          数值列，保留 2 位小数，不带千分位\n * @property d4          数值列，保留 4 位小数，不带千分位\n * @property d6          数值列，保留 6 位小数，不带千分位\n * @property gd2         数值列，保留 2 位小数，带千分位\n * @property gd4         数值列，保留 4 位小数，带千分位\n * @property gd6         数值列，保留 6 位小数，带千分位\n * @property submitInfo  提交信息列\n */\nexport type FaTableColumnType =\n\t| \"default\"\n\t| \"selection\"\n\t| \"index\"\n\t| \"expand\"\n\t| \"image\"\n\t| \"date\"\n\t| \"time\"\n\t| \"dateTime\"\n\t| \"d2\"\n\t| \"d4\"\n\t| \"d6\"\n\t| \"gd2\"\n\t| \"gd4\"\n\t| \"gd6\"\n\t| \"submitInfo\";\n\n/** @description FaTable 表格列日期格式化 */\nexport type FaTableColumnDateFormat =\n\t| \"YYYY-MM-DD HH:mm:ss\"\n\t| \"YYYY-MM-DD HH:mm\"\n\t| \"YYYY-MM-DD\"\n\t| \"YYYY-MM\"\n\t| \"YYYY\"\n\t| \"MM\"\n\t| \"DD\"\n\t| \"MM-DD\"\n\t| \"HH:mm:ss\"\n\t| \"HH:mm\"\n\t| \"HH\"\n\t| \"mm:ss\"\n\t| \"mm\"\n\t| \"ss\";\n\n/** @description FaTable 表格列上下文 */\nexport type FaTableColumnCtx<T = any> = Partial<Omit<TableColumnCtx<T>, \"order\" | \"type\" | \"prop\" | \"sortable\" | \"_children\">> & {\n\t/**\n\t * 内部的计算属性，一般不做使用\n\t * @description FaTable\n\t */\n\tmultiOrder?: \"\" | \"ascending\" | \"descending\";\n\t/**\n\t * 列ID\n\t * @description FaTable\n\t */\n\tcolumnID?: number;\n\t/**\n\t * 排序\n\t * @description FaTable\n\t */\n\torder?: number;\n\t/**\n\t * 排序字段\n\t * @description FaTable\n\t */\n\tsortableField?: string;\n\t/**\n\t * 禁用排序配置\n\t * @description FaTable\n\t */\n\tdisabledSortable?: boolean;\n\t/**\n\t * 合并行字段\n\t * @description FaTable\n\t */\n\tspanProp?: string;\n\t/**\n\t * 纯搜索\n\t * @description FaTable\n\t */\n\tpureSearch?: boolean;\n\t/**\n\t * 搜索项配置\n\t * @description FaTable\n\t */\n\tsearch?: FaTableSearchColumnCtx;\n\t/** 上面所有属性，全部非 FaTableColumns props，均为计算属性 */\n\t/**\n\t * 对应列的类型\n\t */\n\ttype?: FaTableColumnType;\n\t/**\n\t * 字段名称\n\t */\n\tprop?: string;\n\t/**\n\t * 是否显示在表格当中，默认 true\n\t */\n\tshow?: boolean;\n\t/**\n\t * 对应列是否可以排序，\n\t * 默认为 'custom' 模式，即远程排序，\n\t * 需要监听 Table 的 sort-change 事件\n\t */\n\tsortable?: boolean;\n\t/**\n\t * 小页面的宽度，如果为空，则继承默认宽度\n\t */\n\tsmallWidth?: string | number;\n\t/**\n\t * 自适应宽度\n\t */\n\tautoWidth?: boolean;\n\t/**\n\t * 插槽名称\n\t */\n\tslot?: string;\n\t/**\n\t * 表格头部插槽名称\n\t */\n\theaderSlot?: string;\n\t/**\n\t * 自定义表头内容渲染（tsx语法）\n\t */\n\theaderRender?: ({ column, $index }: { column: TableColumnCtx<any>; $index: number } & FaTableDefaultSlotsResult) => VNode[];\n\t/**\n\t * 自定义单元格内容渲染（tsx语法）\n\t */\n\trender?: ({ row, column, $index }: { row: any; column: FaTableColumnCtx; $index: number } & FaTableDefaultSlotsResult) => VNode[];\n\t/**\n\t * 多级表头\n\t */\n\t_children?: FaTableColumnCtx<T>[];\n\t/**\n\t * 复制\n\t */\n\tcopy?: boolean;\n\t/**\n\t * 是否为 Link Button\n\t */\n\tlink?: boolean;\n\t/**\n\t * 点击事件，优先级最高\n\t */\n\tclick?: ({ row, $index }: { row: T; $index?: number } & FaTableDefaultSlotsResult) => void;\n\t/**\n\t * 点击Emits事件回调\n\t */\n\tclickEmit?: string;\n\t/**\n\t * 显示时间格式化字符串，默认 false\n\t */\n\tdateFix?: boolean;\n\t/**\n\t * 显示在页面中的日期格式\n\t */\n\tdateFormat?: FaTableColumnDateFormat;\n\t/**\n\t * 是否是标签展示，默认 false\n\t */\n\ttag?: boolean;\n\t/**\n\t * 枚举类型（渲染值的字典）\n\t */\n\tenum?: FaTableEnumColumnType;\n\t/**\n\t * 数据删除字段，如果为 true 会显示遮罩层\n\t */\n\tdataDeleteField?: string;\n\t/**\n\t * 提交信息字段\n\t */\n\tsubmitInfoField?: { submitClerkName?: string; submitTime?: string };\n};\n\n/** @description FaTable 表格列改变上下文 */\nexport type FaTableChangeColumnsCtx = {\n\t/**\n\t * 列ID\n\t */\n\tcolumnID?: number;\n\t/**\n\t * 名称\n\t */\n\tlabel?: string;\n\t/**\n\t * 固定(可空)\n\t * left：左侧\n\t * right：右侧\n\t */\n\tfixed?: any;\n\t/**\n\t * 宽度\n\t */\n\twidth?: string | number;\n\t/**\n\t * 小的宽度\n\t */\n\tsmallWidth?: string | number;\n\t/**\n\t * 顺序\n\t */\n\torder?: number;\n\t/**\n\t * 是否排序\n\t */\n\tsortable?: boolean;\n\t/**\n\t * 复制\n\t */\n\tcopy?: boolean;\n\t/**\n\t * 自动宽度\n\t */\n\tautoWidth?: boolean;\n\t/**\n\t * 是否显示\n\t */\n\tshow?: boolean;\n\t/**\n\t * 搜索项配置\n\t * @description FaTable\n\t */\n\tsearch?: {\n\t\t/**\n\t\t * 名称\n\t\t */\n\t\tlabel?: string;\n\t\t/**\n\t\t * 顺序\n\t\t */\n\t\torder?: number;\n\t};\n};\n"],"names":["getTableDefaultSlots","state","loading","searchParam","selected","selectedList","selectedListIds","indeterminateSelectedListIds"],"mappings":"AAkBO,MAAMA,EAAwBC,IAC7B,CACNC,QAASD,EAAMC,QACfC,YAAaF,EAAME,YACnBC,SAAUH,EAAMG,SAChBC,aAAcJ,EAAMI,aACpBC,gBAAiBL,EAAMK,gBACvBC,6BAA8BN,EAAMM"}