@wyfex/ivue 0.21.0 → 0.22.0

package/src/components/UseElForm/types.ts

@@ -1,4 +1,5 @@
 import type { ExtractPropTypes } from 'vue'
+import type { FormInstance } from 'element-plus'
 import componentProps from './props'
 import type { RenderConfig, UseDict } from '@/types'
 
@@ -74,45 +75,25 @@ export interface InputConfig {
   resize?: string
   showPassword?: boolean
   placeholder?: string
-  /**
-   * 默认el-input的width为100% 可设置width为''或具体宽度值，为''则使用默认的el-input宽度
-   */
+  /** 默认el-input的width为100% 可设置width为''或具体宽度值，为''则使用默认的el-input宽度 */
   width?: string
-  /**
-   * 为true则对el-input使用v-focus聚焦指令
-   */
+  /** 为true则对el-input使用v-focus聚焦指令 */
   autoFocus?: boolean
-  /**
-   * el-input头部插槽内容
-   */
+  /** el-input头部插槽内容 */
   prefixContent?: string | object
-  /**
-   * el-input尾部插槽内容
-   */
+  /** el-input尾部插槽内容 */
   suffixContent?: string | object
-  /**
-   * el-input前置插槽内容
-   */
+  /** el-input前置插槽内容 */
   prependContent?: string | object
-  /**
-   * el-input后置插槽内容
-   */
+  /** el-input后置插槽内容 */
   appendContent?: string | object
-  /**
-   * 在el-input右外部显示单位
-   */
+  /** 在el-input右外部显示单位 */
   unit?: string | object
-  /**
-   * el-input的clear事件
-   */
+  /** el-input的clear事件 */
   onClear?: Function
-  /**
-   * el-input的input事件
-   */
+  /** el-input的input事件 */
   inputEvent?: Function
-  /**
-   * el-input的keyup.enter事件
-   */
+  /** el-input的keyup.enter事件 */
   onKeyupEnter?: Function
 }
 
@@ -127,9 +108,7 @@ export interface InputNumberConfig {
   precision?: number
   placeholder?: string
   disabledScientific?: boolean
-  /**
-   * 在el-input-number右外部显示单位
-   */
+  /** 在el-input-number右外部显示单位 */
   unit?: string | object
 }
 
