Class kartik\dialog\Dialog

Inheritancekartik\dialog\Dialog » kartik\base\Widget » yii\base\Widget » yii\base\Component » yii\base\BaseObject
Implementskartik\base\BootstrapInterface, yii\base\Configurable, yii\base\ViewContextInterface
Uses Traitskartik\base\BootstrapTrait, kartik\base\TranslationTrait, kartik\base\WidgetTrait
Available since version1.0

Dialog widget allows an easy configuration to control javascript dialogs and also generate rich styled bootstrap modal dialogs using bootstrap3-dialog plugin. The widget provides its own advanced javascript library KrajeeDialog that acts a polyfill for the native javascript alert, confirm, and prompt dialog boxes.

Example 1: Usage for a default dialog.

echo Dialog::widget([
   'libName' => 'krajeeDialog',
   'options => [], // default options
]);

Example 2: Usage for a customized dialog.

echo Dialog::widget([
   'libName' => 'krajeeDialogCust',
   'options => ['draggable' => true, 'closable' => true], // custom options
]);

Then you can use your own javascript as shown below to render your alert, confirm, and prompt boxes:

// use krajeeDialog object instance
$('#btn-1').on('click', function() {
    krajeeDialog.alert('An alert');
    // or show a confirm
    krajeeDialog.confirm('Are you sure', function(out){
        if(out) {
            alert('Yes'); // or do something on confirmation
        }
    });

});

