ckeditor5-1.0.x-dev/src/Annotation/CKEditor5Plugin.php

<?php

namespace Drupal\ckeditor5\Annotation;

use Drupal\ckeditor5\Plugin\CKEditor5PluginDefault;
use Drupal\Component\Annotation\Plugin;

/**
 * Defines a CKEditor5Plugin annotation object.
 *
 * Plugin Namespace: Plugin\CKEditor5Plugin.
 *
 * @see \Drupal\ckeditor5\Plugin\CKEditorPluginInterface
 * @see \Drupal\ckeditor5\Plugin\CKEditorPluginBase
 * @see \Drupal\ckeditor5\Plugin\CKEditorPluginManager
 * @see plugin_api
 *
 * @Annotation
 */
class CKEditor5Plugin extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The human-readable name of the CKEditor plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   * @ingroup plugin_translatable
   */
  public $label;

  /**
   * The CKEditor5Plugin class.
   *
   * Default value provided for plugins defined in yml.
   *
   * @var string
   */
  public $class = CKEditor5PluginDefault::class;

  /**
   * The library this plugin requires.
   *
   * @var string|null optional
   */
  public $library;

  /**
   * The admin library this plugin provides.
   *
   * @var string|null optional
   */
  public $admin_library;

  /**
   * The CKEditor5 plugin classes provided.
   *
   * Found in the CKEditor5 global js object as {package.Class}.
   *
   * @var array|null optional
   */
  public $plugins;

  /**
   * A keyed array of additional values for the CKEditor5 constructor config.
   *
   * @var mixed[]|null optional
   */
  public $plugin_config;

  /**
   * List of elements and attributes provided.
   *
   * Syntax for each array value:
   * - <element> only allows that HTML element with no attributes
   * - <element attrA attrB> only allows that HTML element with attributes attrA
   *   and attrB, and any value for those attributes.
   * - <element attrA="foo bar baz" attrB="qux-*"> only allows that HTML element
   *   with attributes attrA (if attrA contains one of the three listed values)
   *   and attrB (if its value has the provided prefix).
   * - <element data-*> only allows that HTML element with any attribute that
   *   has the given prefix.
   *
   * @var string[]|null optional
   */
  public $elements;

  /**
   * List of toolbar items the plugin provides.
   *
   * @var array|null optional
   */
  public $toolbar_items;

  /**
   * List of conditions to enable this plugin.
   *
   * @var array|null optional
   */
  public $conditions;

}