WatchdogItemConfiguration (watchdog)
@ckeditor/ckeditor5-watchdog/src/contextwatchdog
The watchdog item configuration interface.
Filtering
Properties
-
config : EditorConfig
module:watchdog/contextwatchdog~WatchdogItemConfiguration#config
An editor configuration.
-
creator : EditorCreatorFunction<Editor>
module:watchdog/contextwatchdog~WatchdogItemConfiguration#creator
A function that initializes the item (the editor). The function takes editor initialization arguments and should return a promise. For example:
( el, config ) => ClassicEditor.create( el, config )
. -
destructor : ( Editor ) => Promise<unknown> | undefined
module:watchdog/contextwatchdog~WatchdogItemConfiguration#destructor
A function that destroys the item instance (the editor). The function takes an item and should return a promise. For example:
editor => editor.destroy()
-
id : string
module:watchdog/contextwatchdog~WatchdogItemConfiguration#id
id A unique item identificator.
-
sourceElementOrData : string | HTMLElement
module:watchdog/contextwatchdog~WatchdogItemConfiguration#sourceElementOrData
The source element or data that will be passed as the first argument to the
Editor.create()
method. -
type : 'editor'
module:watchdog/contextwatchdog~WatchdogItemConfiguration#type
The type of the item to create. At the moment, only
'editor'
is supported.
Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.