// use krajeeDialogCust object instance
$('#btn-2').on('click', function() {
    krajeeDialogCust.alert('An alert');
    // or show a prompt
    krajeeDialogCust.prompt({label:'Provide reason', placeholder:'Upto 30 characters...'}, function(out){
        if (out) {
            alert('Yes'); // or do something based on the value of out
        }
    });

});

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$autoIdPrefix string The prefix to the automatically generated widget IDs. yii\base\Widget
$baseSourcePath string|false Get parsed base source path based on $sourcePath setting. If $sourcePath is not set, it will return the current working directory of this widget class. kartik\base\WidgetTrait
$behaviors yii\base\Behavior[] List of behaviors attached to this component. yii\base\Component
$bsColCssPrefixes array The bootstrap grid column css prefixes mapping, the key is the bootstrap versions, and the value is an array containing the sizes and their corresponding grid column css prefixes. kartik\base\BootstrapTrait
$bsCssMap array CSS conversion mappings across bootstrap library versions. kartik\base\BootstrapTrait
$bsExtBasename integer The yii2 bootstrap extension base name (readonly property available via getter method getBsExtBasename()) kartik\base\BootstrapTrait
$bsVer integer Bootstrap version number currently set (readonly property available via getter method getBsVer()) kartik\base\BootstrapTrait
$bsVersion integer|string The bootstrap library version that you wish to use for this specific extension / widget. kartik\base\BootstrapTrait
$counter integer A counter used to generate $id for widgets. yii\base\Widget
$defaultBtnCss string Default bootstrap button CSS (readonly property available via getter method getDefaultBtnCss()) kartik\base\BootstrapTrait
$defaultIconPrefix string Default icon prefix (readonly property available via getter method getDefaultIconPrefix()) kartik\base\BootstrapTrait
$defaultOptions array Default HTML attributes or other settings for widgets. kartik\base\WidgetTrait
$defaultPluginOptions array Default plugin options for the widget kartik\base\WidgetTrait
$dialogDefaults array The default dialog settings for alert, confirm, and prompt. kartik\dialog\Dialog
$dropdownClass string Bootstrap dropdown class name based on currently configured bootstrap version (readonly property available via getter method getDropdownClass()) kartik\base\BootstrapTrait
$hashVarLoadPosition integer The position where the client JS hash variables for the input widget will be loaded. kartik\base\WidgetTrait
$i18n array The the internalization configuration for this widget. kartik\base\TranslationTrait
$iconCancel string Icon CSS suffix to be added for the CANCEL button in the dialog. kartik\dialog\Dialog
$iconOk string Icon CSS suffix to be added for the OK button in the dialog. kartik\dialog\Dialog
$iconSpinner string Icon CSS suffix to be added for the SPINNER button in the dialog. kartik\dialog\Dialog
$id string|null ID of the widget. Note that the type of this property differs in getter and setter. See getId() and setId() for details. yii\base\Widget
$jsPosition integer The registration position for the Krajee dialog JS client code. kartik\dialog\Dialog
$libName string The identifying name of the public javascript id that will hold the settings for KrajeeDialog javascript object instance. kartik\dialog\Dialog
$moduleId string The module identifier if this widget is part of a module. kartik\base\WidgetTrait
$options array The configuration options for the bootstrap dialog (applicable when $useNative is false). kartik\dialog\Dialog
$overrideYiiConfirm boolean Whether to override the yii javascript confirmation dialog (set via data-confirm) with KrajeeDialog confirmation dialog. kartik\dialog\Dialog
$pjaxContainerId string The identifier for the PJAX widget container if the widget is to be rendered inside a PJAX container. kartik\base\WidgetTrait
$pjaxDuplicationFix boolean Prevent duplication of pjax containers when browser back & forward buttons are pressed. kartik\base\WidgetTrait
$pluginDestroyJs string The javascript that will be used to destroy the jQuery plugin kartik\base\WidgetTrait
$pluginEvents array Widget JQuery events. kartik\base\WidgetTrait
$pluginName string The plugin name kartik\base\WidgetTrait
$pluginOptions array Widget plugin options. kartik\base\WidgetTrait
$showDraggable boolean (DEPRECATED) applicable only for versions v1. kartik\dialog\Dialog
$sourcePath string Directory path to the original widget source. kartik\base\WidgetTrait
$stack yii\base\Widget[] The widgets that are currently being rendered (not ended). yii\base\Widget
$useNative boolean Whether to use the native javascript dialog for rendering the popup prompts. kartik\dialog\Dialog
$view yii\web\View The view object that can be used to render views or view files. Note that the type of this property differs in getter and setter. See getView() and setView() for details. yii\base\Widget
$viewPath string The directory containing the view files for this widget. yii\base\Widget

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$_bsVer integer Current bootstrap version number kartik\base\BootstrapTrait
$_dataVar string The HTML5 data variable name that will be used to store the Json encoded pluginOptions within the element on which the jQuery plugin will be initialized. kartik\base\WidgetTrait
$_defaultBtnCss string Default bootstrap button CSS kartik\base\BootstrapTrait
$_defaultIconPrefix string Default icon CSS prefix kartik\base\BootstrapTrait
$_encOptions string The JSON encoded plugin options. kartik\base\WidgetTrait
$_hashVar string The generated hashed variable name that will store the JSON encoded pluginOptions in yii\web\View::POS_HEAD. kartik\base\WidgetTrait
$_isBs4 boolean Flag to detect whether bootstrap 4. kartik\base\BootstrapTrait
$_msgCat string Translation message file category name for i18n. kartik\dialog\Dialog

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\Component
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of a component property. yii\base\Component
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Component
__set() Sets the value of a component property. yii\base\Component
__unset() Sets a component property to be null. yii\base\Component
addCssClass() Adds bootstrap CSS class to options by parsing the bootstrap version for the specified Bootstrap CSS type. kartik\base\BootstrapTrait
afterRun() This method is invoked right after a widget is executed. yii\base\Widget
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
beforeRun() This method is invoked right before the widget is executed. yii\base\Widget
begin() Begins a widget. yii\base\Widget
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
canGetProperty() Returns a value indicating whether a property can be read. yii\base\Component
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Component
className() Returns the fully qualified name of this class. yii\base\BaseObject
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
end() Ends a widget. yii\base\Widget
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
getBSClass() Gets the respective Bootstrap class based on currently configured bootstrap version. kartik\base\BootstrapTrait
getBaseSourcePath() Get parsed base source path based on $sourcePath setting. If $sourcePath is not set, it will return the current working directory of this widget class. kartik\base\WidgetTrait
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getBsVer() Gets the current set bootstrap version number. kartik\base\BootstrapTrait
getCssClass() Gets bootstrap css class by parsing the bootstrap version for the specified BS CSS type. kartik\base\BootstrapTrait
getDefaultBtnCss() Gets the default button CSS kartik\base\BootstrapTrait
getDefaultIconPrefix() Gets the default icon css prefix kartik\base\BootstrapTrait
getDropdownClass() Gets the respective bootstrap dropdown class name based on currently configured bootstrap version. kartik\base\BootstrapTrait
getId() Returns the ID of the widget. yii\base\Widget
getView() kartik\base\WidgetTrait
getViewPath() Returns the directory containing the view files for this widget. yii\base\Widget
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event. yii\base\Component
hasMethod() Returns a value indicating whether a method is defined. yii\base\Component
hasProperty() Returns a value indicating whether a property is defined for this component. yii\base\Component
init() Initializes the object. yii\base\Widget
initI18N() Yii i18n messages configuration for generating translations kartik\base\TranslationTrait
initOptions() Initialize the dialog buttons. kartik\dialog\Dialog
isBs() Validate Bootstrap version kartik\base\BootstrapTrait
isBs4() Validate if Bootstrap 4.x version. kartik\base\BootstrapTrait
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
registerAssets() Registers the client assets for kartik\dialog\Dialog widget. kartik\dialog\Dialog
registerWidgetJs() Registers a JS code block for the widget. kartik\base\WidgetTrait
removeCssClass() Removes bootstrap CSS class from options by parsing the bootstrap version for the specified Bootstrap CSS type. kartik\base\BootstrapTrait
render() Renders a view. yii\base\Widget
renderFile() Renders a view file. yii\base\Widget
run() Executes the widget. kartik\dialog\Dialog
setId() Sets the ID of the widget. yii\base\Widget
setView() Sets the view object to be used by this widget. yii\base\Widget
trigger() Triggers an event. yii\base\Component
widget() Creates a widget instance and runs it. yii\base\Widget

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
addAsset() Adds an asset to the view. kartik\base\WidgetTrait
configureBsVersion() Configures the bootstrap version settings kartik\base\BootstrapTrait
fixPjaxDuplication() Fix for weird PJAX container duplication behavior on pressing browser back and forward buttons. kartik\base\WidgetTrait
getBsExtBasename() The yii2-bootstrap extension base name. kartik\base\BootstrapTrait
getPluginScript() Returns the plugin registration script. kartik\base\WidgetTrait
hashPluginOptions() Generates a hashed variable to store the pluginOptions. kartik\base\WidgetTrait
initBsVersion() Initializes bootstrap versions for the widgets and asset bundles. kartik\base\BootstrapTrait
initDestroyJs() Generates the pluginDestroyJs script if it is not set. kartik\base\WidgetTrait
isSameVersion() Compares two versions and checks if they are of the same major BS version. kartik\base\BootstrapTrait
mergeDefaultOptions() Merge default options kartik\base\WidgetTrait
parseVer() Parses and returns the major BS version kartik\base\BootstrapTrait
registerPlugin() Registers a specific plugin and the related events kartik\base\WidgetTrait
registerPluginOptions() Registers plugin options by storing within a uniquely generated javascript variable. kartik\base\WidgetTrait
setDataVar() Sets a HTML5 data variable. kartik\base\WidgetTrait