@@ -138,21 +117,13 @@ export interface InputNumberConfig {
  */
 export interface RadioConfig {
   useRender?: boolean | RenderConfig
-  /**
-   * el-radio的选项集
-   */
+  /** el-radio的选项集 */
   options?: Array<{ label: string; value: string | number }>
-  /**
-   * el-radio的props配置项
-   */
+  /** el-radio的props配置项 */
   props?: { value: string; label?: string }
-  /**
-   * 是否反转单选框和标签的位置
-   */
+  /** 是否反转单选框和标签的位置 */
   reverse?: boolean
-  /**
-   * el-radio的change事件
-   */
+  /** el-radio的change事件 */
   onChange?: Function
 }
 
@@ -167,25 +138,15 @@ export interface SelectConfig {
   placeholder?: string
   options?: Array<{ label: string; value: string | number }>
   props?: { value: string; label?: string }
-  /**
-   * 是否使用v2版本
-   */
+  /** 是否使用v2版本 */
   useV2: boolean
-  /**
-   * 是否反转
-   */
+  /** 是否反转 */
   reverse?: boolean
-  /**
-   * 是否将值为数组转为以逗号分隔的字符串
-   */
+  /** 是否将值为数组转为以逗号分隔的字符串 */
   toJoin?: boolean
-  /**
-   * 默认el-select的width为100% 可设置width为''或具体宽度值，为''则使用默认的el-select宽度
-   */
+  /** 默认el-select的width为100% 可设置width为''或具体宽度值，为''则使用默认的el-select宽度 */
   width?: string
-  /**
-   * el-select的change事件
-   */
+  /** el-select的change事件 */
   onChange?: Function
 }
 
@@ -195,21 +156,13 @@ export interface SelectConfig {
 export interface CascaderConfig {
   useRender?: boolean | RenderConfig
   clearable?: boolean
-  /**
-   * el-cascader的选项集
-   */
+  /** el-cascader的选项集 */
   options?: Array<{ label: string; value: string | number }>
-  /**
-   * el-cascader的props配置项
-   */
+  /** el-cascader的props配置项 */
   props?: { value: string; label?: string }
-  /**
-   * 默认el-cascader的width为100% 可设置width为''或具体宽度值，为''则使用默认的el-cascader宽度
-   */
+  /** 默认el-cascader的width为100% 可设置width为''或具体宽度值，为''则使用默认的el-cascader宽度 */
   width?: string
-  /**
-   * el-select的change事件
-   */
+  /** el-select的change事件 */
   onChange?: Function
 }
 
@@ -239,21 +192,13 @@ export interface DatePickerConfig {
   startPlaceholder?: string
   endPlaceholder?: string
   rangeSeparator?: string
-  /**
-   * 默认el-date-picker的width为100% 可设置width为''或具体宽度值，为''则使用默认的el-date-picker宽度
-   */
+  /** 默认el-date-picker的width为100% 可设置width为''或具体宽度值，为''则使用默认的el-date-picker宽度 */
   width?: string
-  /**
-   * el-date-picker的calendar-change事件
-   */
+  /** el-date-picker的calendar-change事件 */
   onCalendarChange?: Function
-  /**
-   * el-date-picker的clear事件
-   */
+  /** el-date-picker的clear事件 */
   onClear?: Function
-  /**
-   * el-date-picker的change事件
-   */
+  /** el-date-picker的change事件 */
   onChange?: Function
 }
 
@@ -269,9 +214,7 @@ export interface TimePickerConfig {
   editable?: boolean
   format?: string
   valueFormat?: string
-  /**
-   * el-date-picker的change事件
-   */
+  /** el-date-picker的change事件 */
   onChange?: Function
 }
 
@@ -280,13 +223,9 @@ export interface TimePickerConfig {
  */
 export interface TimeSelectConfig {
   useRender?: boolean | RenderConfig
-  /**
-   * 时间选择范围开始时间在formModel中的属性名
-   */
+  /** 时间选择范围开始时间在formModel中的属性名 */
   startProp: string
-  /**
-   * 时间选择范围结束时间在formModel中的属性名
-   */
+  /** 时间选择范围结束时间在formModel中的属性名 */
   endProp: string
 }
 
@@ -297,9 +236,7 @@ export interface SwitchConfig {
   useRender?: boolean | RenderConfig
   activeValue?: string | number | boolean
   inactiveValue?: string | number | boolean
-  /**
-   * el-switch的change事件
-   */
+  /** el-switch的change事件 */
   onChange?: Function
 }
 
@@ -307,13 +244,9 @@ export interface SwitchConfig {
  * inputRangeConfig接口
  */
 export interface InputRangeConfig {
-  /**
-   * 输入范围开始值在formModel中的属性名
-   */
+  /** 输入范围开始值在formModel中的属性名 */
   startProp: string
-  /**
-   * 输入范围结束值在formModel中的属性名
-   */
+  /** 输入范围结束值在formModel中的属性名 */
   endProp: string
   startPlaceholder?: string
   endPlaceholder?: string
@@ -327,9 +260,7 @@ export interface InputRangeConfig {
 export interface TreeSelectConfig {
   useRender?: boolean | RenderConfig
   data: Record<string, unknown>[]
-  /**
-   * 是否反转
-   */
+  /** 是否反转 */
   reverse?: boolean
   width?: string
   placeholder?: string
@@ -340,18 +271,15 @@ export interface TreeSelectConfig {
   defaultExpandedKeys?: Array<string | number>
 }
 
+/**
+ * 必填配置项
+ */
 export interface IRequired {
-  /**
-   * 是否必填
-   */
+  /** 是否必填 */
   isRequired?: boolean
-  /**
-   * 内置校验器
-   */
+  /** 内置校验器 */
   validator: 'mobile' | 'nonNegativeDecimal'
-  /**
-   * 参数
-   */
+  /** 参数 */
   parmas?: any
 }
 
@@ -474,3 +402,9 @@ export interface FormColumn {
    */
   inputRangeConfig?: InputRangeConfig
 }
+
+export interface FormComponentInstance {
+  efRef: FormInstance
+  showQueryForm: boolean
+  handleDisplayQueryForm: Function
+}

package/src/components/UseElInput/types.ts

@@ -7,11 +7,9 @@ import componentProps from './props'
 export type Props = ExtractPropTypes<typeof componentProps>
 
 /**
- * emits接口
+ * emits类型
  */
-export interface Emits {
-  /**
-   * 更新value值
-   */
+export type Emits = {
+  /** 更新value值 */
   (e: 'update:modelValue', value: string): void
 }

package/src/components/UseElSelect/types.ts

@@ -7,15 +7,11 @@ import componentProps from './props'
 export type Props = ExtractPropTypes<typeof componentProps>
 
 /**
- * emits接口
+ * emits类型
  */
-export interface Emits {
-  /**
-   * 更新value值
-   */
+export type Emits = {
+  /** 更新value值 */
   (e: 'update:modelValue', value: string | number | (string | number)[]): void
-  /**
-   * 更新label值
-   */
+  /** 更新label值 */
   (e: 'update:label', label: string | string[]): void
 }

package/src/components/UseElTable/props.ts

@@ -38,7 +38,7 @@ export default {
     validator: (val: string) => ['left', 'center', 'right'].includes(val)
   },
   /**
-   * 字典映射 数据结构为{ tableColumns[][label | useDict | useDict.data]: Array<{ label: string, value: any }> }
+   * 字典映射 数据结构为{ tableColumns[][label | useDict | useDict.key]: Array<{ label: string, value: any }> }
    */
   dictMap: {
     type: Object as PropType<DictMap>,

package/src/components/UseElUpload/types.ts

@@ -7,9 +7,9 @@ import componentProps from './props'
 export type Props = ExtractPropTypes<typeof componentProps>
 
 /**
- * emits接口
+ * emits类型
  */
-export interface Emits {
+export type Emits = {
   'update:fileId': [value: string | number]
   'update:linkUrl': [url: string]
   onFileObj: [file: Record<string, any>]

package/src/components/UseLineTitle/defaultExtConfig.ts

@@ -4,26 +4,14 @@ import type { ExtConfig } from './types'
  * 默认扩展配置
  */
 export default {
-  /**
-   * 外边距配置项
-   */
-  margin: {
-    top: '0px',
-    bottom: '20px'
-  },
-  /**
-   * 线条配置项
-   */
+  margin: { top: '0px', bottom: '20px' },
   line: {
-    width: '4px', //作用于position为left和bottom
-    height: '2px', //作用于position为between
+    width: '4px',
+    height: '2px',
     color: 'var(--theme-color,var(--el-color-primary))',
     position: 'left',
     verticalPadding: '0px'
   },
-  /**
-   * 底部border配置项
-   */
   borderBottom: {
     show: false,
     color: 'var(--el-border-color-light)',

package/src/components/UseLineTitle/types.ts

@@ -10,7 +10,9 @@ export type Props = ExtractPropTypes<typeof componentProps>
  * 线条接口
  */
 export interface Line {
+  /** 作用于position为left和bottom */
   width: string
+  /** 作用于position为between */
   height: string
   color: string
   position: 'left' | 'bottom' | 'between'

package/src/types/index.ts

@@ -17,25 +17,15 @@ export type RenderContent =
  * 渲染器配置接口
  */
 export interface RenderConfig {
-  /**
-   * 内容
-   */
+  /** 内容 */
   content?: RenderContent
-  /**
-   * 样式类名
-   */
+  /** 样式类名 */
   class?: string
-  /**
-   * 内联样式
-   */
+  /** 内联样式 */
   style?: string
-  /**
-   * 内联样式字段
-   */
+  /** 内联样式字段 */
   styleField?: string
-  /**
-   * 单位
-   */
+  /** 单位 */
   unit?: string
 }
 // =========================== 渲染器相关接口 end ===========================
@@ -45,17 +35,11 @@ export interface RenderConfig {
  * 字典属性接口 共用于其它props配置属性
  */
 export interface DictProps {
-  /**
-   * 指定选项label为选项对象的某个属性值
-   */
+  /** 指定选项label为选项对象的某个属性值 */
   label: string
-  /**
-   * 指定选项value为选项对象的某个属性值
-   */
+  /** 指定选项value为选项对象的某个属性值 */
   value: string
-  /**
-   * 指定选项children为选项对象的某个属性值
-   */
+  /** 指定选项children为选项对象的某个属性值 */
   children: string
 }
 
@@ -63,9 +47,7 @@ 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>[]
 }
 
@@ -73,29 +55,17 @@ export interface DictMap {
  * 使用字典接口
  */
 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
 }
 // =========================== 字典相关接口 end ===========================
@@ -105,21 +75,13 @@ export interface UseDict {
  * 上传配置接口
  */
 export interface UploadConfig {
-  /**
-   * 上传地址
-   */
+  /** 上传地址 */
   action?: string
-  /**
-   * 请求头
-   */
+  /** 请求头 */
   headers?: Record<string, unknown>
-  /**
-   * 上传数据
-   */
+  /** 上传数据 */
   data?: Record<string, unknown>
-  /**
-   * 其他配置项
-   */
+  /** 其他配置项 */
   [key: string]: any
 }
 
@@ -127,45 +89,25 @@ export interface UploadConfig {
  * 全局配置接口 其他组件声明globalConfig类型时需要
  */
 export interface GlobalConfig {
-  /**
-   * 最终语言
-   */
+  /** 最终语言 */
   finalLanguage: string
-  /**
-   * 最终字典属性
-   */
+  /** 最终字典属性 */
   finalDictProps: DictProps
-  /**
-   * 最终字典映射
-   */
+  /** 最终字典映射 */
   finalDictMap: DictMap
-  /**
-   * 最终crud表格页面高度
-   */
+  /** 最终crud表格页面高度 */
   finalCrudTablePageHeight: string
-  /**
-   * 最终crud表格弹窗高度
-   */
+  /** 最终crud表格弹窗高度 */
   finalCrudTableModalHeight: string
-  /**
-   * 最终表格页面高度
-   */
+  /** 最终表格页面高度 */
   finalTablePageHeight: string
-  /**
-   * 最终表格弹窗高度
-   */
+  /** 最终表格弹窗高度 */
   finalTableModalHeight: string
-  /**
-   * 最终表格页面底部预留偏移
-   */
+  /** 最终表格页面底部预留偏移 */
   finalTablePageBottomOffset: number
-  /**
-   * 最终表格弹窗底部预留偏移 tableMode=modal生效
-   */
+  /** 最终表格弹窗底部预留偏移 tableMode=modal生效 */
   finalTableModalBottomOffset: number
-  /**
-   * 最终上传配置
-   */
+  /** 最终上传配置 */
   finalUploadConfig: UploadConfig
 }
 
@@ -178,17 +120,11 @@ export type InputEventName = 'nonNegativeDecimal'
  * input事件接口
  */
 export interface InputEvent {
-  /**
-   * input事件名称
-   */
+  /** input事件名称 */
   name: InputEventName
-  /**
-   * 保留的小数位数
-   */
+  /** 保留的小数位数 */
   digits?: number
-  /**
-   * 回调函数
-   */
+  /** 回调函数 */
   cb?: Function
 }
 
@@ -196,30 +132,17 @@ 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 ===========================