Class kartik\editors\Codemirror

All Classes | Properties | Methods | Events | Constants
Inheritancekartik\editors\Codemirror » kartik\base\InputWidget » yii\widgets\InputWidget » 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 version2.0

Class for wrapping the Codemirror editor javascript library. Uses custom codemirror jQuery plugin built by Krajee for wrapping the core javascript library.

See also https://codemirror.net/.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$attribute string|null The model attribute that this widget is associated with. yii\widgets\InputWidget
$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
$buttonGroupOptions array HTML attributes for the toolbar button groups that will be globally applied. kartik\editors\Codemirror
$buttonOptions array HTML attributes for the toolbar buttons that will be globally applied. kartik\editors\Codemirror
$buttons array Toolbar buttons configuration. kartik\editors\Codemirror
$container array HTML attributes of the container to render the toolbar and editor. kartik\editors\Codemirror
$convertFormat boolean Whether the widget should automatically format the date from the PHP DateTime format to the javascript/jquery plugin format. kartik\base\InputWidget
$counter integer A counter used to generate $id for widgets. yii\base\Widget
$data array The data (for list inputs) kartik\base\InputWidget
$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
$disabled boolean Whether input is to be disabled kartik\base\InputWidget
$dropdownClass string Bootstrap dropdown class name based on currently configured bootstrap version (readonly property available via getter method getDropdownClass()) kartik\base\BootstrapTrait
$enablePrettyFormat boolean Whether to enable the toolbar button for pretty formatting code kartik\editors\Codemirror
$field yii\widgets\ActiveField Active input field, which triggers this widget rendering. yii\widgets\InputWidget
$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
$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
$krajeePresets array Default Krajee presets for the Codemirror plugin kartik\editors\Codemirror
$language string The language configuration (e.g. 'fr-FR', 'zh-CN'). kartik\base\InputWidget
$libraries array A list of addon library component files to include from the Codemirror CDN. kartik\editors\Codemirror
$model yii\base\Model|null The data model that this widget is associated with. yii\widgets\InputWidget
$moduleId string The module identifier if this widget is part of a module. kartik\base\WidgetTrait
$name string|null The input name. yii\widgets\InputWidget
$options array The HTML attributes for the input tag. yii\widgets\InputWidget
$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
$pluginLoading boolean Show loading indicator while plugin loads kartik\base\InputWidget
$pluginName string The plugin name kartik\editors\Codemirror
$pluginOptions array Widget plugin options. kartik\base\WidgetTrait
$preset string|null|false The name of the preset to use. kartik\editors\Codemirror
$readonly boolean Whether input is to be readonly kartik\base\InputWidget
$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
$toolbar array The toolbar configuration kartik\editors\Codemirror
$toolbarOptions array The HTML attributes for the toolbar kartik\editors\Codemirror
$toolbarPosition string The position of the toolbar with respect to the editor (can be either top or bottom). kartik\editors\Codemirror
$useKrajeePresets boolean Whether to use Krajee presets for toolbar and other plugin settings. kartik\editors\Codemirror
$value string The input value. yii\widgets\InputWidget
$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
$_defaultPresets array List of default presets kartik\editors\Codemirror
$_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
$_lang string The two or three letter lowercase code for the language according to ISO-639. kartik\base\InputWidget
$_langFile string The language js file. kartik\base\InputWidget
$_loadIndicator string The indicator to be displayed while plugin is loading. kartik\base\InputWidget
$_msgCat string Translation message file category name for i18n. kartik\base\TranslationTrait
$defaultButtons array List of default buttons kartik\editors\Codemirror

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 widget. yii\widgets\InputWidget
initI18N() Yii i18n messages configuration for generating translations kartik\base\TranslationTrait
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 needed assets kartik\editors\Codemirror
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
renderButton() Renders a button in the toolbar kartik\editors\Codemirror
renderButtonGroup() Renders a button group in the toolbar kartik\editors\Codemirror
renderFile() Renders a view file. yii\base\Widget
renderToolbar() Renders the toolbar kartik\editors\Codemirror
run() Executes the widget. kartik\editors\Codemirror
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
convertDateFormat() Automatically convert the date format from PHP DateTime to Javascript DateTime format kartik\base\InputWidget
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
getInput() Generates an input. kartik\base\InputWidget
getPluginScript() Returns the plugin registration script. kartik\base\WidgetTrait
hasModel() yii\widgets\InputWidget
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
initButtons() Initialize default buttons. Set it up as an array of key value pairs, where the key is the button name and the value is the HTML attributes for the button. The special attribute label will parse the label to be rendered for the button. kartik\editors\Codemirror
initDestroyJs() Generates the pluginDestroyJs script if it is not set. kartik\base\WidgetTrait
initDisability() Validates and sets disabled or readonly inputs. kartik\base\InputWidget
initInputWidget() Initializes the input widget. kartik\base\InputWidget
initLanguage() Initialize the plugin language. kartik\base\InputWidget
initPresets() Initialize presets kartik\editors\Codemirror
initWidget() Initializes widget kartik\editors\Codemirror
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
parseDateFormat() Parses and sets plugin date format based on attribute type using yii\helpers\FormatConverter. Currently this method is used only within the kartik\date\DatePicker and \kartik\datetime\DateTimePicker\ widgets. kartik\base\InputWidget
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
renderInputHtml() Render a HTML input tag. yii\widgets\InputWidget
setDataVar() Sets a HTML5 data variable. kartik\base\WidgetTrait
setLanguage() Sets the language JS file if it exists. kartik\base\InputWidget

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
DEFAULT_THEME 'default' kartik\editors\Codemirror
LOAD_PROGRESS '
 
