ant-design/components/popconfirm/index.en-US.md
Tom Xu 2961dda311
docs: improve popconfirm (#23905)
* docs: improve popconfirm

* Update index.zh-CN.md
2020-05-06 17:37:49 +08:00

1.3 KiB

category type title
Components Feedback Popconfirm

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
cancelText text of the Cancel button string Cancel
okText text of the Confirm button string OK
okType Button type of the Confirm button string primary
okButtonProps The ok button props ButtonProps -
cancelButtonProps The cancel button props ButtonProps -
title title of the confirmation box string|ReactNode|() => ReactNode -
onCancel callback of cancel function(e) -
onConfirm callback of confirmation function(e) -
icon customize icon of confirmation ReactNode <ExclamationCircle />
disabled is show popconfirm when click its childrenNode boolean false

Consult Tooltip's documentation to find more APIs.

Note

Please ensure that the child node of Popconfirm accepts onMouseEnter, onMouseLeave, onFocus, onClick events.