input.d.ts
3.78 KB
1
2
3
4
5
6
7
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
49
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
// Type definitions for iview 3.3.1
// Project: https://github.com/iview/iview
// Definitions by: yangdan
// Definitions: https://github.com/yangdan8/iview.git
import Vue, { VNode } from 'vue';
export declare class Input extends Vue {
/**
* 输入框类型，可选值为 text、password、textarea、url、email、date、number、tel
* @default text
*/
type?: 'text' | 'password' | 'textarea' | 'url' | 'email' | 'date' | 'number' | 'tel';
/**
* 绑定的值，可使用 v-model 双向绑定
* @default 空
*/
value?: string | number;
/**
* 输入框尺寸，可选值为large、small、default或者不设置
*/
size?: '' | 'large' | 'small' | 'default';
/**
* 占位文本
*/
placeholder?: string;
/**
* 是否显示清空按钮
* @default false
*/
clearable?: boolean;
/**
* 设置输入框为禁用状态
* @default false
*/
disabled?: boolean;
/**
* 设置输入框为只读
* @default false
*/
readonly?: boolean;
/**
* 最大输入长度
*/
maxlength?: number;
/**
* 输入框尾部图标，仅在 text 类型下有效
*/
icon?: string;
/**
* 输入框头部图标
* @default false
*/
prefix?: string;
/**
* 输入框尾部图标
* @default false
*/
suffix?: String;
/**
* 是否显示为搜索型输入框
* @default false
*/
search?: boolean;
/**
* 开启 search 时可用，是否有确认按钮，可设为按钮文字
* @default false
*/
'enter-button'?: boolean | string;
/**
* 文本域默认行数，仅在 textarea 类型下有效
* @default 2
*/
rows?: number;
/**
* 自适应内容高度，仅在 textarea 类型下有效，可传入对象，如 { minRows: 2, maxRows: 6 }
* @default false
*/
autosize?: boolean | { minRows?: number, maxRows?: number };
/**
* 将用户的输入转换为 number 类型
* @default false
*/
number?: boolean;
/**
* 自动获取焦点
* @default false
*/
autofocus?: boolean;
/**
* 原生的自动完成功能，可选值为 off 和 on,off
*/
autocomplete?: string;
/**
* 给表单元素设置 id，详见 Form 用法。
*/
'element-id'?: string;
/**
* 原生的 spellcheck 属性
* @default false
*/
spellcheck?: boolean;
/**
* 原生的 wrap 属性，可选值为 hard 和 soft，仅在 textarea 下生效
* @default soft
*/
wrap?: 'hard' | 'soft';
/**
* 按下回车键时触发
*/
$emit(eventName: 'on-enter'): this;
/**
* 设置 icon 属性后，点击图标时触发
*/
$emit(eventName: 'on-click'): this;
/**
* 数据改变时触发
*/
$emit(eventName: 'on-change', event: string): this;
/**
* 输入框聚焦时触发
*/
$emit(eventName: 'on-focus'): this;
/**
* 输入框失去焦点时触发
*/
$emit(eventName: 'on-blur'): this;
/**
* 原生的 keyup 事件
*/
$emit(eventName: 'on-keyup', event: KeyboardEvent): this;
/**
* 原生的 keydown 事件
*/
$emit(eventName: 'on-keydown', event: KeyboardEvent): this;
/**
* 原生的 keypress 事件
*/
$emit(eventName: 'on-keypress', event: KeyboardEvent): this;
/**
* 开启 search 时可用，点击搜索或按下回车键时触发
*/
$emit(eventName: 'on-search', value: string): this;
/**
* 开启 clearable 时可用，点击清空按钮时触发
*/
$emit(eventName: 'on-clear'): this;
/**
* 手动聚焦输入框
*/
focus(): void;
/**
* slot插槽对象
*/
$slots: {
/**
* 前置内容，仅在 text 类型下有效
*/
prepend: VNode[];
/**
* 后置内容，仅在 text 类型下有效
*/
append: VNode[];
/**
* 输入框头部图标
*/
prefix: VNode[];
/**
* 输入框尾部图标
*/
suffix: VNode[];
};
}