docs(button-edit): add properties and events descriptions
This commit is contained in:
Sagi
parent
58880e89cb
commit
574c805aac
|
|
@ -101,41 +101,44 @@ type TextAlignment = 'left' | 'center' | 'right';
|
|||
|
||||
## 属性
|
||||
|
||||
| 属性名 | 类型 | 默认值 | 说明 |
|
||||
| :--------------------- | :------------------------ | :----- | :--- |
|
||||
| id | `string` | -- | -- |
|
||||
| autoComplete | `boolean` | false | -- |
|
||||
| buttonContent | `string` | -- | -- |
|
||||
| customClass | `string` | -- | -- |
|
||||
| disable | `boolean` | false | -- |
|
||||
| editable | `boolean` | true | -- |
|
||||
| enableClear | `boolean` | false | -- |
|
||||
| readonly | `boolean` | false | -- |
|
||||
| textAlign | `string as TextAlignment` | 'left' | -- |
|
||||
| showButtonWhenDisabled | `boolean` | false | -- |
|
||||
| enableTitle | `boolean` | false | -- |
|
||||
| inputType | `'text' \| 'password'` | 'text' | -- |
|
||||
| forcePlaceholder | `boolean` | false | -- |
|
||||
| placeholder | `string` | -- | -- |
|
||||
| minLength | `number` | -- | -- |
|
||||
| maxLength | `number` | -- | -- |
|
||||
| tabIndex | `number` | -- | -- |
|
||||
| 属性名 | 类型 | 默认值 | 说明 |
|
||||
| :--------------------- | :------------------------ | :----- | :---------------------------------------------------------------------------- |
|
||||
| id | `string` | -- | 标记组件的唯一标识 |
|
||||
| autoComplete | `boolean` | false | 是否启用自动完成录入文本功能 |
|
||||
| buttonContent | `string` | -- | 按钮内容，缺省为点击按钮图标 |
|
||||
| customClass | `string` | -- | 组件自定义样式 |
|
||||
| disable | `boolean` | false | 将组件设置为禁用状态 |
|
||||
| editable | `boolean` | true | 是否允许在输入框编辑文本 |
|
||||
| enableClear | `boolean` | false | 是否启用情况按钮 |
|
||||
| readonly | `boolean` | false | 将组件输入框设置为只读 |
|
||||
| textAlign | `string as TextAlignment` | 'left' | 设置输入框对齐方式，缺省状况为左对齐，可选择的值包括：'left','center','right' |
|
||||
| showButtonWhenDisabled | `boolean` | false | 是否允许在禁用组件时仍然显示组件按钮 |
|
||||
| enableTitle | `boolean` | false | 是否启用输入框的的提示文本 |
|
||||
| inputType | `'text' \| 'password'` | 'text' | 设置输入框类型，缺省为文本输入框，可以选择设为密码输入框 |
|
||||
| forcePlaceholder | `boolean` | false | 是否始终显示输入框提示文本 |
|
||||
| placeholder | `string` | -- | 设置输入框提示文本 |
|
||||
| minLength | `number` | -- | 设置输入框文本最小长度 |
|
||||
| maxLength | `number` | -- | 设置输入框文本最大长度 |
|
||||
| tabIndex | `number` | -- | 设置组件 Tab 键索引 |
|
||||
|
||||
## 事件
|
||||
|
||||
| 事件名 | 类型 | 说明 |
|
||||
| :------------- | :------------------ | :--- |
|
||||
| clear | `EventEmitter<any>` | -- |
|
||||
| change | `EventEmitter<any>` | -- |
|
||||
| click | `EventEmitter<any>` | -- |
|
||||
| clickButton | `EventEmitter<any>` | -- |
|
||||
| blur | `EventEmitter<any>` | -- |
|
||||
| focus | `EventEmitter<any>` | -- |
|
||||
| mouseEnterIcon | `EventEmitter<any>` | -- |
|
||||
| mouseLeaveIcon | `EventEmitter<any>` | -- |
|
||||
| keyup | `EventEmitter<any>` | -- |
|
||||
| keydown | `EventEmitter<any>` | -- |
|
||||
| inputClick | `EventEmitter<any>` | -- |
|
||||
| input | `EventEmitter<any>` | -- |
|
||||
| 事件名 | 类型 | 说明 |
|
||||
| :------------- | :------------------ | :------------------- |
|
||||
| clear | `EventEmitter<any>` | 点击清空按钮事件 |
|
||||
| change | `EventEmitter<any>` | 输入框值变化事件 |
|
||||
| click | `EventEmitter<any>` | 点击输入框事件 |
|
||||
| clickButton | `EventEmitter<any>` | 点击按钮事件 |
|
||||
| blur | `EventEmitter<any>` | 输入框失去焦点事件 |
|
||||
| focus | `EventEmitter<any>` | 输入框获得焦点事件 |
|
||||
| mouseEnterIcon | `EventEmitter<any>` | 鼠标移入按钮事件 |
|
||||
| mouseLeaveIcon | `EventEmitter<any>` | 数据移出按钮事件 |
|
||||
| keyup | `EventEmitter<any>` | 抬起键盘按键事件 |
|
||||
| keydown | `EventEmitter<any>` | 按下键盘按键事件 |
|
||||
| input | `EventEmitter<any>` | 在输入框录入字符事件 |
|
||||
|
||||
## 插槽
|
||||
|
||||
::: tip
|
||||
暂无内容
|
||||
:::
|
||||
|
|
|
|||
Loading…
Reference in New Issue