', '

' and '

' * tags are allowed, then '<$text-container data-something>' will allow the * 'data-something' attribute for '

', '

' and '

' tags. * Note that while the syntax is the same, some extra nuance is needed: * although this syntax can be used to create an attribute on an element, f.e. * (['']) creating the `behavior` attribute on ``, * the tag itself must be creatable as well (['']). If a plugin wants * the tag and attribute to be created, list both: * (['', '']). Validation logic ensures that a * plugin supporting only the creation of attributes cannot be enabled if the * tag cannot be created via itself or through another CKEditor 5 plugin. * - drupal.toolbar_items: List of toolbar items the plugin provides. Keyed by a * machine name and the value being a pair defining the label: * @code * toolbar_items: * indent: * label: Indent * outdent: * label: Outdent * @encode * - drupal.conditions: Conditions required for the plugin to load (other than * module dependencies, which are defined by the 'provider' property). * Conditions can check for five different things: * - 'toolbarItem': a toolbar item that must be enabled * - 'filter': a filter that must be enabled * - 'imageUploadStatus': TRUE if image upload must be enabled, FALSE if it * must not be enabled * - 'requiresConfiguration': a subset of the configuration for this plugin * that must match (exactly) * - 'plugins': a list of CKEditor 5 Drupal plugin IDs that must be enabled * Plugins requiring more complex conditions, such as requiring multiple * toolbar items or multiple filters, have not yet been identified. If this * need arises, see * https://www.drupal.org/docs/drupal-apis/ckeditor-5-api/overview#conditions. * * All of these can be defined in YAML or attributes. A given plugin should * choose one or the other, as a definition can't parse both at once. * * If the CKEditor 5 plugin contains translation they can be automatically * loaded by Drupal by adding the dependency to the core/ckeditor5.translations * library to the CKEditor 5 plugin library definition: * * @code * # In the MODULE_NAME.libraries.yml file. * * marquee: * js: * assets/ckeditor5/marquee/marquee.js: { minified: true } * dependencies: * - core/ckeditor5 * - core/ckeditor5.translations * @endcode * * The translations for CKEditor 5 are located in a translations/ subdirectory, * Drupal will load the corresponding translation when necessary, located in * assets/ckeditor5/marquee/translations/* in this example. * * * @see \Drupal\ckeditor5\Attribute\CKEditor5Plugin * @see \Drupal\ckeditor5\Attribute\CKEditor5AspectsOfCKEditor5Plugin * @see \Drupal\ckeditor5\Attribute\DrupalAspectsOfCKEditor5Plugin * * @section public_api Public API * * The CKEditor 5 module provides no public API, other than: * - the attributes and interfaces mentioned above; * - to help implement CKEditor 5 plugins: * \Drupal\ckeditor5\Plugin\CKEditor5PluginConfigurableTrait and * \Drupal\ckeditor5\Plugin\CKEditor5PluginDefault; * - \Drupal\ckeditor5\Plugin\CKEditor5PluginDefinition, which is used to * interact with plugin definitions in hook_ckeditor5_plugin_info_alter(); * - to help contributed modules write tests: * \Drupal\Tests\ckeditor5\Kernel\CKEditor5ValidationTestTrait and * \Drupal\Tests\ckeditor5\Traits\CKEditor5TestTrait; * - to help contributed modules write configuration schemas for configurable * plugins, the data types in config/schema/ckeditor5.data_types.yml are * likely to be useful. They automatically get validation constraints applied; * - to help contributed modules write validation constraints for configurable * plugins, it is strongly recommended to subclass * \Drupal\Tests\ckeditor5\Kernel\ValidatorsTest. For very complex validation * constraints that need to access text editor and/or format, use * \Drupal\ckeditor5\Plugin\Validation\Constraint\TextEditorObjectDependentValidatorTrait. * * @} */ /** * @addtogroup hooks * @{ */ /** * Modify the list of available CKEditor 5 plugins. * * This hook may be used to modify plugin properties after they have been * specified by other modules. * * @param array $plugin_definitions * An array of all the existing plugin definitions, passed by reference. * * @see \Drupal\ckeditor5\Plugin\CKEditor5PluginManager */ function hook_ckeditor5_plugin_info_alter(array &$plugin_definitions): void { // Add a link decorator to the link plugin. assert($plugin_definitions['ckeditor5_link'] instanceof CKEditor5PluginDefinition); $link_plugin_definition = $plugin_definitions['ckeditor5_link']->toArray(); $link_plugin_definition['ckeditor5']['config']['link']['decorators'][] = [ 'mode' => 'manual', 'label' => t('Open in new window'), 'attributes' => [ 'target' => '_blank', ], ]; $plugin_definitions['ckeditor5_link'] = new CKEditor5PluginDefinition($link_plugin_definition); // Add a custom file type to the image upload plugin. Note that 'tiff' below // should be an IANA image media type Name, with the "image/" prefix omitted. // In other words: a subtype of type image. // @see https://www.iana.org/assignments/media-types/media-types.xhtml#image // @see https://ckeditor.com/docs/ckeditor5/latest/api/module_image_imageconfig-ImageUploadConfig.html#member-types assert($plugin_definitions['ckeditor5_imageUpload'] instanceof CKEditor5PluginDefinition); $image_upload_plugin_definition = $plugin_definitions['ckeditor5_imageUpload']->toArray(); $image_upload_plugin_definition['ckeditor5']['config']['image']['upload']['types'][] = 'tiff'; $plugin_definitions['ckeditor5_imageUpload'] = new CKEditor5PluginDefinition($image_upload_plugin_definition); } /** * @} End of "addtogroup hooks". */