uview-ultra-plus 1.0.0

package/uview-ultra/components/up-form/up-form.uvue

@@ -0,0 +1,248 @@
+<template>
+	<view class="up-form">
+		<slot />
+	</view>
+</template>
+
+<script lang="uts">
+	import { propsForm } from "./props.uts";
+	import { mpMixin } from '../../libs/mixin/mpMixin.uts';
+	import { mixin } from '../../libs/mixin/mixin.uts';
+	import Schema from "../../libs/util/async-validator.uts";
+	import { toast, getProperty, setProperty, deepClone } from '../../libs/function/index.uts';
+	import { array as testArray } from '../../libs/function/test.uts';
+	// 去除警告信息
+	Schema.warning = function() {};
+	/**
+	 * Form 表单
+	 * @description 此组件一般用于表单场景，可以配置Input输入框，Select弹出框，进行表单验证等。
+	 * @tutorial https://ijry.github.io/uview-plus/components/form.html
+	 * @property {Object}						model			当前form的需要验证字段的集合
+	 * @property {Object | Function | Array}	rules			验证规则
+	 * @property {String}						errorType		错误的提示方式，见上方说明 ( 默认 message )
+	 * @property {Boolean}						borderBottom	是否显示表单域的下划线边框   ( 默认 true ）
+	 * @property {String}						labelPosition	表单域提示文字的位置，left-左侧，top-上方 ( 默认 'left' ）
+	 * @property {String | Number}				labelWidth		提示文字的宽度，单位px  ( 默认 45 ）
+	 * @property {String}						labelAlign		lable字体的对齐方式   ( 默认 'left' ）
+	 * @property {Object}						labelStyle		lable的样式，对象形式
+	 * @example <up-formlabelPosition="left" :model="model1" :rules="rules" ref="form1"></up-form>
+	 */
+	export default {
+		name: "up-form",
+		mixins: [mpMixin, mixin, propsForm],
+		provide() {
+			return {
+				upForm: this,
+			};
+		},
+		data() {
+			return {
+				formRules: {} as UTSJSONObject,
+				// 规则校验器
+				validator: {} as Schema,
+				// 原始的model快照，用于resetFields方法重置表单时使用
+				originalModel: null as UTSJSONObject | null,
+			};
+		},
+		watch: {
+			// 监听规则的变化
+			rules: {
+				immediate: true,
+				handler(n: any) {
+					this.setRules(n);
+				},
+			},
+			// 监听属性的变化，通知子组件up-form-item重新获取信息
+			propsChange() {
+				if (this!.children?.length) {
+					this!.children!.map((child: ComponentPublicInstance) => {
+						// 判断子组件(up-form-item)如果有updateParentData方法的话，就就执行(执行的结果是子组件重新从父组件拉取了最新的值)
+						//if(typeof child.updateParentData == "function") {
+							child.$callMethod('updateParentData')
+						//}
+					});
+				}
+			},
+			// 监听model的初始值作为重置表单的快照
+			model: {
+				immediate: true,
+				handler(n: any) {
+					if (!this.originalModel) {
+						this.originalModel = deepClone(n);
+					}
+				},
+			},
+		},
+		computed: {
+			propsChange() {
+				return [
+					this.errorType,
+					this.borderBottom,
+					this.labelPosition,
+					this.labelWidth,
+					this.labelAlign,
+					this.labelStyle,
+				];
+			},
+		},
+		created() {
+			// 存储当前form下的所有up-form-item的实例
+			// 不能定义在data中，否则微信小程序会造成循环引用而报错
+			// this.children = [] as Array<any>;
+		},
+		methods: {
+			// 手动设置校验的规则，如果规则中有函数的话，微信小程序中会过滤掉，所以只能手动调用设置规则
+			setRules(rules: any) {
+				// 判断是否有规则
+				if (Object.keys(rules).length === 0) return;
+				if (process.env.NODE_ENV === 'development' && Object.keys(this.model).length === 0) {
+					console.error('设置rules，model必须设置！如果已经设置，请刷新页面。');
+					return;
+				};
+				this.formRules = rules;
+				// 重新将规则赋予Validator
+				this.validator = new Schema(rules);
+			},
+			// 清空所有up-form-item组件的内容，本质上是调用了up-form-item组件中的resetField()方法
+			resetFields() {
+				this.resetModel();
+			},
+			// 重置model为初始值的快照
+			resetModel(obj?: any) {
+				// 历遍所有up-form-item，根据其prop属性，还原model的原始快照
+				this!.children!.map((child: ComponentPublicInstance) => {
+					const prop = child.$props['prop'];
+					const value = getProperty(this.originalModel as UTSJSONObject, prop);
+					setProperty(this.model, prop, value);
+				});
+			},
+			// 清空校验结果
+			clearValidate(props: any) {
+				props = [].concat(props);
+				this!.children!.map((child: ComponentPublicInstance) => {
+					// 如果up-form-item的prop在props数组中，则清除对应的校验结果信息
+					if (props[0] === undefined || props.includes(child.prop)) {
+						child.$data['message'] = null;
+					}
+				});
+			},
+			// 对部分表单字段进行校验
+			async validateField(value: any, callback: Function, event: any = null) {
+				// $nextTick是必须的，否则model的变更，可能会延后于此方法的执行
+				// 校验错误信息，返回给回调方法，用于存放所有form-item的错误信息
+				const errorsRes: any[] = [];
+				// 如果为字符串，转为数组
+				value = [].concat(value);
+				// 历遍children所有子form-item
+				let promises = this!.children!.map((child: ComponentPublicInstance) => {
+					return new Promise((resolve, reject) => {
+						// 用于存放form-item的错误信息
+						const childErrors: any[] = [];
+						if (value.includes(child.$props['prop'])) {
+							// 获取对应的属性，通过类似'a.b.c'的形式
+							const propertyVal = getProperty(
+								this.model,
+								child.$props['prop']
+							);
+							// 属性链数组
+							const propertyChain = child.$props['prop'].split(".");
+							const propertyName =
+								propertyChain[propertyChain.length - 1];
+
+							let rule = []
+							if (child.$data['itemRules'] && child.$data['itemRules'].length > 0) {
+								rule = child.$data['itemRules']
+							} else {
+								rule = this.formRules[child.$props['prop']];
+							}
+							// 如果不存在对应的规则，直接返回，否则校验器会报错
+							if (rule == null || rule.length == 0) {
+								resolve([])
+								return;
+							}
+							// rule规则可为数组形式，也可为对象形式，此处拼接成为数组
+							const rules = [].concat(rule);
+
+							// 对rules数组进行校验
+							// if (rules.length > 0‌) {
+							// 	resolve([])
+							// }
+							for (let i = 0; i < rules.length; i++) {
+								const ruleItem = rules[i];
+								// 将up-form-item的触发器转为数组形式
+								const trigger = [].concat(ruleItem['trigger']);
+								// 如果是有传入触发事件，但是此form-item却没有配置此触发器的话，不执行校验操作
+								if (event != null && !trigger.includes(event)) {
+									resolve([])
+									continue;
+								}
+								// 实例化校验对象，传入构造规则
+								const validator = new Schema({
+									[propertyName]: ruleItem,
+								});
+								validator.validate({
+										[propertyName]: propertyVal,
+									},
+									(errors, fields) => {
+										if (testArray(errors)) {
+											errors.forEach((element: any) => {
+												element.prop = child.$props['prop'];
+											});
+											errorsRes.push(...errors);
+											childErrors.push(...errors);
+										}
+										child.$data['message'] =
+											childErrors[0]['message'] ? childErrors[0]['message'] : null;
+
+										if (i == (rules.length - 1)) {
+											resolve(errorsRes)
+										}
+									}
+								)
+							}
+						} else {
+							resolve([])
+						}
+					});
+				});
+
+				// 使用Promise.all来等待所有Promise完成  
+				Promise.all(promises)
+					.then(results => {
+						// 执行回调函数
+						// if(typeof callback === "function") 
+						callback(errorsRes);
+					})
+					.catch(error => {
+						console.error('An error occurred:', error);
+					});
+			},
+			// 校验全部数据
+			validate(callback: Function) {
+				// 开发环境才提示，生产环境不会提示
+				if (process.env.NODE_ENV === 'development' && Object.keys(this.formRules).length === 0) {
+					console.error('未设置rules，请看文档说明！如果已经设置，请刷新页面。');
+					return;
+				}
+				return new Promise((resolve, reject) => {
+					// 获取所有form-item的prop，交给validateField方法进行校验
+					const formItemProps = this!.children!.map(
+						(item: ComponentPublicInstance) => item.$props['prop']
+					);
+					this.validateField(formItemProps, (errors: UTSJSONObject[]) => {
+						if(errors.length) {
+							// 如果错误提示方式为toast，则进行提示
+							if(this.errorType === 'toast') toast(errors[0].message)
+							reject(errors)
+						} else {
+							resolve(true)
+						}
+					});
+				});
+			},
+		},
+	};
+</script>
+
+<style lang="scss" scoped>
+</style>

