@yidun/antd-super-table 0.0.4 → 0.0.6

package/dist/typings.ts

@@ -0,0 +1,318 @@
+import type { SelectProps, TableProps, PaginationProps } from 'ant-design-vue'
+import type { Component, Reactive, Ref } from 'vue'
+
+/** 表格列对应的type类型 */
+export type SuperTableColumnType = 'text' | 'link' | 'button' | 'tag' | 'image' | 'component' | 'sort'
+
+/** 查询表单项对应的type类型 */
+export type SuperTableFormItemType =
+  | 'input'
+  | 'inputGroup'
+  | 'inputNumber'
+  | 'inputNumberRange'
+  | 'select'
+  | 'treeSelect'
+  | 'cascader'
+  | 'datePicker'
+  | 'rangePicker'
+  | 'component'
+
+/* 查询条件配置 */
+export interface SuperTableFormItem {
+  /** 查询详类型 */
+  type: SuperTableFormItemType
+
+  /** 查询项对应的字段名称 */
+  name: string
+
+  /** 绑定数据时v-model对应的name，默认value */
+  modelPropName?: string
+
+  /** 查询项label */
+  label: string
+
+  /** 传递给查询详的props */
+  props?: Record<string, any>
+
+  /** 选项值 */
+  value?: any
+
+  /** 自定义组件 */
+  component?: Component
+
+  /** 查询项宽度系数 */
+  span?: number
+
+  /** 是否显示 */
+  visible?: boolean
+
+  /** 带select前缀的组合输入框配置 */
+  addonBeforeProps?: SelectProps
+
+  /** 改变时保持静默，不要触发搜索*/
+  quiet?: boolean
+
+  /** 是否展示label，默认展示 */
+  showLabel?: boolean
+
+  /** 固定选项，不允许删除，高级搜索时一定会默认展示 */
+  fixed?: boolean
+
+  /**
+   * 默认选中，开启后表现为
+   * 1. 高级搜索弹窗打开时会默认选中对应的搜索项
+   * 2. 没有配置默认场景时，会根据选中的项目生成一个默认场景 */
+  selected?: boolean
+
+  // 以下为内置属性，不允许修改
+
+  /** 默认值 */
+  _defaultValue?: any
+
+  /** 排序 */
+  _order?: number
+
+  /** 是否选中 */
+  _selected?: boolean
+
+  /** 在选中场景中的排序 */
+  _orderInScene?: number
+
+  [key: string]: any
+}
+
+/** 表格单条数据 */
+export type TableDataItem = Record<string, any>
+
+/** 表格列吸附方式 */
+export type TableColumnFixedType = 'left' | 'right'
+
+/** 排序方式 */
+export type SortOrders = 'ascending' | 'descending' | null
+
+/** 表格表头配置 */
+export interface SuperTableColumn {
+  /** 列对应key */
+  key: string
+
+  /** 展示类型 text: 文本 button: 按钮 link: 链接 tag: 标签 component：自定义组件 */
+  type?: SuperTableColumnType | ((row: TableDataItem, index: number) => SuperTableColumnType)
+
+  /** 标题 */
+  title: string
+
+  /** 标题对应的提示信息 */
+  titleTooltip?: string | ((row: TableDataItem, index: number) => string)
+
+  /** 表格内容 */
+  content?: string | ((row: TableDataItem, index: number) => any)
+
+  /** 表格内容对应的提示信息 */
+  tooltip?: string | boolean | ((row: TableDataItem, index: number) => string)
+
+  /** 表格内容解析自定义组件 */
+  component?: Component
+
+  /** 表格内容解析用到的组件组件对应的props */
+  props?: Record<string, any> | ((row: TableDataItem, index: number) => Record<string, any>)
+
+  /** 是否可复制 */
+  copyable?: boolean
+
+  /** 是否超出显示省略号 */
+  ellipsis?: boolean
+
+  /** 是否可见 */
+  visible?: boolean
+
+  /** 宽度 */
+  width?: number
+
+  [key: string]: any
+}
+
+/**
+ * 查询场景 https://docs.popo.netease.com/lingxi/1f2fdcb62291477f8056457f63fa3fcd?appVersion=4.15.0&deviceType=4&popo_hidenativebar=1&popo_noindicator=1&disposable_login_token=1
+ * */
+export interface SuperTableQueryScene {
+  /** 场景唯一标识 */
+  code: string
+
+  /** 场景名称 */
+  name: string
+
+  /** 配置类型 */
+  type?: string
+
+  /** 配置详情 */
+  value?: string
+
+  /** 查询项列表 */
+  items: SuperTableQuerySceneItem[]
+
+  /** 是否是私有配置 */
+  asPrivate?: boolean
+
+  /** 是否是自定义场景 */
+  isCustom?: boolean
+}
+
+/** 场景中保存的查询条件配置 */
+export interface SuperTableQuerySceneItem {
+  /** 字段名称 */
+  name: string
+
+  /** 字段类型 */
+  type: string
+
+  /** 字段值 */
+  value: any
+}
+
+/** 默认场景配置 */
+export interface DefaultSceneConfig {
+  /** 场景名称 */
+  name?: string
+
+  /** 场景唯一表示，多个自定义场景时必填 */
+  code?: string
+
+  /** 查询项列表 */
+  items: {
+    /** 字段名称 */
+    name: string
+    /** 字段值 */
+    value: any
+  }[]
+}
+
+/** 场景状态 */
+export interface SuperTableSceneState {
+  /** 查询场景列表 */
+  list: SuperTableQueryScene[]
+
+  /** 是否正在加载场景 */
+  loading: boolean
+
+  /** 是否正在保存场景 */
+  submiting: boolean
+
+  /** 是否已经加载过场景 */
+  loaded: boolean
+}
+
+/** 提供给弹窗使用的表格全局状态 */
+export interface SuperTableContext {
+  /** 场景类型 */
+  sceneType: string
+
+  /** 场景状态 */
+  sceneState: Reactive<SuperTableSceneState>
+
+  /** 查询场景 */
+  queryScene(): void
+
+  /** 新增/更新场景 */
+  updateScene(scene: SuperTableQueryScene | SuperTableQueryScene[]): void
+
+  /** 删除场景 */
+  deleteScene(sceneCode: string): void
+
+  /** 当前生效中的查询参数 */
+  selectedFormItems: SuperTableQuerySceneItem[]
+
+  /** 禁用添加场景功能 */
+  allowCreateScene: Ref<boolean>
+}
+
+/** 数据请求方法 */
+export type PropTableRequestFunction = (options: {
+  /** 查询参数 */
+  params: Record<string, any>
+
+  /** 分页大小 */
+  pageSize?: number
+
+  /** 当前页码 */
+  pageNum?: number
+
+  [key: string]: any
+}) => Promise<{ total: number; data: Record<string, any>[] }>
+
+export interface AntdTableProps extends TableProps {
+  pagination: PaginationProps
+  columns: SuperTableColumn[]
+  dataSource: Record<string, any>[]
+}
+
+/** 表单操作方法接口 */
+export interface FormOperations {
+  /**
+   * 获取表单项配置
+   * @param {string} name - 表单项名称
+   * @returns {SuperTableFormItem | undefined} 表单项配置
+   */
+  getFormItem(name: string): SuperTableFormItem | undefined
+
+  /**
+   * 设置表单项配置
+   * @param {string} name - 表单项名称
+   * @param {string} keyPath - 配置路径
+   * @param {any} newConfig - 新的配置值
+   * @returns {void}
+   */
+  setFormItem(name: string, keyPath: string, newConfig: any): void
+
+  /**
+   * 获取表单值
+   * @param {string | string[]} [name] - 表单项名称或名称数组，不传则获取所有值
+   * @returns {Record<string, any>} 表单值对象
+   */
+  getFormValues(name?: string | string[]): Record<string, any>
+
+  /**
+   * 设置表单值
+   * @param {Record<string, any>} values - 要设置的表单值对象
+   * @returns {void}
+   */
+  setFormValues(values: Record<string, any>): void
+
+  /**
+   * 获取单个表单项值
+   * @param {string} name - 表单项名称
+   * @returns {any} 表单项值
+   */
+  getFormValue(name: string): any
+
+  /**
+   * 设置单个表单项值
+   * @param {string} name - 表单项名称
+   * @param {any} value - 要设置的值
+   * @returns {void}
+   */
+  setFormValue(name: string, value: any): void
+}
+
+/** 表格操作方法接口 */
+export interface TableOperations {
+  /**
+   * 获取表格数据
+   * @returns {any[]} 表格数据数组
+   */
+  getTableData(): any[]
+
+  /**
+   * 设置表格数据
+   * @param {any[]} data - 要设置的表格数据
+   * @returns {void}
+   */
+  setTableData(data: any[]): void
+
+  /**
+   * 设置表格数据项
+   * @param {number} index - 数据项索引
+   * @param {Record<string, any>} data - 要设置的数据项
+   * @returns {void}
+   */
+  setTableDataItem(index: number, data: Record<string, any>): void
+}

