2016-08-26 14:42:41 +08:00
|
|
|
---
|
|
|
|
|
category: Components
|
2016-11-09 14:43:32 +08:00
|
|
|
type: Feedback
|
2016-08-26 15:07:46 +08:00
|
|
|
title: Popconfirm
|
2020-06-05 13:50:09 +08:00
|
|
|
cover: https://gw.alipayobjects.com/zos/alicdn/fjMCD9xRq/Popconfirm.svg
|
2016-08-26 14:42:41 +08:00
|
|
|
---
|
|
|
|
|
|
|
|
|
|
A simple and compact confirmation dialog of an action.
|
|
|
|
|
|
2016-09-10 13:43:30 +08:00
|
|
|
## When To Use
|
2016-08-26 14:42:41 +08:00
|
|
|
|
2017-09-11 11:08:53 +08:00
|
|
|
A simple and compact dialog used for asking for user confirmation.
|
2016-08-26 14:42:41 +08:00
|
|
|
|
2017-09-11 11:08:53 +08:00
|
|
|
The difference with the `confirm` modal dialog is that it's more lightweight than the static popped full-screen confirm modal.
|
2016-08-26 14:42:41 +08:00
|
|
|
|
|
|
|
|
## API
|
|
|
|
|
|
2019-11-20 17:46:50 +08:00
|
|
|
| Param | Description | Type | Default value |
|
|
|
|
|
| --- | --- | --- | --- |
|
2020-07-02 16:13:17 +08:00
|
|
|
| cancelText | The text of the Cancel button | string | `Cancel` |
|
|
|
|
|
| okText | The text of the Confirm button | string | `OK` |
|
2019-11-20 17:46:50 +08:00
|
|
|
| okType | Button `type` of the Confirm button | string | `primary` |
|
2020-05-06 17:37:49 +08:00
|
|
|
| okButtonProps | The ok button props | [ButtonProps](/components/button/#API) | - |
|
|
|
|
|
| cancelButtonProps | The cancel button props | [ButtonProps](/components/button/#API) | - |
|
2020-07-02 16:13:17 +08:00
|
|
|
| title | The title of the confirmation box | string \| ReactNode \| () => ReactNode | - |
|
|
|
|
|
| onCancel | A callback of cancel | function(e) | - |
|
|
|
|
|
| onConfirm | A callback of confirmation | function(e) | - |
|
|
|
|
|
| icon | Customize icon of confirmation | ReactNode | <ExclamationCircle /> |
|
|
|
|
|
| disabled | Whether show popconfirm when click its childrenNode | boolean | false |
|
2016-12-22 12:00:57 +08:00
|
|
|
|
2020-04-17 17:56:42 +08:00
|
|
|
Consult [Tooltip's documentation](/components/tooltip/#API) to find more APIs.
|
2017-01-22 14:26:46 +08:00
|
|
|
|
|
|
|
|
## Note
|
|
|
|
|
|
2017-09-11 11:08:53 +08:00
|
|
|
Please ensure that the child node of `Popconfirm` accepts `onMouseEnter`, `onMouseLeave`, `onFocus`, `onClick` events.
|
