ant-design/components/popconfirm/index.en-US.md
MadCcc 4ecc0d7f95
docs: optimize overview svg (#47203)
* docs: optimize overview svg

* docs: update

* docs: dark
2024-01-29 14:50:36 +08:00

2.5 KiB
Raw Blame History

category group title cover coverDark demo
Components Feedback Popconfirm https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*a7tqQ6wrdeAAAAAAAAAAAAAADrJ8AQ/original https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*iwYsQpeFcB0AAAAAAAAAAAAADrJ8AQ/original
cols
2

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.

Examples

Basic Locale text Placement Conditional trigger Customize icon Asynchronously close Asynchronously close on Promise _InternalPanelDoNotUseOrYouWillBeFired Wireframe

API

Common props refCommon props

Param Description Type Default value Version
cancelButtonProps The cancel button props ButtonProps -
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 <ExclamationCircle />
okButtonProps The ok button props ButtonProps -
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.18.0
title The title of the confirmation box ReactNode | () => ReactNode -
description The description of the confirmation box title ReactNode | () => ReactNode - 5.1.0
onCancel A callback of cancel function(e) -
onConfirm A callback of confirmation function(e) -
onPopupClick A callback of popup click function(e) - 5.5.0

Consult Tooltip's documentation to find more APIs.

Design Token

Note

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