nutui-uniapp/components/form/form.ts

京东风格的轻量级移动端 Uniapp、Vue3 组件库（支持小程序开发）

import { computed } from 'vue'
import type { ComputedRef, ExtractPropTypes, Ref } from 'vue'
import { commonProps, makeObjectProp, makeStringProp } from '../_utils'
import { useInject } from '../_hooks'
import type { ErrorMessage, FormLabelPosition, FormRules, FormStarPosition } from './types'

export const FORM_KEY = Symbol('Form')

export const formProps = {
  ...commonProps,
  /**
   * @description 表单数据对象(使用表单校验时，_必填_)
   */
  modelValue: makeObjectProp({}),

  /**
   * @description 统一配置每个 `FormItem` 的 `rules`
   */
  rules: makeObjectProp<FormRules>({}),
  /**
   * @description 禁用表单下的所有数据录入组件
   */
  disabled: Boolean,
  /**
   * @description 表单项 label 的位置
   */
  labelPosition: makeStringProp<FormLabelPosition>('left'),
  /**
   * @description 必填表单项 label 的红色星标位置
   */
  starPosition: makeStringProp<FormStarPosition>('left'),
}

export type FormProps = ExtractPropTypes<typeof formProps>

export const formEmits = {
  validate: (msg: ErrorMessage) => msg instanceof Object,
}

export type FormEmits = typeof formEmits

export function useFormDisabled(disabled: Ref<boolean>): ComputedRef<boolean> {
  const { parent } = useInject<{ props: { disabled: boolean } }>(FORM_KEY)
  return computed(() => disabled.value || parent?.props?.disabled || false)
}