docs_vue2/one/docs/components/prompt-box.md

67 lines
2.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# PromptBox <small>输入弹框</small>
## 示例
获取用户输入的值。
[[ demo src="/demo/prompt-box/base.vue" ]]
## API
### 属性
| 名称 | 类型 | 默认值 | 描述 |
| --- | --- | --- | --- |
| ``open`` | `boolean` | `false` | [^open] |
| ``title`` | `string` | - | 标题。 |
| ``content`` | `string` | `'请输入'` | 输入框上方的说明内容。 |
| ``value`` | `string` | `''` | [^value] |
| ``loading`` | `boolean=` | `false` | 是否处于加载状态。处于加载状态时确定按钮也将进入加载状态,无法点击。 |
| ``disabled`` | `boolean=` | `false` | 是否处于禁用状态。处于禁用状态时确定按钮也将进入禁用状态,无法点击。 |
| ``ok-label`` | `string=` | - | “确定”按钮的文字内容。 |
| ``cancel-label`` | `string=` | - | “取消”按钮的文字内容。 |
| ``before-close`` | `function(string): boolean=|Promise<boolean=>` | - | 在将触发关闭的操作发生后执行,参考 [`Dialog`](./dialog) 组件的 [`before-close`](./dialog#props-before-close) 属性。 |
| ``overlay-class`` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-class`](./overlay#props-overlay-class) 属性。 |
| ``overlay-style`` | `string | Array | Object=` | - | 参考 [`Overlay`](./overlay) 组件的 [`overlay-style`](./overlay#props-overlay-style) 属性。 |
^^^open
:::badges
`.sync`
:::
是否显示输入弹框。
^^^
^^^value
:::badges
`v-model`
:::
输入框值。
^^^
### 插槽
| 名称 | 描述 |
| -- | -- |
| ``default`` | 内容区。 |
| ``title`` | 标题区。若同时指定了 [`title`](#props-title) 属性和 [`title`](#slots-title) 插槽,以后者为准。 |
| ``foot`` | 底部区域,默认会展示“确定”、“取消”按钮。 |
### 事件
| 名称 | 描述 |
| -- | -- |
| ``input`` | [^event-input] |
| ``ok`` | 点击“确定”按钮时触发。 |
| ``cancel`` | 点击“取消”按钮时触发。 |
| ``afterclose`` | 浮层关闭后触发。如果样式主题提供了退出动画,将在退出动画完毕后触发。 |
^^^event-input
:::badges
`v-model`
:::
输入框值发生变化后触发。回调参数为 `(value: string)``value` 为输入框当前值。
^^^