Function createDecoratorHook

  • createDecoratorHook<O>(methodParentCmp, methodName, callback, listenerCmp, options?): void

  • A utility function to transform methods of observable CKEditor components into events to listen to. This way, we can hook into function calls in other plugins. This is done by using CKEditor's decorate API.

    Type Parameters

    • O extends Observable

    Parameters

    • methodParentCmp: O

      the component, holding the method to be transformed

    • methodName: keyof O & string

      the name of the method that should be transformed

    • callback: (() => void)

      a callback to be executed when the event is fired

        • (): void

        • Returns void

    • listenerCmp: Emitter

      the class that should listen to the event (probably "this")

    • Optional options: {
          priority?: PriorityString;
      }

      (optional) options object for listener priority

      • Optional priority?: PriorityString

    Returns void

Settings

Member Visibility

Theme