Events

Hide inherited events

EventTypeDescriptionDefined By
EVENT_AFTER_RUN yii\base\WidgetEvent An event raised right after executing a widget. (available since version 2.0.11) yii\base\Widget
EVENT_BEFORE_RUN yii\base\WidgetEvent An event raised right before executing a widget. (available since version 2.0.11) yii\base\Widget
EVENT_INIT yii\base\Event An event that is triggered when the widget is initialized via init(). (available since version 2.0.11) yii\base\Widget

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
DIALOG_ALERT 'alert' Alert method name in the KrajeeDialog JS class. kartik\dialog\Dialog
DIALOG_CONFIRM 'confirm' Confirm method name in the KrajeeDialog JS class. kartik\dialog\Dialog
DIALOG_OTHER 'dialog' Other dialog method name in the KrajeeDialog JS class. kartik\dialog\Dialog
DIALOG_PROMPT 'prompt' Prompt method name in the KrajeeDialog JS class. kartik\dialog\Dialog
LIBRARY 'krajeeDialog' Krajee JS dialog library class name. kartik\dialog\Dialog
SIZE_LARGE 'size-large' Bootstrap large modal dialog size. kartik\dialog\Dialog
SIZE_NORMAL 'size-normal' Bootstrap normal modal dialog size. kartik\dialog\Dialog
SIZE_SMALL 'size-small' Bootstrap small modal dialog size. kartik\dialog\Dialog
SIZE_WIDE 'size-wide' Bootstrap wide modal dialog size. The size-wide is equal to bootstrap modal-lg size. kartik\dialog\Dialog
TYPE_DANGER 'type-danger' The danger bootstrap contextual color type. kartik\dialog\Dialog
TYPE_DEFAULT 'type-default' The default bootstrap contextual color type. kartik\dialog\Dialog
TYPE_INFO 'type-info' The information bootstrap contextual color type. kartik\dialog\Dialog
TYPE_PRIMARY 'type-primary' The primary bootstrap contextual color type. kartik\dialog\Dialog
TYPE_SUCCESS 'type-success' The success bootstrap contextual color type. kartik\dialog\Dialog
TYPE_WARNING 'type-warning' The warning bootstrap contextual color type. kartik\dialog\Dialog

