cloud-ui.vusion/src/components/u-validator.vue/api.yaml

Vusion Cloud UI

- name: u-validator
  title: 验证器
  icon: validator
  labels:
    - Form
  description: 实现了基础的嵌套验证功能和原子化验证功能，包含提示样式。常用于嵌套验证时使用，或用于派生一些较复杂的组件。
  docs:
    rules: 内置规则
  attrs:
    - name: validating-value
      title: 验证值
      type: any
      description: 临时修改验证值
      group: 数据属性
      brifeDoc: ""
      docDescription: 临时修改验证值
      tooltipLink: ""
    - name: validating-process
      title: 值预处理
      type: Function
      description: 验证前对值进行预处理
      group: 数据属性
      brifeDoc: ""
      docDescription: 验证前对值进行预处理
      tooltipLink: ""
    - name: name
      title: 表单项名称
      type: string
      description: ""
      group: 主要属性
      brifeDoc: ""
      docDescription: ""
      tooltipLink: ""
      advanced: true
      deprecated: true
    - name: label
      title: 标签
      type: string
      description: 在 UValidator 用于提示消息的合成，在 UFormItem 等其他组件用于显示标签
      group: 主要属性
      brifeDoc: ""
      docDescription: 用于提示消息的合成
      tooltipLink: ""
    - name: rules
      title: 规则
      type: string | Array
      description: 简写格式为字符串类型，完整格式或混合格式为数组类型
      compType: validationRulesSelect
      bindHide: true
      group: 主要属性
      brifeDoc: ""
      docDescription: 验证规则。简写格式为字符串类型，完整格式或混合格式为数组类型，详见[验证规则](#验证规则)
      tooltipLink: ""
    - name: message
      title: 提示信息
      type: string
      description: 鼠标悬浮时显示的提示信息
      group: 主要属性
      brifeDoc: ""
      docDescription: 默认提示消息
      tooltipLink: ""
    - name: muted
      title: 静默
      type: string
      description: 验证时是否静默。可选值：`'message'`表示只静默消息提示，`'all'`同时静默消息提示和红框提示
      group: 主要属性
      brifeDoc: ""
      docDescription: 验证时是否静默。可选值：`'message'`表示只静默消息提示，`'all'`同时静默消息提示和红框提示
      tooltipLink: ""
    - name: ignore-validation
      title: 忽略验证
      type: boolean
      default: false
      description: ""
      group: 主要属性
      brifeDoc: ""
      docDescription: 忽略验证
      tooltipLink: ""
    - name: ignore-rules
      title: 忽略验证规则
      type: boolean
      default: false
      description: ""
      group: 主要属性
      brifeDoc: ""
      docDescription: ""
      tooltipLink: ""
      deprecated: true
    - name: validating-options
      title: 验证辅助对象
      type: object
      description: 在 Rule 的 `validate` 方法中使用
      group: 主要属性
      brifeDoc: ""
      docDescription: 验证辅助对象
      tooltipLink: ""
    - name: manual
      title: 手动验证
      type: boolean
      default: false
      description: 是否采取手动验证。如果为`true`，则 UValidator
        将不会在监听到子组件的`input`、`change`和`blur`事件后进行相应的验证。
      group: 主要属性
      brifeDoc: ""
      docDescription: |-
        是否采取手动验证。如果为`true`，则验证器。
            将不会在监听到子组件的`input`、`change`和`blur`事件后进行相应的验证
      tooltipLink: ""
    - name: append-to
      title: 报错位置依据
      type: string
      default: reference
      description: 设置报错信息依据哪个元素定位位置。可选值：`'body'`表示添加到
        document.body，`'reference'`表示添加到参考元素中。当父级有overflow:hidden而又想展示出错信息，可以设置为body
      options:
        - value: reference
          title: 引用元素下
        - value: body
          title: 全局body
      group: 主要属性
      brifeDoc: ""
      docDescription: 设置添加到哪个元素。可选值：`'body'`表示添加到
        document.body，`'reference'`表示添加到参考元素中。当父级有overflow:hidden而又想展示出错信息，可以设置为body
      tooltipLink: ""
    - name: placement
      title: 报错位置方向
      type: string
      options:
        - value: right
          title: 提示信息在右侧显示
        - value: bottom
          title: 提示信息在底部显示
      default: right
      description: 设置报错信息展示的位置方向
      dependency:
        - "!append-to": body
      group: 主要属性
      brifeDoc: ""
      docDescription: 提示信息显示位置
      tooltipLink: ""
  computed:
    - name: touched
      title: 触碰
      type: boolean
      description: 用户是否触碰
    - name: dirty
      title: 修改值
      type: boolean
      description: 用户是否修改值
    - name: valid
      title: 通过
      type: boolean
      description: 验证是否通过
    - name: firstError
      title: 第一个错误
      type: string
      description: 第一个错误提示消息
  slots:
    - concept: Slot
      name: default
      description: 插入继承了 MField 的组件，或子 UValidator，或其他 HTML 和文本。
  events:
    - name: validate
      title: 验证后
      description: 对于第一个 Field 或者所有子 UValidator：
      params:
        - name: $event
          type: object
          description: 自定义事件对象
          schema:
            $ref: "#/systemTypes/ValidateEvent"
        - name: $event.trigger
          type: string
          description: 本次验证的触发方式
        - name: $event.valid
          type: boolean
          description: 验证是否通过
        - name: $event.touched
          type: boolean
          description: 用户是否触碰
        - name: $event.dirty
          type: boolean
          description: 用户是否修改值
        - name: $event.firstError
          type: string
          description: 第一个错误提示消息
        - name: senderVM
          type: UValidator
          description: 发送事件实例
    - name: blur-valid
      title: 失焦验证通过后
      description: 对于第一个 Field 或者所有子 UValidator：
      params:
        - name: $event
          type: object
          description: 自定义事件对象
          schema:
            $ref: "#/systemTypes/ValidateEvent"
        - name: $event.trigger
          type: string
          description: 本次验证的触发方式
        - name: $event.valid
          type: boolean
          description: 验证是否通过
        - name: $event.touched
          type: boolean
          description: 用户是否触碰
        - name: $event.dirty
          type: boolean
          description: 用户是否修改值
        - name: $event.firstError
          type: string
          description: 第一个错误提示消息
        - name: senderVM
          type: UValidator
          description: 发送事件实例
    - name: blur-invalid
      title: 失焦验证不通过后
      description: 对于第一个 Field 或者所有子 UValidator：
      params:
        - name: $event
          type: object
          description: 自定义事件对象
          schema:
            $ref: "#/systemTypes/ValidateEvent"
        - name: $event.trigger
          type: string
          description: 本次验证的触发方式
        - name: $event.valid
          type: boolean
          description: 验证是否通过
        - name: $event.touched
          type: boolean
          description: 用户是否触碰
        - name: $event.dirty
          type: boolean
          description: 用户是否修改值
        - name: $event.firstError
          type: string
          description: 第一个错误提示消息
        - name: senderVM
          type: UValidator
          description: 发送事件实例
  methods:
    - name: validate
      description: 手动验证。
      params:
        - name: trigger
          type: string
          default: submit
          description: 触发方式，可选值：`submit`、`blur`和`input`之一，或者它们的任意组合。
        - name: muted
          type: boolean
          default: false
          description: 是否验证后无提示