Class humhub\widgets\ModalConfirm

Inheritancehumhub\widgets\ModalConfirm » yii\base\Widget
Available since version0.5
Deprecated since version1.2 Prefer using js api humhub.ui.modal.confirm.

ModalConfirmWidget shows a confirm modal before calling an action

After successful confirmation this widget returns the response of the called action. So be ensure to write an workflow for that inside your controller action. (for example: close modal, reload page etc.)

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$ariaLabel humhub\widgets\ModalConfirm
$buttonFalse String Button name for canceling humhub\widgets\ModalConfirm
$buttonTrue String Button name for confirming humhub\widgets\ModalConfirm
$confirmJS String Contains optional JavaScript code to execute, after user clicked the TrueButton By default (when it remains empty), the modal content will be replaced with the content from $linkHref humhub\widgets\ModalConfirm
$cssClass String Classes for the displaying link humhub\widgets\ModalConfirm
$linkContent String Content for the displaying link humhub\widgets\ModalConfirm
$linkHref String Original path to view humhub\widgets\ModalConfirm
$linkOutput String Define the output element humhub\widgets\ModalConfirm
$linkTooltipText String Tooltip text humhub\widgets\ModalConfirm
$message String Message to show humhub\widgets\ModalConfirm
$modalShownJS String Contains optional JavaScript code to execute after modal has been made visible to the user humhub\widgets\ModalConfirm
$style String Style for the displaying link humhub\widgets\ModalConfirm
$title String Title to show humhub\widgets\ModalConfirm
$uniqueID String Message to show humhub\widgets\ModalConfirm

Public Methods

Hide inherited methods

MethodDescriptionDefined By
run() Displays / Run the Widgets humhub\widgets\ModalConfirm

Property Details

$ariaLabel public property
public $ariaLabel ""
$buttonFalse public property

Button name for canceling

public String $buttonFalse ""
$buttonTrue public property

Button name for confirming

public String $buttonTrue ""
$confirmJS public property

Contains optional JavaScript code to execute, after user clicked the TrueButton By default (when it remains empty), the modal content will be replaced with the content from $linkHref

public String $confirmJS ""
$cssClass public property

Classes for the displaying link

public String $cssClass null
$linkContent public property

Content for the displaying link

public String $linkContent null
$linkHref public property

Original path to view

public String $linkHref null
$linkOutput public property

Define the output element

public String $linkOutput 'a'
$linkTooltipText public property

Tooltip text

public String $linkTooltipText ""
$message public property

Message to show

public String $message null
$modalShownJS public property

Contains optional JavaScript code to execute after modal has been made visible to the user

public String $modalShownJS ""
$style public property

Style for the displaying link

public String $style null
$title public property

Title to show

public String $title null
$uniqueID public property

Message to show

public String $uniqueID null

Method Details

run() public method

Displays / Run the Widgets

public void run ( )