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: ContentWidgetPositionPreference,
        coordinate: IContentWidgetRenderedCoordinate,
    ): void;
    beforeRender?(): IDimension;
    getDomNode(): HTMLElement;
    getId(): string;
    getPosition(): IContentWidgetPosition;
}

Index

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: ContentWidgetPositionPreference,
coordinate: IContentWidgetRenderedCoordinate,
): 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
- position: ContentWidgetPositionPreference
- coordinate: IContentWidgetRenderedCoordinate
Returns void
- Defined in src/components/monaco/bin/monaco.d.ts:5617

`Optional`beforeRender

beforeRender?(): IDimension
Optional function that is invoked before rendering the content widget. If a dimension is returned the editor will attempt to use it.

Returns IDimension
- Defined in src/components/monaco/bin/monaco.d.ts:5611

getDomNode

getDomNode(): HTMLElement
Get the dom node of the content widget.

Returns HTMLElement
- Defined in src/components/monaco/bin/monaco.d.ts:5600

getId

getId(): string
Get a unique identifier of the content widget.

Returns string
- Defined in src/components/monaco/bin/monaco.d.ts:5596

getPosition

getPosition(): IContentWidgetPosition
Get the placement of the content widget. If null is returned, the content widget will be placed off screen.

Returns IContentWidgetPosition
- Defined in src/components/monaco/bin/monaco.d.ts:5605