@wyfex/ivue 0.19.0 → 0.19.1

package/src/components/UseElTable/types.ts

@@ -8,18 +8,28 @@ import componentProps from './props'
 export type Props = ExtractPropTypes<typeof componentProps>
 
 /**
- * emits接口
+ * emits类型
  */
-export interface Emits {
-  // dictKeys事件
+export type Emits = {
+  /**
+   * dictKeys事件
+   */
   (e: 'onDictKeys', value?: string[]): void
-  //  选中数据更新事件（支持 v-model:selectionData）
-  (e: 'update:selectionData', selectionData: any): void
-  // 当前行更新事件（支持 v-model:currentRow）
+  /**
+   * 选中数据更新事件 v-model:selectionData
+   */
+  (e: 'update:selectionData', selectionData: any[]): void
+  /**
+   * 当前行更新事件 v-model:currentRow
+   */
   (e: 'update:currentRow', currentRow: any): void
-  // 当前页码更新事件（支持 v-model:currentPage）
+  /**
+   * 当前页码更新事件 v-model:currentPage
+   */
   (e: 'update:currentPage', currentPage: number): void
-  // 每页条数更新事件（支持 v-model:pageSize）
+  /**
+   * 每页条数更新事件 v-model:pageSize
+   */
   (e: 'update:pageSize', pageSize: number): void
 }
 
@@ -27,9 +37,21 @@ export interface Emits {
  * EditableCell和SpanVue组件的props接口
  */
 export interface EditableCellAndSpanVueProps {
+  /**
+   * 行数据
+   */
   row: Record<string, any>
+  /**
+   * 表格配置项
+   */
   item: TableColumn
+  /**
+   * 合并后的props
+   */
   mergedProps: Props
+  /**
+   * 全局配置
+   */
   globalConfig: GlobalConfig
 }
 
@@ -37,11 +59,17 @@ export interface EditableCellAndSpanVueProps {
  * 表头配置接口
  */
 export interface Header {
-  // 表头具名插槽 为true则在模板代码中添加`<template #prop-header="{ item }"></template>`即可，可传入string自定义具名插槽名称
+  /**
+   * 表头具名插槽 为true则在模板代码中添加`<template #prop-header="{ item }"></template>`即可，可传入string自定义具名插槽名称
+   */
   slot?: boolean | string
-  // 表头是否必填，必填表头默认在表头名称前添加*号
+  /**
+   * 表头是否必填 必填表头默认在表头名称前添加*号
+   */
   required?: boolean
-  // 必填表头*号位置，默认为before
+  /**
+   * 必填表头*号位置 默认为before
+   */
   asteriskPosition?: 'before' | 'after'
 }
 
@@ -49,7 +77,13 @@ export interface Header {
  * 编辑配置接口
  */
 export interface Edit {
+  /**
+   * 组件
+   */
   component: Component
+  /**
+   * 属性
+   */
   attrs?: EditAttrs
 }
 
@@ -57,17 +91,29 @@ export interface Edit {
  * tableColumn的extConfig接口
  */
 export interface TableColumnExtConfig {
-  // 表头配置
+  /**
+   * 表头配置
+   */
   header?: Header
-  // 编辑配置
+  /**
+   * 编辑配置
+   */
   edit?: Edit
-  // 过滤器
+  /**
+   * 过滤器
+   */
   formatter?: Function
-  // 类名
+  /**
+   * 类名
+   */
   class?: string | string[]
-  // 样式
+  /**
+   * 样式
+   */
   style?: string | Record<string, unknown>
-  // 插槽 为true则在模板代码中添加`<template #prop="{ row }"></template>`即可，可传入string自定义具名插槽名称
+  /**
+   * 插槽 为true则在模板代码中添加`<template #prop="{ row }"></template>`即可，可传入string自定义具名插槽名称
+   */
   slot?: boolean | string
 }
 
@@ -75,22 +121,55 @@ export interface TableColumnExtConfig {
  * tableColumn接口
  */
 export interface TableColumn {
+  /**
+   * 表格列的标签
+   */
   label?: string
-  prop?: string //多级表头的父级表头可不传
+  /**
+   * 表格列的属性 多级表头的父级表头可不传
+   */
+  prop?: string
   /**
    * 使用字典
    * 如为boolean则将label作为dictMap的key
    * 如为string或dict.data为string则将dict或dict.data作为dictMap的key
    */
   useDict?: boolean | string | UseDict
+  /**
+   * 表格列的宽度
+   */
   width?: string | number
+  /**
+   * 表格列的最小宽度
+   */
   minWidth?: string | number
+  /**
+   * 是否显示表格列
+   */
   show?: boolean
+  /**
+   * 表格列的排列方式
+   */
   align?: string
+  /**
+   * 表格列是否固定
+   */
   fixed?: boolean | string
+  /**
+   * 表格列是否开启排序
+   */
   sortable?: boolean
+  /**
+   * 表格列溢出是否显示省略号
+   */
   showOverflowTooltip?: boolean
+  /**
+   * 表格列扩展配置
+   */
   extConfig?: TableColumnExtConfig
+  /**
+   * 表格列的子表格列
+   */
   children?: TableColumn[]
 }
 
@@ -98,16 +177,43 @@ export interface TableColumn {
  * 选择器配置项
  */
 export interface Selection {
+  /**
+   * 选择器的标签
+   */
   label?: string
-  type?: string
+  /**
+   * 选择器的类型
+   */
+  type?: 'CHECKBOX' | 'CHECKBOXRADIO' | 'RADIO'
+  /**
+   * 选择器的宽度
+   */
   width?: number
+  /**
+   * 选择器的唯一键
+   */
   key?: string
+  /**
+   * 是否允许点击行触发选择器勾选
+   */
   enableRowClick?: boolean
+  /**
+   * 自定义选择器功能函数
+   */
   selectable?: Function
+  /**
+   * 选择器禁止勾选配置
+   */
   disabledConfig?:
     | Record<string, string | number | string[] | number[]>
     | Array<{ key: string; value: string | number | string[] | number[] }>
+  /**
+   * 选择器排列方式
+   */
   align?: string
+  /**
+   * 选择器是否固定
+   */
   fixed?: boolean
 }
 
@@ -115,26 +221,64 @@ export interface Selection {
  * UseElTable的extConfig接口
  */
 export interface ExtConfig {
-  // 额外表头配置项
+  /**
+   * 额外表头配置项
+   * border：是否显示边框线 默认和el-table的border保持一致
+   * class：额外表头类名
+   * style：额外表头样式对象
+   */
   extraHeader?: {
+    border?: boolean
     class?: string
     style?: { padding?: string; borderBottom?: string }
   }
-  // 高度配置项
-  heightAdaptive?: {
-    isModal?: boolean
-    modalFooterHeight?: number
-    bottomOffset?: number
-  }
-  // 选择器配置项
+  /**
+   * 模式配置项
+   * type：模式类型 可选值：PAGE(页面) | MODAL(弹窗)
+   * height：表格高度 不设置则默认高度自适应，该配置项设置的是UseELTable组件整体高度，非ElTable组件的高度
+   * bottomOffset：表格高度自适应表格底部预留偏移 该配置项由UseElConfigProvider组件统一提供默认值
+   */
+  mode?: { type?: 'PAGE' | 'MODAL'; height?: string; bottomOffset?: number }
+  /**
+   * 选择器配置项
+   * 绑定v-model:selectionData="selectionData"则开启选择器 不显式设置type则默认为CHECKBOX复选
+   * type：选择类型 可选值：CHECKBOX(复选) | CHECKBOXRADIO(复选框单选) | RADIO(单选)
+   * label：type为CHECKBOXRADIO、RADIO时表头全选复选框的文本 不设置则为空显示
+   * key：选中数据的唯一键 对应tableData中的唯一键 如id
+   * selectable：决定当前行复选框是否可以勾选 传入function，如果是简单禁用逻辑推荐优先使用disabledConfig配置项，复杂逻辑才建议使用本配置项
+   * disabledConfig：禁用配置 可传对象或对象数组
+   * enableRowClick：允许通过点击行触发单选/复选 默认否 PS：默认不高亮当前行，若需高亮当前行，只需给UseElTable组件设置highlightCurrentRow属性即可
+   * width：选择器的列宽 默认为40px
+   * align：选择器的排列方式 默认为center居中
+   * fixed：是否固定 默认为true
+   */
   selection?: Selection
-  // 序号列配置项
+  /**
+   * 序号列配置项
+   * label：序号列表头文本 不显式设置则不显示序号列
+   * width、align、fixed同选择器配置项
+   */
   index?: { label?: string; width?: number; align?: string; fixed?: boolean }
-  // 展开列配置项
+  /**
+   * 展开列配置项
+   * show：是否显示展开列
+   * width：展开列宽度
+   */
   expand?: { show?: boolean; width?: number }
-  // 操作列配置项
+  /**
+   * 操作列配置项
+   * label：操作列文案 显式设置则开启操作列
+   * width：操作列宽度 默认为128px
+   * fixed：固定方向 默认固定在右侧
+   */
   operation?: { label?: string; width?: number; fixed?: string }
-  // 分页器配置项
+  /**
+   * 分页器配置项
+   * total：分页总数 为-1时不显示分页器
+   * marginTop：分页器与表格的间距 默认20px
+   * func：分页方法 显式设置则在组件内部自动处理分页逻辑
+   * position：分页器位置 默认为right 可选值:left | center | right
+   */
   pagination?: {
     total?: number
     marginTop?: number

package/src/types/index.ts

@@ -1,6 +1,6 @@
 import type { Component, VNode } from 'vue'
 
-// ==================================== 渲染器相关接口 start ====================================
+// =========================== 渲染器相关接口 start ===========================
 /**
  * 渲染器内容类型
  */
@@ -17,29 +17,45 @@ export type RenderContent =
  * 渲染器配置接口
  */
 export interface RenderConfig {
-  // 内容
+  /**
+   * 内容
+   */
   content?: RenderContent
-  // 样式类名
+  /**
+   * 样式类名
+   */
   class?: string
-  // 内联样式
+  /**
+   * 内联样式
+   */
   style?: string
-  // 内联样式字段
+  /**
+   * 内联样式字段
+   */
   styleField?: string
-  // 单位
+  /**
+   * 单位
+   */
   unit?: string
 }
-// ==================================== 渲染器相关接口 end ====================================
+// =========================== 渲染器相关接口 end ===========================
 
-// ==================================== 字典相关接口 start ====================================
+// =========================== 字典相关接口 start ===========================
 /**
  * 字典属性接口 共用于其它props配置属性
  */
 export interface DictProps {
-  // 指定选项label为选项对象的某个属性值
+  /**
+   * 指定选项label为选项对象的某个属性值
+   */
   label: string
-  // 指定选项value为选项对象的某个属性值
+  /**
+   * 指定选项value为选项对象的某个属性值
+   */
   value: string
-  // 指定选项children为选项对象的某个属性值
+  /**
+   * 指定选项children为选项对象的某个属性值
+   */
   children: string
 }
 
@@ -47,44 +63,63 @@ export interface DictProps {
  * 字典映射接口
  */
 export interface DictMap {
-  // 形如：{ 性别: [{ label: '男', value: 1 },{ label: '女', value: 2 }] }
+  /**
+   * 形如：{ 性别: [{ label: '男', value: 1 },{ label: '女', value: 2 }] }
+   */
   [key: string]: Record<DictProps['label'] | DictProps['value'], any>[]
 }
-// export interface DictMap {
-//   // 形如：{ 性别: [{ label: '男', value: 1 },{ label: '女', value: 2 }] }
-//   [key: string]: Array<{ label: string; value: string | number | boolean }>
-// }
 
 /**
  * 使用字典接口
  */
 export interface UseDict {
-  // 字典key 即dictMap的key，如为boolean则以label作为dictMap的key
+  /**
+   * 字典key 即dictMap的key，为boolean则以label作为dictMap的key
+   */
   key?: string | boolean
-  // 字典属性
+  /**
+   * 字典属性
+   */
   props?: DictProps
-  // 字典类名
+  /**
+   * 字典类名
+   */
   class?: string
-  // 内联样式
+  /**
+   * 内联样式
+   */
   inlineStyle?: string
-  // 字典样式字段
+  /**
+   * 字典样式字段
+   */
   styleField?: string
-  // 字典分割符 默认为逗号(,)
+  /**
+   * 字典分割符 默认为逗号(,)
+   */
   separator?: string
 }
-// ==================================== 字典相关接口 start ====================================
+// =========================== 字典相关接口 end ===========================
 
+// =========================== 其他接口 start ===========================
 /**
  * 上传配置接口
  */
 export interface UploadConfig {
-  // 上传地址
+  /**
+   * 上传地址
+   */
   action?: string
-  //  请求头
+  /**
+   * 请求头
+   */
   headers?: Record<string, unknown>
-  //  上传数据
+  /**
+   * 上传数据
+   */
   data?: Record<string, unknown>
-  //  其他配置项
+  /**
+   * 其他配置项
+   */
   [key: string]: any
 }
 
@@ -92,17 +127,37 @@ export interface UploadConfig {
  * 全局配置接口 其他组件声明globalConfig类型时需要
  */
 export interface GlobalConfig {
-  // 最终语言
+  /**
+   * 最终语言
+   */
   finalLanguage: string
-  // 最终字典属性
+  /**
+   * 最终字典属性
+   */
   finalDictProps: DictProps
-  // 最终字典映射
+  /**
+   * 最终字典映射
+   */
   finalDictMap: DictMap
-  // 最终表格底部预留偏移
-  finalTableBottomOffset: number
-  // 最终表格弹窗底部操作栏固定高度，isModal=true生效
-  finalTableModalFooterHeight?: number
-  // 最终上传配置
+  /**
+   * 最终表格页面高度
+   */
+  finalTablePageHeight: string
+  /**
+   * 最终表格弹窗高度
+   */
+  finalTableModalHeight: string
+  /**
+   * 最终表格页面底部预留偏移
+   */
+  finalTablePageBottomOffset: number
+  /**
+   * 最终表格弹窗底部预留偏移 tableMode=modal生效
+   */
+  finalTableModalBottomOffset: number
+  /**
+   * 最终上传配置
+   */
   finalUploadConfig: UploadConfig
 }
 
@@ -115,8 +170,17 @@ export type InputEventName = 'nonNegativeDecimal'
  * input事件接口
  */
 export interface InputEvent {
+  /**
+   * input事件名称
+   */
   name: InputEventName
+  /**
+   * 保留的小数位数
+   */
   digits?: number
+  /**
+   * 回调函数
+   */
   cb?: Function
 }
 
@@ -124,16 +188,30 @@ export interface InputEvent {
  * 编辑配置属性接口
  */
 export interface EditAttrs {
-  // 是否追加label到placeholder后面 默认是，不需要可显式设置appendLabelToPlaceholder为false
+  /**
+   * 是否追加label到placeholder后面 默认是
+   * 不需要可显式设置appendLabelToPlaceholder为false
+   */
   appendLabelToPlaceholder?: boolean
-  // UseElSelect等组件的options
+  /**
+   * UseElSelect等组件的options
+   */
   options?: Record<string, any>[]
-  // UseElSelect等组件的props
+  /**
+   * UseElSelect等组件的props
+   */
   props?: DictProps
-  // change事件
+  /**
+   * change事件
+   */
   changeEvent?: Function
-  // focus事件
+  /**
+   * focus事件
+   */
   focusEvent?: Function
-  // input事件
+  /**
+   * input事件
+   */
   inputEvent?: Function | InputEventName | InputEvent
 }
+// =========================== 其他接口 end ===========================

package/dist/types/UseElTable/hooks/useTableHeightAdaptive.d.ts

@@ -1,11 +0,0 @@
-import { ComputedRef, Ref } from 'vue';
-import { Props } from '../types';
-import { GlobalConfig } from '../../../types';
-export declare const useTableHeightAdaptive: ({ rootRef, tableWrapperRef, mergedProps, globalConfig }: {
-    rootRef: Ref<HTMLDivElement | null>;
-    tableWrapperRef: Ref<HTMLDivElement | null>;
-    mergedProps: ComputedRef<Props>;
-    globalConfig: ComputedRef<GlobalConfig>;
-}) => {
-    tableRealHeight: Ref<string, string>;
-};

package/dist/useLog-DrLGlf1g.js

@@ -1 +0,0 @@
-var e={primary:`color:#1677ff;font-weight:bold;`,success:`color:#52c41a;font-weight:bold;`,warn:`color:#fa8c14;font-weight:bold;`,error:`color:#f5222d;font-weight:bold;`,block:`color:#4e5969;font-weight:bold;`,json:`color:#20b2aa;font-weight:bold;`},t={primary:`🔧`,success:`✅`,warn:`⚠️`,error:`❌`,block:`📦`,json:`📄`},n=`background:#000; padding:10px 8px;`,r=r=>{let i=(i,a,o,s)=>{let c=`${t[i]} [${r}]`;if(!s||o===void 0){console.log(`%c${c}%c ${a}`,e[i],``,o);return}let l=JSON.stringify(o,null,2);console.log(`%c${c}%c ${a}\n%c${l}`,e[i],``,n)};return{primary:(e,t,n)=>i(`primary`,e,t,n),success:(e,t,n)=>i(`success`,e,t,n),warn:(e,t,n)=>i(`warn`,e,t,n),error:(e,t,n)=>i(`error`,e,t,n),block:(i,a,o)=>{console.log(`%c- - - - - - - - - - - - - - - - - - - - - - -`,`color:#888`);let s=`${t.block} [${r}]`;if(!o||a===void 0)console.log(`%c${s}%c ${i}`,e.block,``,a);else{let t=JSON.stringify(a,null,2);console.log(`%c${s}%c ${i}\n%c${t}`,e.block,``,n)}console.log(`%c- - - - - - - - - - - - - - - - - - - - - - -`,`color:#888`)},json:(i,a)=>{let o=`${t.json} [${r}]`,s=JSON.stringify(a,null,2);console.log(`%c${o}%c ${i}\n%c${s}`,e.json,``,n)}}};export{r as useLog};