element-plus/types/form-item.d.ts

import { ElementUIComponent, ElementUIComponentSize } from './component'

/** FormItem Component */
export declare class ElFormItem extends ElementUIComponent {
  /** A key of `model` of the enclosing `el-form` component */
  prop: string

  /** Label */
  label: string

  /** Width of label, e.g. '50px' */
  labelWidth: string

  /** Whether the field is required or not, will be determined by validation rules if omitted */
  required: boolean

  /** Validation rules of form */
  rules: Record<string, unknown>

  /** Field error message, set its value and the field will validate error and show this message immediately */
  error: string

  /** Whether to show the error message */
  showMessage: boolean

  /** Whether to display the error message inline with the form item */
  inlineMessage: boolean

  /** Controls the size of components in this form */
  size: ElementUIComponentSize

  /** Reset current field and remove validation result */
  resetField (): void

  /** Remove validation status of the field */
  clearValidate (): void
}