interface CKEditorPluginButtonsInterface in Drupal 8

Same name and namespace in other branches

9 core/modules/ckeditor/src/CKEditorPluginButtonsInterface.php \Drupal\ckeditor\CKEditorPluginButtonsInterface

Defines an interface for CKEditor plugins with buttons.

This allows a CKEditor plugin to define which buttons it provides, so that users can configure a CKEditor toolbar instance via the toolbar builder UI. If at least one button that this plugin provides is added to the toolbar via the toolbar builder UI, then this plugin will be enabled automatically.

If a CKEditor plugin implements this interface, it can still also implement CKEditorPluginContextualInterface if it wants a button to conditionally be added as well. The downside of conditionally adding buttons is that the user cannot see these buttons in the toolbar builder UI.

Hierarchy

interface \Drupal\Component\Plugin\PluginInspectionInterface
- interface \Drupal\ckeditor\CKEditorPluginInterface
  - interface \Drupal\ckeditor\CKEditorPluginButtonsInterface

Expanded class hierarchy of CKEditorPluginButtonsInterface

All classes that implement CKEditorPluginButtonsInterface

File

core/modules/ckeditor/src/CKEditorPluginButtonsInterface.php, line 27

Namespace

Drupal\ckeditor

View source

interface CKEditorPluginButtonsInterface extends CKEditorPluginInterface {

  /**
   * Returns the buttons that this plugin provides, along with metadata.
   *
   * The metadata is used by the CKEditor module to generate a visual CKEditor
   * toolbar builder UI.
   *
   * @return array
   *   An array of buttons that are provided by this plugin. This will
   *   only be used in the administrative section for assembling the toolbar.
   *   Each button should be keyed by its CKEditor button name (you can look up
   *   the button name up in the plugin.js file), and should contain an array of
   *   button properties, including:
   *   - label: A human-readable, translated button name.
   *   - image: An image for the button to be used in the toolbar.
   *   - image_rtl: If the image needs to have a right-to-left version, specify
   *     an alternative file that will be used in RTL editors.
   *   - image_alternative: If this button does not render as an image, specify
   *     an HTML string representing the contents of this button.
   *   - image_alternative_rtl: Similar to image_alternative, but a
   *     right-to-left version.
   *   - attributes: An array of HTML attributes which should be added to this
   *     button when rendering the button in the administrative section for
   *     assembling the toolbar.
   *   - multiple: Boolean value indicating if this button may be added multiple
   *     times to the toolbar. This typically is only applicable for dividers
   *     and group indicators.
   */
  public function getButtons();

}

Members

Name	Modifiers	Type	Description	Overrides
CKEditorPluginButtonsInterface::getButtons	public	function	Returns the buttons that this plugin provides, along with metadata.	9
CKEditorPluginInterface::getConfig	public	function	Returns the additions to CKEDITOR.config for a specific CKEditor instance.	9
CKEditorPluginInterface::getDependencies	public	function	Returns a list of plugins this plugin requires.	4
CKEditorPluginInterface::getFile	public	function	Returns the Drupal root-relative file path to the plugin JavaScript file.	9
CKEditorPluginInterface::getLibraries	public	function	Returns a list of libraries this plugin requires.	4
CKEditorPluginInterface::isInternal	public	function	Indicates if this plugin is part of the optimized CKEditor build.	4
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2

You are here

interface CKEditorPluginButtonsInterface in Drupal 8

Hierarchy

See also

File

Namespace

Members

API Navigation