cl-form-item.uvue 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282
  1. <template>
  2. <view
  3. class="cl-form-item"
  4. :class="[
  5. {
  6. 'cl-form-item--error': isError
  7. },
  8. pt.className
  9. ]"
  10. :id="`cl-form-item-${prop}`"
  11. >
  12. <view class="cl-form-item__inner" :class="[`is-${labelPosition}`, pt.inner?.className]">
  13. <view
  14. class="cl-form-item__label"
  15. :class="[`is-${labelPosition}`, pt.label?.className]"
  16. :style="{
  17. width: labelPosition != 'top' ? labelWidth : 'auto'
  18. }"
  19. v-if="label != ''"
  20. >
  21. <cl-text>{{ label }}</cl-text>
  22. <cl-text
  23. color="error"
  24. :pt="{
  25. className: 'ml-1'
  26. }"
  27. v-if="showAsterisk"
  28. >
  29. *
  30. </cl-text>
  31. </view>
  32. <view class="cl-form-item__content" :class="[pt.content?.className]">
  33. <slot></slot>
  34. </view>
  35. </view>
  36. <view class="cl-form-item__error" v-if="isError && showMessage">
  37. <slot name="error" :error="errorText">
  38. <cl-text
  39. color="error"
  40. :pt="{
  41. className: parseClass(['mt-2 text-sm', pt.error?.className])
  42. }"
  43. >
  44. {{ errorText }}
  45. </cl-text>
  46. </slot>
  47. </view>
  48. </view>
  49. </template>
  50. <script setup lang="ts">
  51. import { computed, onMounted, onUnmounted, watch, type PropType } from "vue";
  52. import { isEqual, parseClass, parsePt } from "@/cool";
  53. import type { ClFormLabelPosition, ClFormRule, PassThroughProps } from "../../types";
  54. import { useForm } from "../../hooks";
  55. defineOptions({
  56. name: "cl-form-item"
  57. });
  58. defineSlots<{
  59. error(props: { error: string }): any;
  60. }>();
  61. // 组件属性定义
  62. const props = defineProps({
  63. // 透传样式
  64. pt: {
  65. type: Object,
  66. default: () => ({})
  67. },
  68. // 字段标签
  69. label: {
  70. type: String,
  71. default: ""
  72. },
  73. // 字段名称
  74. prop: {
  75. type: String,
  76. default: ""
  77. },
  78. // 字段验证规则
  79. rules: {
  80. type: Array as PropType<ClFormRule[]>,
  81. default: () => []
  82. },
  83. // 标签位置
  84. labelPosition: {
  85. type: String as PropType<ClFormLabelPosition>,
  86. default: null
  87. },
  88. // 标签宽度
  89. labelWidth: {
  90. type: String as PropType<string | null>,
  91. default: null
  92. },
  93. // 是否显示必填星号
  94. showAsterisk: {
  95. type: Boolean as PropType<boolean | null>,
  96. default: null
  97. },
  98. // 是否显示错误信息
  99. showMessage: {
  100. type: Boolean as PropType<boolean | null>,
  101. default: null
  102. },
  103. // 是否必填
  104. required: {
  105. type: Boolean as PropType<boolean | null>,
  106. default: null
  107. }
  108. });
  109. // cl-form 上下文
  110. const { formRef, getError, getValue, validateField, addField, removeField, setRule, getRule } =
  111. useForm();
  112. // 透传样式类型
  113. type PassThrough = {
  114. className?: string;
  115. inner?: PassThroughProps;
  116. label?: PassThroughProps;
  117. content?: PassThroughProps;
  118. error?: PassThroughProps;
  119. };
  120. // 解析透传样式
  121. const pt = computed(() => parsePt<PassThrough>(props.pt));
  122. // 当前错误信息
  123. const errorText = computed<string>(() => {
  124. return getError(props.prop);
  125. });
  126. // 是否有错误
  127. const isError = computed<boolean>(() => {
  128. return errorText.value != "";
  129. });
  130. // 当前标签位置
  131. const labelPosition = computed<ClFormLabelPosition>(() => {
  132. return props.labelPosition ?? formRef.value?.labelPosition ?? "left";
  133. });
  134. // 标签宽度
  135. const labelWidth = computed<string>(() => {
  136. return props.labelWidth ?? formRef.value?.labelWidth ?? "120rpx";
  137. });
  138. // 计算是否必填
  139. const required = computed<boolean>(() => {
  140. if (props.required != null) {
  141. return props.required;
  142. }
  143. // 否则,根据规则自动判断
  144. const rules = getRule(props.prop);
  145. return rules.some((rule) => rule.required == true);
  146. });
  147. // 是否显示必填星号
  148. const showAsterisk = computed<boolean>(() => {
  149. if (!required.value) {
  150. return false;
  151. }
  152. return props.showAsterisk ?? formRef.value?.showAsterisk ?? true;
  153. });
  154. // 是否显示错误信息
  155. const showMessage = computed<boolean>(() => {
  156. if (!required.value) {
  157. return false;
  158. }
  159. return props.showMessage ?? formRef.value?.showMessage ?? true;
  160. });
  161. // 监听计算后的 required 属性
  162. watch(
  163. required,
  164. (val: boolean) => {
  165. if (val) {
  166. addField(props.prop, props.rules);
  167. } else {
  168. removeField(props.prop);
  169. }
  170. },
  171. {
  172. immediate: true
  173. }
  174. );
  175. onMounted(() => {
  176. // 监听字段值变化
  177. watch(
  178. computed(() => {
  179. const value = getValue(props.prop);
  180. if (value == null) {
  181. return "";
  182. }
  183. return value;
  184. }),
  185. (a: any, b: any) => {
  186. if (required.value == true) {
  187. if (!isEqual(a, b)) {
  188. validateField(props.prop);
  189. }
  190. }
  191. },
  192. {
  193. deep: true
  194. }
  195. );
  196. // 监听规则变化
  197. watch(
  198. computed(() => props.rules),
  199. (val: ClFormRule[]) => {
  200. setRule(props.prop, val);
  201. },
  202. {
  203. deep: true
  204. }
  205. );
  206. });
  207. onUnmounted(() => {
  208. removeField(props.prop);
  209. });
  210. defineExpose({
  211. prop: props.prop
  212. });
  213. </script>
  214. <style lang="scss" scoped>
  215. .cl-form-item {
  216. @apply w-full mb-6;
  217. &__inner {
  218. @apply w-full;
  219. &.is-top {
  220. @apply flex flex-col;
  221. }
  222. &.is-left {
  223. @apply flex flex-row;
  224. }
  225. &.is-right {
  226. @apply flex flex-row;
  227. }
  228. }
  229. &__label {
  230. @apply flex flex-row items-center;
  231. &.is-top {
  232. @apply w-full mb-2;
  233. }
  234. &.is-left {
  235. @apply mr-3;
  236. }
  237. &.is-right {
  238. @apply mr-3 justify-end;
  239. }
  240. }
  241. &__content {
  242. @apply relative flex-1 w-full;
  243. }
  244. }
  245. </style>