'		 kartik\base\InputWidget
PRESET_GFM 'gfm' kartik\editors\Codemirror
PRESET_HTML 'html' kartik\editors\Codemirror
PRESET_JS 'js' kartik\editors\Codemirror
PRESET_JSON 'json' kartik\editors\Codemirror
PRESET_PHP 'php' kartik\editors\Codemirror

Property Details

$_defaultPresets protected property

List of default presets

protected array $_defaultPresets = []
$buttonGroupOptions public property

HTML attributes for the toolbar button groups that will be globally applied.

public array $buttonGroupOptions = [
    'class' => 'btn-group mr-2', 'role' => 'group'
]
$buttonOptions public property

HTML attributes for the toolbar buttons that will be globally applied.

public array $buttonOptions = [
    'class' => 'btn btn-default btn-light', 'data-tooltips' => 'true'
]
$buttons public property

Toolbar buttons configuration. See $defaultButtons and initButtons() to understand the default toolbar button configuration.

public array $buttons = []
$container public property

HTML attributes of the container to render the toolbar and editor. The following special attributes are recognized:

  • tag: string, the HTML tag used for rendering the container. Defaults to div.
public array $container = []
$defaultButtons protected property

List of default buttons

protected array $defaultButtons = []
$enablePrettyFormat public property

Whether to enable the toolbar button for pretty formatting code

public boolean $enablePrettyFormat = true
$krajeePresets public property

Default Krajee presets for the Codemirror plugin

public array $krajeePresets = [
    'theme' => self::DEFAULT_THEME, 'mode' => 'htmlmixed', 'lint' => true, 'lineNumbers' => true, 'styleActiveLine' => true, 'matchBrackets' => true, 'smartIndent' => true
]
$libraries public property

A list of addon library component files to include from the Codemirror CDN. Enter as relative path to the Codemirror CDN base url.

public array $libraries = []
$pluginName public property

The plugin name

public string $pluginName = 'kvCodemirror'
$preset public property

The name of the preset to use. See the PRESET constants. This will be merged with Krajee preset settings when $useKrajeePresets is set to true). Set this to null or false if you do not want any preset. You can also set a preset and override the settings in pluginOptions.

public string|null|false $preset = self::PRESET_HTML
$toolbar public property

The toolbar configuration

public array $toolbar = [
    'actions' => ['buttons' => ['undo', 'redo', 'selectall']], 'edit' => ['buttons' => ['copy', 'cut', 'paste']], 'format' => ['buttons' => ['indent', 'outdent', 'format']], 'comment' => ['buttons' => ['comment', 'uncomment']], 'view' => ['buttons' => ['fullscreen'], 'options' => ['class' => 'pull-right ml-auto']]]
$toolbarOptions public property

The HTML attributes for the toolbar

public array $toolbarOptions = [
    'class' => 'btn-toolbar'
]
$toolbarPosition public property

The position of the toolbar with respect to the editor (can be either top or bottom). Defaults to top.

public string $toolbarPosition = 'top'
$useKrajeePresets public property

Whether to use Krajee presets for toolbar and other plugin settings. You can override these through plugin options;

public boolean $useKrajeePresets = true

Method Details

initButtons() protected method

Initialize default buttons. Set it up as an array of key value pairs, where the key is the button name and the value is the HTML attributes for the button. The special attribute label will parse the label to be rendered for the button.

protected void initButtons ( )
initPresets() protected method

Initialize presets

protected void initPresets ( )
initWidget() protected method

Initializes widget

protected void initWidget ( )
registerAssets() public method

Registers the needed assets

public void registerAssets ( )
renderButton() public method

Renders a button in the toolbar

public string renderButton ( $name )
$name string

The name of the button
renderButtonGroup() public method

Renders a button group in the toolbar

public string renderButtonGroup ( $name )
$name string
renderToolbar() public method

Renders the toolbar

public string renderToolbar ( )
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