Trait kartik\base\WidgetTrait

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.

The JSON encoded plugin options.

The generated hashed variable name that will store the JSON encoded pluginOptions in yii\web\View::POS_HEAD.

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.

Default HTML attributes or other settings for widgets.

Default plugin options for the widget

The position where the client JS hash variables for the input widget will be loaded.

Defaults to View::POS_HEAD. This can be set to View::POS_READY for specific scenarios like when rendering the widget via renderAjax.

The module identifier if this widget is part of a module.

If not set, the module identifier will be auto derived based on the \yii\base\Module::getInstance method. This can be useful, if you are setting multiple module identifiers for the same module in your Yii configuration file. To specify children or grand children modules you can specify the module identifiers relative to the parent module (e.g. admin/content).

The identifier for the PJAX widget container if the widget is to be rendered inside a PJAX container.

This will ensure the any jQuery plugin using the widget is initialized correctly after a PJAX request is completed. If this is not set, no re-initialization will be done for pjax.

Prevent duplication of pjax containers when browser back & forward buttons are pressed.

• If this property is not set, it will be defaulted from Yii::$app->params['pjaxDuplicationFix'].
• If Yii::$app->params['pjaxDuplicationFix'] is not set, then this property will default to true.

The javascript that will be used to destroy the jQuery plugin

Widget JQuery events.

You must define events in event-name => event-function format. For example:

pluginEvents = [
    'change' => 'function() { log("change"); }',
    'open' => 'function() { log("open"); }',
];

The plugin name

Widget plugin options.

Directory path to the original widget source. If not set, will default to the working directory for the current widget's class. Setting this property can be useful in specific cases, like when you are extending the Krajee widget with your own custom namespaced class. In that case, set this property to the original Krajee Widget Base path. Yii path alias parsing is supported (using @ symbols). For example:

// your custom extended widget
namespace myapp\widgets;
class MyDateRangePicker extends kartik\daterange\DateRangePicker {
    // directly set the property to the original Krajee base widget directory
    // you can use Yii path aliases
    public $sourcePath = '@vendor/kartik-v/yii2-date-range/src';
}

// Alternatively you can also override this property while rendering the widget
// view.php: where widget is rendered
use myapp\widgets\MyDateRangePicker;

echo MyDateRangePicker::widget([
    'name' => 'custom',
    'sourcePath' => '@vendor/kartik-v/yii2-date-range/src'
]);