package/uview-ultra/components/up-form/up-form.vue

@@ -0,0 +1,252 @@
+<template>
+	<view class="up-form">
+		<slot />
+	</view>
+</template>
+
+<script>
+	import { props } from "./props.js";
+	import { mpMixin } from '../../libs/mixin/mpMixin.js';
+	import { mixin } from '../../libs/mixin/mixin.js';
+	import Schema from "../../libs/util/async-validator.js";
+	import { toast, getProperty, setProperty, deepClone, error } from '../../libs/function/index.js';
+	import test from '../../libs/function/test.js';
+	// 去除警告信息
+	Schema.warning = function() {};
+	/**
+	 * Form 表单
+	 * @description 此组件一般用于表单场景，可以配置Input输入框，Select弹出框，进行表单验证等。
+	 * @tutorial https://ijry.github.io/uview-plus/components/form.html
+	 * @property {Object}						model			当前form的需要验证字段的集合
+	 * @property {Object | Function | Array}	rules			验证规则
+	 * @property {String}						errorType		错误的提示方式，见上方说明 ( 默认 message )
+	 * @property {Boolean}						borderBottom	是否显示表单域的下划线边框   ( 默认 true ）
+	 * @property {String}						labelPosition	表单域提示文字的位置，left-左侧，top-上方 ( 默认 'left' ）
+	 * @property {String | Number}				labelWidth		提示文字的宽度，单位px  ( 默认 45 ）
+	 * @property {String}						labelAlign		lable字体的对齐方式   ( 默认 ‘left' ）
+	 * @property {Object}						labelStyle		lable的样式，对象形式
+	 * @example <up-formlabelPosition="left" :model="model1" :rules="rules" ref="form1"></up-form>
+	 */
+	export default {
+		name: "up-form",
+		mixins: [mpMixin, mixin, props],
+		provide() {
+			return {
+				upForm: this,
+			};
+		},
+		data() {
+			return {
+				formRules: {},
+				// 规则校验器
+				validator: {},
+				// 原始的model快照，用于resetFields方法重置表单时使用
+				originalModel: null,
+			};
+		},
+		watch: {
+			// 监听规则的变化
+			rules: {
+				immediate: true,
+				handler(n) {
+					this.setRules(n);
+				},
+			},
+			// 监听属性的变化，通知子组件up-form-item重新获取信息
+			propsChange(n) {
+				if (this.children?.length) {
+					this.children.map((child) => {
+						// 判断子组件(up-form-item)如果有updateParentData方法的话，就就执行(执行的结果是子组件重新从父组件拉取了最新的值)
+						typeof child.updateParentData == "function" &&
+							child.updateParentData();
+					});
+				}
+			},
+			// 监听model的初始值作为重置表单的快照
+			model: {
+				immediate: true,
+				handler(n) {
+					if (!this.originalModel) {
+						this.originalModel = deepClone(n);
+					}
+				},
+			},
+		},
+		computed: {
+			propsChange() {
+				return [
+					this.errorType,
+					this.borderBottom,
+					this.labelPosition,
+					this.labelWidth,
+					this.labelAlign,
+					this.labelStyle,
+				];
+			},
+		},
+		created() {
+			// 存储当前form下的所有up-form-item的实例
+			// 不能定义在data中，否则微信小程序会造成循环引用而报错
+			this.children = [];
+		},
+		methods: {
+			// 手动设置校验的规则，如果规则中有函数的话，微信小程序中会过滤掉，所以只能手动调用设置规则
+			setRules(rules) {
+				// 判断是否有规则
+				if (Object.keys(rules).length === 0) return;
+				if (process.env.NODE_ENV === 'development' && Object.keys(this.model).length === 0) {
+					error('设置rules，model必须设置！如果已经设置，请刷新页面。');
+					return;
+				};
+				this.formRules = rules;
+				// 重新将规则赋予Validator
+				this.validator = new Schema(rules);
+			},
+			// 清空所有up-form-item组件的内容，本质上是调用了up-form-item组件中的resetField()方法
+			resetFields() {
+				this.resetModel();
+			},
+			// 重置model为初始值的快照
+			resetModel(obj) {
+				// 历遍所有up-form-item，根据其prop属性，还原model的原始快照
+				this.children.map((child) => {
+					const prop = child?.prop;
+					const value = getProperty(this.originalModel, prop);
+					setProperty(this.model, prop, value);
+				});
+			},
+			// 清空校验结果
+			clearValidate(props) {
+				props = [].concat(props);
+				this.children.map((child) => {
+					// 如果up-form-item的prop在props数组中，则清除对应的校验结果信息
+					if (props[0] === undefined || props.includes(child.prop)) {
+						child.message = null;
+					}
+				});
+			},
+			// 对部分表单字段进行校验
+			async validateField(value, callback, event = null) {
+				// $nextTick是必须的，否则model的变更，可能会延后于此方法的执行
+				this.$nextTick(() => {
+					// 校验错误信息，返回给回调方法，用于存放所有form-item的错误信息
+					const errorsRes = [];
+					// 如果为字符串，转为数组
+					value = [].concat(value);
+					// 历遍children所有子form-item
+					let promises = this.children.map(child => {
+						return new Promise((resolve, reject) => {
+							// 用于存放form-item的错误信息
+							const childErrors = [];
+							if (value.includes(child.prop)) {
+								// 获取对应的属性，通过类似'a.b.c'的形式
+								const propertyVal = getProperty(
+									this.model,
+									child.prop
+								);
+								// 属性链数组
+								const propertyChain = child.prop.split(".");
+								const propertyName =
+									propertyChain[propertyChain.length - 1];
+
+								let rule = []
+								if (child.itemRules && child.itemRules.length > 0) {
+									rule = child.itemRules
+								} else {
+									rule = this.formRules[child.prop];
+								}
+								// 如果不存在对应的规则，直接返回，否则校验器会报错
+								if (!rule) {
+									resolve()
+									return;
+								}
+								// rule规则可为数组形式，也可为对象形式，此处拼接成为数组
+								const rules = [].concat(rule);
+
+								// 对rules数组进行校验
+								if (!rules.length) {
+									resolve()
+								}
+								for (let i = 0; i < rules.length; i++) {
+									const ruleItem = rules[i];
+									// 将up-form-item的触发器转为数组形式
+									const trigger = [].concat(ruleItem?.trigger);
+									// 如果是有传入触发事件，但是此form-item却没有配置此触发器的话，不执行校验操作
+									if (event && !trigger.includes(event)) {
+										resolve()
+										continue;
+									}
+									// 实例化校验对象，传入构造规则
+									const validator = new Schema({
+										[propertyName]: ruleItem,
+									});
+									validator.validate({
+										[propertyName]: propertyVal,
+									},
+										(errors, fields) => {
+											if (test.array(errors)) {
+												errors.forEach(element => {
+													element.prop = child.prop;
+												});
+												errorsRes.push(...errors);
+												childErrors.push(...errors);
+											}
+											child.message =
+												childErrors[0]?.message ? childErrors[0].message : null;
+
+											if (i == (rules.length - 1)) {
+												resolve(errorsRes)
+											}
+										}
+									)
+								}
+							} else {
+								resolve({})
+							}
+						});
+					});
+
+					// 使用Promise.all来等待所有Promise完成  
+					Promise.all(promises)
+						.then(results => {
+							// 执行回调函数
+							typeof callback === "function" && callback(errorsRes);
+						})
+						.catch(error => {
+							console.error('An error occurred:', error);
+						});
+				});
+			},
+			// 校验全部数据
+			validate(callback) {
+				// 开发环境才提示，生产环境不会提示
+				if (process.env.NODE_ENV === 'development' && Object.keys(this.formRules).length === 0) {
+					error('未设置rules，请看文档说明！如果已经设置，请刷新页面。');
+					return;
+				}
+				return new Promise((resolve, reject) => {
+					// $nextTick是必须的，否则model的变更，可能会延后于validate方法
+					this.$nextTick(() => {
+						// 获取所有form-item的prop，交给validateField方法进行校验
+						const formItemProps = this.children.map(
+							(item) => item.prop
+						);
+						// console.log(formItemProps)
+						this.validateField(formItemProps, (errors) => {
+							if(errors.length) {
+								// 如果错误提示方式为toast，则进行提示
+								this.errorType === 'toast' && toast(errors[0].message)
+								reject(errors)
+							} else {
+								resolve(true)
+							}
+						});
+					});
+				});
+			},
+		},
+	};
+</script>
+
+<style lang="scss" scoped>
+</style>

