Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GenericContentEditFeature<TEvent>

Generic ContentEditFeature interface

Type parameters

Hierarchy

Index

Properties

Properties

Optional allowFunctionKeys

allowFunctionKeys: boolean

Whether function keys (Ctrl/Meta or Alt) is allowed for this edit feature, default value is false. When set to false, this edit feature won't be triggered if user has pressed Ctrl/Meta/Alt key

handleEvent

handleEvent: (event: TEvent, editor: IEditor) => any

Type declaration

    • (event: TEvent, editor: IEditor): any

    • Handle this event

      Parameters

      • event: TEvent

        The event to handle

      • editor: IEditor

        The editor object

      Returns any

keys

keys: number[]

Keys of this edit feature to handle

shouldHandleEvent

shouldHandleEvent: (event: TEvent, editor: IEditor, ctrlOrMeta: boolean) => any

Type declaration

    • (event: TEvent, editor: IEditor, ctrlOrMeta: boolean): any

    • Check if the event should be handled by this edit feature

      Parameters

      • event: TEvent

        The plugin event to check

      • editor: IEditor

        The editor object

      • ctrlOrMeta: boolean

        If Ctrl key (for Windows) or Meta key (for Mac) is pressed

      Returns any

Generated using TypeDoc