Property Details

$_msgCat protected property

Translation message file category name for i18n.

protected string $_msgCat 'kvdialog'
$dialogDefaults public property

The default dialog settings for alert, confirm, and prompt.

public array $dialogDefaults = []
$iconCancel public property

Icon CSS suffix to be added for the CANCEL button in the dialog.

public string $iconCancel null
$iconOk public property

Icon CSS suffix to be added for the OK button in the dialog.

public string $iconOk null
$iconSpinner public property

Icon CSS suffix to be added for the SPINNER button in the dialog.

public string $iconSpinner null
$jsPosition public property

The registration position for the Krajee dialog JS client code.

public integer $jsPosition = \yii\web\View::POS_HEAD
$libName public property

The identifying name of the public javascript id that will hold the settings for KrajeeDialog javascript object instance. Defaults to krajeeDialog.

public string $libName self::LIBRARY
$options public property

The configuration options for the bootstrap dialog (applicable when $useNative is false). You can set the configuration settings as key value pairs that can be recognized by the BootstrapDialog plugin.

public array $options = []
$overrideYiiConfirm public property

Whether to override the yii javascript confirmation dialog (set via data-confirm) with KrajeeDialog confirmation dialog.

$showDraggable public property

(DEPRECATED) applicable only for versions v1.0.3 and below, where if set to true will enable a draggable cursor for draggable dialog boxes when dragging.

for v1.0.6 and above the cursor will always be displayed irrespective of this setting (which can be controlled via CSS).

public boolean $showDraggable true
$useNative public property

Whether to use the native javascript dialog for rendering the popup prompts. If set to false, the bootstrap3-dialog library will be used for rendering the prompts as a modal dialog.

public boolean $useNative false

Method Details

initOptions() public method

Initialize the dialog buttons.

public void initOptions ( )
throws \yii\base\InvalidConfigException|\Exception
registerAssets() public method

Registers the client assets for kartik\dialog\Dialog widget.

public void registerAssets ( )
run() public method

Executes the widget.

public string|void run ( )
return string|void

The rendering result may be directly "echoed" or returned as a string

throws ReflectionException
throws yii\base\InvalidConfigException