ant-design/components/popconfirm/index.en-US.md
WeijieChen b4d16125dd
docs: add Version (#32678)
Co-authored-by: machixian <machixian@myweimai.com>
2021-10-29 08:50:01 +08:00

37 lines
1.5 KiB
Markdown

---
category: Components
type: Feedback
title: Popconfirm
cover: https://gw.alipayobjects.com/zos/alicdn/fjMCD9xRq/Popconfirm.svg
---
A simple and compact confirmation dialog of an action.
## When To Use
A simple and compact dialog used for asking for user confirmation.
The difference with the `confirm` modal dialog is that it's more lightweight than the static popped full-screen confirm modal.
## API
| Param | Description | Type | Default value | Version |
| --- | --- | --- | --- | --- |
| cancelButtonProps | The cancel button props | [ButtonProps](/components/button/#API) | - | |
| cancelText | The text of the Cancel button | string | `Cancel` | |
| disabled | Whether show popconfirm when click its childrenNode | boolean | false | |
| icon | Customize icon of confirmation | ReactNode | &lt;ExclamationCircle /> | |
| okButtonProps | The ok button props | [ButtonProps](/components/button/#API) | - | |
| okText | The text of the Confirm button | string | `OK` | |
| okType | Button `type` of the Confirm button | string | `primary` | |
| showCancel | Show cancel button | boolean | true | 4.17.0 |
| title | The title of the confirmation box | ReactNode \| () => ReactNode | - | |
| onCancel | A callback of cancel | function(e) | - | |
| onConfirm | A callback of confirmation | function(e) | - | |
Consult [Tooltip's documentation](/components/tooltip/#API) to find more APIs.
## Note
Please ensure that the child node of `Popconfirm` accepts `onMouseEnter`, `onMouseLeave`, `onFocus`, `onClick` events.