cl-form-item.uvue 5.0 KB

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