package/uview-ultra/components/up-form-item/formItem.js

@@ -0,0 +1,24 @@
+/*
+ * @Author       : LQ
+ * @Description  :
+ * @version      : 1.0
+ * @Date         : 2021-08-20 16:44:21
+ * @LastAuthor   : jry
+ * @lastTime     : 2025-12-08 12:49:49
+ * @FilePath     : /uview-ultra/libs/config/props/formitem.js
+ */
+export default {
+    // formItem 组件
+    formItem: {
+        label: '',
+        prop: '',
+        rules: [],
+        borderBottom: '',
+        labelPosition: '',
+        labelWidth: '',
+        rightIcon: '',
+        leftIcon: '',
+        required: false,
+        leftIconStyle: '',
+    }
+}

package/uview-ultra/components/up-form-item/formItem.uts

@@ -0,0 +1,24 @@
+/*
+ * @Author       : jry
+ * @Description  :
+ * @version      : 4.0
+ * @Date         : 2024-04-22 16:44:21
+ * @LastAuthor   : jry
+ * @lastTime     : 2024-08-28 12:27:20
+ * @FilePath     : /uview-ultra/libs/config/props/formItem.js
+ */
+export default {
+    // formItem 组件
+    formItem: {
+        label: '',
+        prop: '',
+        rules: [],
+        borderBottom: '',
+        labelPosition: '',
+        labelWidth: '',
+        rightIcon: '',
+        leftIcon: '',
+        required: false,
+        leftIconStyle: '',
+    }
+} as UTSJSONObject

