Interface IContentWidget

A content widget renders inline with the text and can be easily placed 'near' an editor position.

interface IContentWidget {
    allowEditorOverflow?: boolean;
    suppressMouseDown?: boolean;
    afterRender?(position, coordinate): void;
    beforeRender?(): null | IDimension;
    getDomNode(): HTMLElement;
    getId(): string;
    getPosition(): null | IContentWidgetPosition;
}

Properties

allowEditorOverflow? suppressMouseDown?

Methods

afterRender? beforeRender? getDomNode getId getPosition

Properties

Optional allowEditorOverflow

allowEditorOverflow?: boolean

Render this content widget in a location where it could overflow the editor's view dom node.

Optional suppressMouseDown

suppressMouseDown?: boolean

Call preventDefault() on mousedown events that target the content widget.

Methods

Optional afterRender

  • afterRender(position, coordinate): void

  • Optional function that is invoked after rendering the content widget. Is being invoked with the selected position preference or null if not rendered.

    Parameters

    Returns void

Optional beforeRender

  • beforeRender(): null | IDimension

  • Optional function that is invoked before rendering the content widget. If a dimension is returned the editor will attempt to use it.

    Returns null | IDimension

getDomNode

  • getDomNode(): HTMLElement

  • Get the dom node of the content widget.

    Returns HTMLElement

getId

  • getId(): string

  • Get a unique identifier of the content widget.

    Returns string

getPosition

  • getPosition(): null | IContentWidgetPosition

  • Get the placement of the content widget. If null is returned, the content widget will be placed off screen.

    Returns null | IContentWidgetPosition

Settings

Member Visibility

Theme

On This Page

allowEditorOverflowsuppressMouseDownafterRenderbeforeRendergetDomNodegetIdgetPosition