Sign up (with export icon)

ContextWatchdogItemConfiguration

Api-interface iconinterface

The watchdog item configuration interface.

Properties

  • Chevron-right icon

    An editor configuration.

  • A function that initializes the item (the editor). The function takes the editor configuration and should return a promise. For example: config => ClassicEditor.create( config ).

  • Chevron-right icon

    destructor?: ( editor: Editor ) => Promise<unknown>

    A function that destroys the item instance (the editor). The function takes an item and should return a promise. For example: editor => editor.destroy()

  • Chevron-right icon

    id: string

    id A unique item identificator.

  • Chevron-right icon

    sourceElementOrData?: string | HTMLElement
    deprecated

    The source element or data that will be passed as the first argument to the Editor.create() method.

    When not provided, the watchdog will use config-based creator mode, passing only the config to the editor creator.

  • Chevron-right icon

    type: 'editor'

    The type of the item to create. At the moment, only 'editor' is supported.