zhytech-ui 1.0.8 → 1.0.10

package/README.md

@@ -1,16 +1,18 @@
 # zhytechUI
-**介绍：一个基于Vue3 + ElementPlus + TypeScript封装的公司内部组件库**
 
-**组件列表：**
-> ### dynamicForm
+> ### 简介
+一个基于Vue3 + ElementPlus + TypeScript封装的公司内部组件库
+
+> ### 组件列表
+#### 1、dynamicForm
 此组件为动态表单组件，目前包含基础组件：文本、输入框、单选框、复选框、评分、文件上传、图片上传；高级组件：分组面板、公司人员选择组件、公司岗位选择组件。
 通过拖拽设计表单或试卷，以减少开发时间，此组件提供一个表单设计器和表单渲染器。
  
-> ### dynamicFilter
+#### 2、dynamicFilter
 此组件为动态条件组件，支持传入多组项目、支持不同项目自定义不同的条件，支持子条件，支持无限嵌套
 
-### 使用说明
-##### 1、安装
+> ### 使用说明
+#### 1、安装
 ```ts
 npm i zhytech-ui -S
 ```
@@ -18,10 +20,10 @@ npm i zhytech-ui -S
 ```ts
 npm i zhytech-ui@latest -S
 ```
-##### 2、引入使用
+#### 2、引入使用
 1)、按需引入：在要使用的页面添加下面代码即可
 ```ts
-import { dynamicFormData,dynamicFilter } from "zhytech-ui"
+import { ZhyFormDesigner, ZhyFormRenderer } from "zhytech-ui"
 ```
 2)、全局引入：在项目内任何页面都不需要单独引入
 ```ts
@@ -30,8 +32,15 @@ import "../node_modules/zhytech-ui/dist/style.css";
 createApp(app).use(zhytechUI)
 ```
 
-**注意：此组件css样式依赖scss开发，使用者项目还需要添加scss依赖**
+#### 2、使用组件
+```html
+   <zhy-form-designer :formData="formData"></zhy-form-designer>
+```
+
+> #### 注意：
+1)、此组件库提供的所有组件在使用时均需要添加**zhy**前缀，如：zhy-form-designer
 
+2)、此组件css样式依赖scss开发，使用者项目还需要添加scss依赖。
 
 > #### 后续计划：
-此组件还是一个雏形，后续会继续添加组件
+此组件库目前还处于雏形，后续会继续添加组件

package/dist/src/components/dynamicFilter/index.d.ts

@@ -0,0 +1,4 @@
+import { default as dynamicFilter } from './index.vue';
+export { dynamicFilter };
+export type { conditionType };
+type conditionType = keyof typeof filterConditionTypes;

package/dist/src/components/dynamicForm/types/baseComponent.d.ts

@@ -0,0 +1,67 @@
+type conditionType = keyof typeof filterConditionTypes;
+export default class baseComponent {
+    /**
+     * @description: 是否为编辑类组件
+     */
+    isEdit: boolean;
+    /**
+     * @description: 是否为输入型编辑类组件
+     */
+    isInput: boolean;
+    /**
+     * @description: 类型
+     */
+    type: string;
+    /**
+     * @description: 名称
+     */
+    name: string;
+    /**
+     * @description: 组件唯一标识
+     */
+    id: string;
+    /**
+     * @description: 业务字典项目编号
+     */
+    itemID?: string;
+    /**
+     * @description: 业务字典项目来源
+     */
+    itemSourceType?: string;
+    /**
+     * @description: 组件校验条件
+     */
+    rules: Record<string, any>[];
+    /**
+     * @description: 组件属性
+     */
+    props: Record<string, any>;
+    /**
+     * @description: 组件要排除的过滤条件集合
+     * 参数说明：EQUALS:等于; NOT_EQUALS:不等于; GREATER_THAN:大于; LESS_THAN:小于;
+     * GREATER_THAN_OR_EQUALS:大于等于; LESS_THAN_OR_EQUALS:小于等于;
+     * EMPTY:为空; INCLUDES:包含; EXCLUDE:不包含; RANGE:范围
+     */
+    excludeFilterConditions: conditionType[];
+    /**
+     * @description: 组件过滤参数
+     */
+    filterConditionProps: Record<string, any> | undefined;
+    /**
+     * @description: 是否为布局组件
+     */
+    isLayout: boolean;
+    /**
+     * @description:布局组件的子组件集合
+     */
+    children: Record<string, any>[] | undefined;
+    /**
+     * @description: 构造器
+     * @param type 组件类型
+     * @param name 组件名称
+     * @param isEdit 是否为编辑类组件,默认为false
+     * @param isInput 是否为输入型编辑类组件,默认为false
+     */
+    constructor(type: string, name: string, isEdit?: boolean, isInput?: boolean);
+}
+export {};

