class CodeMirror in The CodeMirror Editor 8

Provides a form element for input text with code highlighting.

Properties:

• #codemirror: array of CodeMirror options.
• All textarea options.

Usage example:

$form['code'] = [
  '#type' => 'codemirror',
  '#title' => $this
    ->t('Text'),
];

Plugin annotation

@FormElement("codemirror");

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
      • class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
        • class \Drupal\Core\Render\Element\Textarea
          • class \Drupal\codemirror_editor\Element\CodeMirror

See also

\Drupal\Core\Render\Element\TextArea

1 file declares its use of CodeMirror

codemirror_editor.module in ./codemirror_editor.module

Primary module hooks for CodeMirror editor module.

1 string reference to 'CodeMirror'

codemirror_editor.links.menu.yml in ./codemirror_editor.links.menu.yml

codemirror_editor.links.menu.yml

2 #type uses of CodeMirror

CodeMirrorEditorTestForm::buildForm in tests/codemirror_editor_test/src/Form/CodeMirrorEditorTestForm.php

Form constructor.

CodeMirrorEditorWidget::formElement in src/Plugin/Field/FieldWidget/CodeMirrorEditorWidget.php

Returns the form for a single field widget.

File

src/Element/CodeMirror.php, line 26

Namespace

Drupal\codemirror_editor\Element

class CodeMirror extends Textarea {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $info = parent::getInfo();
    $info['#codemirror'] = [];
    $info['#pre_render'][] = [
      static::class,
      'preRenderCodeMirror',
    ];
    return $info;
  }

  /**
   * Enables CodeMirror editor for the element.
   *
   * @param array $element
   *   An associative array containing the properties and children of the
   *   element.
   *
   * @return array
   *   The modified element.
   */
  public static function preRenderCodeMirror(array $element) {
    if (isset($element['#codemirror'])) {
      $element['#attributes']['data-codemirror'] = json_encode($element['#codemirror']);
      $element['#attached']['library'][] = 'codemirror_editor/editor';
    }
    return $element;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CodeMirror::getInfo	public	function	Returns the element properties for this element. Overrides Textarea::getInfo
CodeMirror::preRenderCodeMirror	public static	function	Enables CodeMirror editor for the element.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FormElement::processAutocomplete	public static	function	Adds autocomplete functionality to elements.
FormElement::processPattern	public static	function	#process callback for #pattern form element property.
FormElement::validatePattern	public static	function	#element_validate callback for #pattern form element property.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
RenderElement::preRenderAjaxForm	public static	function	Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup	public static	function	Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm	public static	function	Form element processing handler for the #ajax form property.	1
RenderElement::processGroup	public static	function	Arranges elements into groups.
RenderElement::setAttributes	public static	function	Sets a form element's class attribute. Overrides ElementInterface::setAttributes
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
Textarea::valueCallback	public static	function	Determines how user input is mapped to an element's #value property. Overrides FormElement::valueCallback