package/dist/utils/index.d.ts

@@ -15,7 +15,7 @@ export declare const initFormItems: (formItems: SuperTableFormItem[]) => {
     visible: boolean;
     _order: number;
     _defaultValue: any;
-    type: import("../typings").SuperTableFormItemType;
+    type: import("..").SuperTableFormItemType;
     name: string;
     modelPropName?: string;
     label: string;
@@ -46,12 +46,12 @@ export declare const initTableColumns: (columns: SuperTableColumn[]) => {
     }> | undefined;
     index: number;
     key: string;
-    type?: import("../typings").SuperTableColumnType | ((row: import("../typings").TableDataItem, index: number) => import("../typings").SuperTableColumnType);
+    type?: import("..").SuperTableColumnType | ((row: import("..").TableDataItem, index: number) => import("..").SuperTableColumnType);
     title: string;
-    titleTooltip?: string | ((row: import("../typings").TableDataItem, index: number) => string);
-    content?: string | ((row: import("../typings").TableDataItem, index: number) => any);
-    tooltip?: string | boolean | ((row: import("../typings").TableDataItem, index: number) => string);
-    props?: Record<string, any> | ((row: import("../typings").TableDataItem, index: number) => Record<string, any>);
+    titleTooltip?: string | ((row: import("..").TableDataItem, index: number) => string);
+    content?: string | ((row: import("..").TableDataItem, index: number) => any);
+    tooltip?: string | boolean | ((row: import("..").TableDataItem, index: number) => string);
+    props?: Record<string, any> | ((row: import("..").TableDataItem, index: number) => Record<string, any>);
     copyable?: boolean;
 }[];
 /**

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "@yidun/antd-super-table",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "type": "module",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
     "dist",
+    "example.png",
     "README.md"
   ],
   "scripts": {
     "dev": "vite",
-    "build": "vite build --mode lib && tsc --emitDeclarationOnly && cp src/typings.d.ts dist/",
+    "build": "vite build --mode lib && tsc --emitDeclarationOnly && cp src/typings.ts dist/",
     "preview": "vite preview",
     "tsc": "tsc --noEmit --project tsconfig.json",
     "lint": "eslint src --fix",
@@ -49,6 +50,7 @@
     "sass": "^1.87.0",
     "typescript": "~5.8.0",
     "vite": "^6.2.4",
+    "vite-plugin-css-injected-by-js": "^3.5.2",
     "vite-plugin-vue-devtools": "^7.7.2",
     "vue-tsc": "^2.2.8"
   }