since 11.0.0

Employment/Purpose

Confirmpopup asks the user to confirm an action without interrupting the page with a modal dialog. Open it from the action’s component so the popup arrow points back to the source.

Example

<button label="Delete" onClick="confirm.open(self)"/>
<confirmpopup id="confirm"
              placement="top"
              severity="error"
              title="Confirm delete"
              message="This cannot be undone. Continue?"
              defaultFocus="cancel"
              onOK='Clients.showNotification("Deleted")'/>

The OK and Cancel labels come from ZK’s locale bundle.

Properties

Title and Message

title sets the title row and message sets the main prompt. A null or empty title hides the title row.

IconSclass

Default Value: z-icon-exclamation-triangle

Set an icon font class, set an empty string to hide the icon, or set null to restore the default.

Severity

Default Value: warning

Allowed values are info, success, warning, error, and neutral. Other values cause a WrongValueException.

Placement

Default Value: top

Allowed values are top, bottom, left, and right. The popup positions itself relative to the component passed to open(Component).

DefaultFocus

Default Value: ok

Allowed values are ok and cancel. Prefer cancel for destructive operations so an accidental Enter does not confirm them.

Supported Events

Name Event Type
onOK Event: org.zkoss.zk.ui.event.Event Fired when the user confirms.
onCancel Event: org.zkoss.zk.ui.event.Event Fired when the user selects Cancel, presses Escape, or dismisses the popup.

Inherited Functions

Please refer to Popup for open, close, and inherited behavior.

Supported Children

*NONE

Confirmpopup renders its title, message, and action buttons internally, so it does not accept child components.