Class CustomPlugin

java.lang.Object
com.wontlost.ckeditor.CustomPlugin
public class CustomPlugin extends Object
Custom plugin definition. Supports third-party or user-defined CKEditor plugins.

Usage example:

// Define custom plugin
CustomPlugin myPlugin = CustomPlugin.builder("MyCustomPlugin")
    .withToolbarItems("myButton")
    .withImportPath("my-ckeditor-plugin")
    .build();

// Use custom plugin
VaadinCKEditor.create()
    .withPreset(CKEditorPreset.STANDARD)
    .addCustomPlugin(myPlugin)
    .build();

Custom plugins must meet CKEditor 5 plugin requirements:

  • Must be a class extending Plugin
  • Must be provided via npm package or local module
  • Export name must match jsName

  • Method Details

    • getJsName

      public String getJsName()
      Get JavaScript plugin name

    • getImportPath

      public String getImportPath()
      Get import path. If null, import from ckeditor5 main package.

    • getToolbarItems

      public Set<String> getToolbarItems()
      Get toolbar items provided by this plugin

    • getDependencies

      public Set<String> getDependencies()
      Get dependency plugin names

    • isPremium

      public boolean isPremium()
      Check if premium feature (import from ckeditor5-premium-features)

    • builder

      public static CustomPlugin.Builder builder(String jsName)
      Create builder

    • of

      public static CustomPlugin of(String jsName, String importPath)
      Quick create custom plugin with import path

    • fromCKEditor5

      public static CustomPlugin fromCKEditor5(String jsName)
      Quick create plugin from ckeditor5 main package

    • fromPremium

      public static CustomPlugin fromPremium(String jsName)
      Quick create plugin from ckeditor5-premium-features

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object