Class kartik\editable\Editable

Active form instance

Configuration of icons for BS3 and BS4

The HTML attributes or options for the input/widget

The i18n message category

The generated configuration for the kartik\popover\PopoverX widget.

Additional data to be passed when editable is submitted via ajax request as $key => $value pairs. This will generate hidden inputs in the editable form with input name as $key and input value as $value.

The content to be placed after the rendered input. If not set as a string, this can be passed as a callback function of the following signature: function ($form, $widget) { // echo $form->field($widget->model, 'attrib'); }

where:

• $form: ActiveForm, is the active form instance for the editable form
• $widget: Editable, is the current editable widget instance

Additional ajax settings to pass to the plugin.

See also http://api.jquery.com/jquery.

Editable fade animation delay (in micro-seconds). If entered as a string, it can be one of 'slow' or 'fast'.

See also http://api.jquery.com/fadein/.

Whether to show the editable input as a popover. Defaults to true. If set to false, it will be rendered inline.

The content to be placed before the rendered input. If not set as a string, this can be passed as a callback function of the following signature:

function ($form, $widget) {
   // echo $form->field($widget->model, 'attrib');
}

where:

• $form: ActiveForm, is the active form instance for the editable form
• $widget: Editable, is the current editable widget instance

The template for rendering the buttons

Whether to close the editable form when it loses focus.

The HTML attributes for the editable container

The HTML attributes for the container enclosing the main content in the popover dialog.

The default icon for editable button set as the label in $editableButtonOptions. Defaults to <i class="glyphicon glyphicon-pencil"></i> for [[bsVersion]] = '3.x' and for $bsVersion = '4.x'

The default icon for editable button used in the $preHeader. Defaults to: <i class="glyphicon glyphicon-edit"></i> for $bsVersion = '3.x' and <i class="fas fa-edit"></i> Edit for $bsVersion = '4.x'

The default icon for editable button used in the $preHeader. Defaults to: <i class="glyphicon glyphicon-ban-circle"></i> for $bsVersion = '3.x' and <i class="fas fa-ban"></i> for $bsVersion = '4.x'

The default icon for editable button used in the $preHeader. Defaults to: <i class="glyphicon glyphicon-ok"></i> for $bsVersion = '3.x' and <i class="fas fa-check"></i> for $bsVersion = '4.x'

The value to be displayed. If not set, this will default to the attribute value. If the attribute value is null, then this will display the value as set in $valueIfNull.

The configuration to auto-calculate display value, based on the value of the editable input. This should be a single dimensional array whose keys must match the input value, and the array values must be the description to be displayed. For example, to display user friendly bool values, you could configure this as [0 => 'Inactive', 1 => 'Active']. If this is set, it will override any value set in displayValue.

The HTML attributes for the editable button to be displayed when the format has been set to 'button':

• label: string, the editable button label. This is not HTML encoded. Defaults to $defaultEditableBtnIcon.

The HTML attributes for the editable value displayed

Whether to HTML encode the output via javascript after editable update. Defaults to true. Note that this is only applied, if you do not return an output value via your AJAX response action. If you return an output value via AJAX it will not be HTML encoded.

The footer content in the popover dialog or inline panel. The following special tags/variables will be parsed and replaced in the footer:

• {loading}: string, will be replaced with the loading indicator.
• {buttons}: string, will be replaced with the submit and reset button. If this is set to null or an empty string, it will not be displayed.

The class for the ActiveForm widget to be used. The class must extend from \yii\widgets\ActiveForm. This defaults to \kartik\form\ActiveForm.

The options for the ActiveForm widget class selected in formClass.

The display format for the editable. Accepts one of the following values.

• `'link' or kartik\editable\Editable::FORMAT_LINK: will convert the text to a clickable editable link.
• `'button' or kartik\editable\Editable::FORMAT_BUTTON: will display a separate button beside the text. Defaults to kartik\editable\Editable::FORMAT_LINK if you do not set it as kartik\editable\Editable::FORMAT_BUTTON.

The header content in the popover dialog or inline panel. If not set, this will be auto generated based on the attribute label or set to null.

The settings for the inline editable when $asPopover is false. The following properties are recognized:

• options: array, the HTML attributes for the div panel container that will enclose the inline content. By default the options will be set to ['class' => 'card panel panel-default'].
• closeButton: string, the markup for rendering the close button to close the inline panel. Note the markup must have the CSS class kv-editable-close to trigger the closure of the inline panel. The closeButton defaults to <button class="kv-editable-close close">&times;</button>.
• templateBefore: string, the template for inline content rendered before the input. Defaults to INLINE_BEFORE_1.
• templateAfter: string, he template for inline content rendered after the input. Defaults to INLINE_AFTER_1. The following tokens in the templates above will be automatically replaced:
  • '{header}': the header generated via preHeader and header properties.
  • '{inputs}': the main form input content (combining beforeInput, the input/widget generated based on inputType, and afterInput)
  • '{buttons}': the form action buttons (submit and reset).
  • '{loading}': the loading indicator.
  • '{close}': the close button to close the inline content as set in inlineSettings['closeButton'].

The HTML attributes for the input container applicable only when not using with ActiveForm

The ActiveField configuration, if you are using with model.

The input type to render for the editing the input in the editable form. This must be one of the Editable::TYPE constants.

The options for the input. If the inputType is one of the HTML inputs, this will capture the HTML attributes. If the inputType is set to INPUT_WIDGET or set to an input widget from the \kartik\ namespace, then this will capture the widget options.

The identifier for the PJAX widget container if the editable widget is to be rendered inside a PJAX container. This will ensure the PopoverX plugin is initialized correctly after a PJAX request is completed. If this is not set, no re-initialization will be done for pjax.

The popover placement. Must be one of the PopoverX::ALIGN constants Defaults to kartik\popover\PopoverX::ALIGN_RIGHT or right. This will be applied only if $asPopover is true.

The header content placed before the header text in the popover dialog or inline panel. This defaults to: '{icon} Edit' - where {icon} is the $defaultPreHeaderIcon markup.

The HTML attributes for the form reset button. The following special properties are additionally recognized:

• icon: string, the icon for the button. Defaults to $defaultResetBtnIcon
• label: string, the label of the button. This is HTML encoded. Defaults to Reset and is translated via yii i18n message files.

Editable reset delay (in micro-seconds).

Whether to select all text in the input when editable is opened.

Whether to display any ajax processing errors. Defaults to true.

Whether you want to show the button labels. Defaults to false.

Whether you wish to automatically display the form submit and reset buttons. Defaults to true.

The size of the popover window. One of the PopoverX::SIZE constants. This will be applied only if $asPopover is true.

The HTML attributes for the form submit button. The following special properties are additionally recognized:

• icon: string, the icon for the button. Defaults to $defaultSubmitBtnIcon.
• label: string, the label of the button. This is HTML encoded. Defaults to Apply and is translated via yii i18n message files.

Whether to auto submit/save the form on pressing ENTER key.

The popover contextual type. Must be one of the PopoverX::TYPE constants Defaults to kartik\popover\PopoverX::TYPE_DEFAULT or default. This will be applied only if $asPopover is true.

Editable submission validation delay (in micro-seconds).

The value to display if the displayValue is null. Defaults to '(not set)'.

Any custom widget class to use. Will only be used if the inputType is set to INPUT_WIDGET