@wyfex/ivue 0.2.0 → 0.4.0

package/src/types/index.ts

@@ -1,6 +1,133 @@
 import type { Component, VNode } from 'vue'
 
+// ==================================== 渲染器相关接口 start ====================================
 /**
  * 渲染器内容类型
  */
 export type RenderContent = string | number | boolean | VNode | Component
+
+/**
+ * 渲染器配置接口
+ */
+export interface RenderConfig {
+  // 内容
+  content?: RenderContent
+  // 样式类名
+  class?: string
+  // 内联样式
+  style?: string
+  // 内联样式字段
+  styleField?: string
+  // 单位
+  unit?: string
+}
+// ==================================== 渲染器相关接口 end ====================================
+
+// ==================================== 字典相关接口 start ====================================
+/**
+ * 字典属性接口 共用于其它props配置属性
+ */
+export interface DictProps {
+  // 指定选项label为选项对象的某个属性值
+  label: string
+  // 指定选项value为选项对象的某个属性值
+  value: string
+  // 指定选项children为选项对象的某个属性值
+  children: string
+}
+
+/**
+ * 字典映射接口
+ */
+export interface DictMap {
+  // 形如：{ 性别: [{ label: '男', value: 1 },{ label: '女', value: 2 }] }
+  [key: string]: Array<{ label: string; value: string | number | boolean }>
+}
+
+/**
+ * 使用字典接口
+ */
+export interface UseDict {
+  // 字典数据 可为字符串、对象、字符串数组、数字数组、对象数组，如为string则为dictMap的key
+  data?:
+    | string
+    | Record<string, any>
+    | string[]
+    | number[]
+    | Record<string, any>[]
+  // 字典属性
+  props?: DictProps
+  // 字典类名
+  class?: string
+  // 内联样式
+  inlineStyle?: string
+  // 字典样式字段
+  styleField?: string
+  // 字典分割符 默认为逗号(,)
+  separator?: string
+}
+// ==================================== 字典相关接口 start ====================================
+
+/**
+ * 上传配置接口
+ */
+export interface UploadConfig {
+  // 上传地址
+  action?: string
+  //  请求头
+  headers?: Record<string, unknown>
+  //  上传数据
+  data?: Record<string, unknown>
+  //  其他配置项
+  [key: string]: any
+}
+
+/**
+ * 全局配置接口 其他组件声明globalConfig类型时需要
+ */
+export interface GlobalConfig {
+  // 最终语言
+  finalLanguage: string
+  // 最终主题模式
+  finalThemeMode: string
+  // 最终字典属性
+  finalDictProps: DictProps
+  // 最终字典分割符
+  finalDictDataSeparator?: string
+  // 最终表格额外高度
+  finalTableExtraHeight: number
+  // 最终上传配置
+  finalUploadConfig: UploadConfig
+}
+
+/**
+ * input事件名称类型
+ */
+export type InputEventName = 'nonNegativeDecimal'
+
+/**
+ * input事件接口
+ */
+export interface InputEvent {
+  name: InputEventName
+  digits?: number
+  cb?: Function
+}
+
+/**
+ * 编辑配置属性接口
+ */
+export interface EditAttrs {
+  // 是否追加label到placeholder后面 默认是，不需要可显式设置appendLabelToPlaceholder为false
+  appendLabelToPlaceholder?: boolean
+  // UseElSelect等组件的options
+  options?: Record<string, any>[]
+  // UseElSelect等组件的props
+  props?: DictProps
+  // change事件
+  changeEvent?: Function
+  // focus事件
+  focusEvent?: Function
+  // input事件
+  inputEvent?: Function | InputEventName | InputEvent
+}