ant-design/components/popconfirm/index.en-US.md

31 lines
1.2 KiB
Markdown
Raw Normal View History

---
category: Components
type: Feedback
2016-08-26 15:07:46 +08:00
title: Popconfirm
---
A simple and compact confirmation dialog of an action.
2016-09-10 13:43:30 +08:00
## 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 |
|-----------|------------------------------------------|---------------|--------|
| title | title of the confirmation box | string\|ReactNode | - |
| onConfirm | callback of confirmation | function(e) | - |
| onCancel | callback of cancel | function(e) | - |
| okText | text of the Confirm button | string | `Confirm` |
| okType | Button `type` of the Confirm button | string | `primary` |
| cancelText| text of the Cancel button | string | `Cancel` |
Consult [Tooltip's documentation](https://ant.design/components/tooltip/#API) to find more APIs.
## Note
Please ensure that the child node of `Popconfirm` accepts `onMouseEnter`, `onMouseLeave`, `onFocus`, `onClick` events.