package/dist/src/components/icon/index.d.ts

@@ -0,0 +1,2 @@
+import { default as icon } from './index.vue';
+export { icon };

package/dist/src/components/icon/index.vue.d.ts

@@ -0,0 +1,31 @@
+declare const _default: import('vue').DefineComponent<{
+    name: {
+        type: StringConstructor;
+        required: true;
+    };
+    size: {
+        type: StringConstructor;
+        default: string;
+    };
+    color: {
+        type: StringConstructor;
+        default: string;
+    };
+}, {}, unknown, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<globalThis.ExtractPropTypes<{
+    name: {
+        type: StringConstructor;
+        required: true;
+    };
+    size: {
+        type: StringConstructor;
+        default: string;
+    };
+    color: {
+        type: StringConstructor;
+        default: string;
+    };
+}>>, {
+    color: string;
+    size: string;
+}, {}>;
+export default _default;

package/dist/src/index.d.ts

@@ -1,7 +1,8 @@
-import { conditionType, dynamicFilter } from './components/dynamicFilter/index';
-import { batchAddComponentParam, documentView, dynamicFormData, formAttribute, GetFormTemplateMethod, uploadOption, formDesigner, formRenderer } from './components/dynamicForm/index';
+import { conditionType, dynamicFilter as ZhyDynamicFilter } from './components/dynamicFilter/index';
+import { batchAddComponentParam, documentView, dynamicFormData, formAttribute, GetFormTemplateMethod, uploadOption, formDesigner as ZhyFormDesigner, formRenderer as ZhyFormRenderer } from './components/dynamicForm/index';
+import { icon as ZhyIcon } from './components/icon/index';
 export type { conditionType, dynamicFormData, formAttribute, uploadOption, documentView, batchAddComponentParam, GetFormTemplateMethod };
-export { formDesigner, formRenderer, dynamicFilter };
+export { ZhyIcon, ZhyFormDesigner, ZhyFormRenderer, ZhyDynamicFilter };
 declare const _default: {
     install: (app: any, options?: Record<string, any> | undefined) => void;
 };

package/dist/src/types/enum.d.ts

@@ -1,28 +1,28 @@
 /**
  * 消息类型
  */
-export declare enum MessageType {
+declare enum MessageType {
     /**
      * 成功消息
      */
-    success = 0,
+    success,
     /**
      * 警告消息
      */
-    warning = 1,
+    warning,
     /**
      * 错误消息
      */
-    error = 2,
+    error,
     /**
      * 普通消息
      */
-    info = 3
+    info
 }
 /**
  * 过滤条件组件类型
  */
-export declare enum filterConditionTypes {
+declare enum filterConditionTypes {
     /**
      * 等于=
      */

package/dist/src/utils/message.d.ts

@@ -0,0 +1,34 @@
+type MType = keyof typeof MessageType;
+/**
+ * @description: 提示信息
+ * @param type 类型
+ * @param message 消息内容
+ * @return
+ */
+export declare const showMessage: (type: MType, message: string) => void;
+/**
+ * @description: 弹窗
+ * @param type 类型
+ * @param message 消息内容
+ * @param title 消息标题
+ * @param btnName 按钮显示文字
+ * @return
+ */
+export declare const showAlert: (type: MType, message: string, title?: string, btnName?: string) => Promise<import('element-plus').MessageBoxData>;
+/**
+ * @description: 确认弹窗
+ * @param message 消息内容
+ * @param title 消息标题
+ * @param callback 回调函数
+ * @param btnName 按钮显示文字
+ * @return
+ */
+export declare const confirmBox: (message: string, title: string, callback?: Function, btnName?: string) => Promise<void>;
+/**
+ * @description: 删除确认框
+ * @param message 消息内容
+ * @param callback 回调韩式
+ * @return
+ */
+export declare const deleteConfirm: (message: string, callback: Function) => Promise<void>;
+export {};