package/uview-ultra/components/up-form-item/props.js

@@ -0,0 +1,55 @@
+import { defineMixin } from '../../libs/vue'
+import defProps from '../../libs/config/props.js'
+export const props = defineMixin({
+    props: {
+        // input的label提示语
+        label: {
+            type: String,
+            default: () => defProps.formItem.label
+        },
+        // 绑定的值
+        prop: {
+            type: String,
+            default: () => defProps.formItem.prop
+        },
+        // 绑定的规则
+        rules: {
+            type: Array,
+            default: () => defProps.formItem.rules
+        },
+        // 是否显示表单域的下划线边框
+        borderBottom: {
+            type: [String, Boolean],
+            default: () => defProps.formItem.borderBottom
+        },
+        // label的位置，left-左边，top-上边
+        labelPosition: {
+            type: String,
+            default: () => defProps.formItem.labelPosition
+        },
+        // label的宽度，单位px
+        labelWidth: {
+            type: [String, Number],
+            default: () => defProps.formItem.labelWidth
+        },
+        // 右侧图标
+        rightIcon: {
+            type: String,
+            default: () => defProps.formItem.rightIcon
+        },
+        // 左侧图标
+        leftIcon: {
+            type: String,
+            default: () => defProps.formItem.leftIcon
+        },
+        // 是否显示左边的必填星号，只作显示用，具体校验必填的逻辑，请在rules中配置
+        required: {
+            type: Boolean,
+            default: () => defProps.formItem.required
+        },
+        leftIconStyle: {
+            type: [String, Object],
+            default: () => defProps.formItem.leftIconStyle,
+        }
+    }
+})

