Blame view

dist/types/form.d.ts 2.27 KB
b1b1ea63   yangd   更新d.ts到3.1.0,修复d....
1
  // Type definitions for iview 3.1.0
a3a90be7   梁灏   update
2
3
4
  // Project: https://github.com/iview/iview
  // Definitions by: yangdan
  // Definitions: https://github.com/yangdan8/iview.git
506a0578   梁灏   release 3.1.0-rc.1
5
  import Vue, { VNode } from 'vue';
a3a90be7   梁灏   update
6
  
506a0578   梁灏   release 3.1.0-rc.1
7
  export declare interface Form extends Vue {
a3a90be7   梁灏   update
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
    /**
     * 表单数据对象
     */
    model?: object;
    /**
     * 表单验证规则,具体配置查看 async-validator
     */
    rules?: object;
    /**
     * 是否开启行内表单模式
     * @default false
     */
    inline?: boolean;
    /**
     * 表单域标签的位置,可选值为 left、right、top
     * @default right
     */
    'label-position'?: 'left'|'right'|'top';
    /**
     * 表单域标签的宽度,所有的 FormItem 都会继承 Form 组件的 label-width 的值
     */
    'label-width'?: number;
    /**
     * 是否显示校验错误信息
     * @default true
     */
    'show-message'?: boolean;
    /**
     * 对整个表单进行校验,参数为检验完的回调,会返回一个 Boolean 表示成功与失败
     */
    validate(callback?: (valid?: boolean) => void): void;
    /**
     * 对部分表单字段进行校验的方法,参数1为需校验的 prop,参数2为检验完回调,返回错误信息
     */
    validateField(prop?: string, callback?: (valid?: boolean) => void): void;
    /**
     * 对整个表单进行重置,将所有字段值重置为空并移除校验结果
     */
    resetFields(): void;
  }
  
506a0578   梁灏   release 3.1.0-rc.1
49
  export declare interface FormItem extends Vue {
a3a90be7   梁灏   update
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
    /**
     * 对应表单域 model 里的字段
     */
    prop?: string;
    /**
     * 标签文本
     */
    label?: string;
    /**
     * 表单域标签的的宽度
     */
    'label-width'?: number;
    /**
     * 指定原生的 label 标签的 for 属性,配合控件的 element-id 属性,可以点击 label 时聚焦控件。
     */
    'label-for'?: string;
    /**
     * 是否必填,如不设置,则会根据校验规则自动生成
     */
    required?: boolean;
    /**
     * 表单验证规则
     */
    rules?: object | Array<any>;
    /**
     * 表单域验证错误信息, 设置该值会使表单验证状态变为error,并显示该错误信息
     */
    error?: string;
    /**
     * 是否显示校验错误信息
     * @default true
     */
    'show-message'?: boolean;
    /**
     * slot插槽对象
     */
    $slots: {
      /**
       * 内容
       */
      '': VNode[];
      /**
       * label 内容
       */
      label: VNode[];
    };
  }