package/uview-ultra/components/up-form-item/props.uts

@@ -0,0 +1,65 @@
+/*
+ * @Author       : jry
+ * @Description  : uview-plus component's props mixin file
+ * @version      : 4.0
+ * @Date         : 2024-04-22 16:44:21
+ * @LastAuthor   : jry
+ * @lastTime     : 2024-08-28 12:27:20
+ */
+import { defineMixin } from '../../libs/vue.uts'
+import defProps from './formItem.uts'
+let formItemProp = defProps['formItem'] as UTSJSONObject
+
+export const propsFormItem = defineMixin({
+    props: {
+        // input的label提示语
+        label: {
+            type: String,
+            default: formItemProp['label']
+        },
+        // 绑定的值
+        prop: {
+            type: String,
+            default: formItemProp['prop']
+        },
+        // 绑定的规则
+        rules: {
+            type: Array,
+            default: formItemProp['rules']
+        },
+        // 是否显示表单域的下划线边框
+        borderBottom: {
+            type: [String, Boolean],
+            default: formItemProp['borderBottom']
+        },
+        // label的位置，left-左边，top-上边
+        labelPosition: {
+            type: String,
+            default: formItemProp['labelPosition']
+        },
+        // label的宽度，单位px
+        labelWidth: {
+            type: [String, Number],
+            default: formItemProp['labelWidth']
+        },
+        // 右侧图标
+        rightIcon: {
+            type: String,
+            default: formItemProp['rightIcon']
+        },
+        // 左侧图标
+        leftIcon: {
+            type: String,
+            default: formItemProp['leftIcon']
+        },
+        // 是否显示左边的必填星号，只作显示用，具体校验必填的逻辑，请在rules中配置
+        required: {
+            type: Boolean,
+            default: formItemProp['required']
+        },
+        leftIconStyle: {
+            type: [String, Object],
+            default: formItemProp['leftIconStyle']
+        }
+    }
+});