Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DiffEditorComponent

Hierarchy

Index

Properties

Methods

Properties

Optional CSSStyles

CSSStyles: CssStyles

Matches the CSS style key and its available values.

Optional ariaHidden

ariaHidden: boolean

Corresponds to the aria-hidden accessibility attribute for this component

Optional ariaLabel

ariaLabel: string

Corresponds to the aria-label accessibility attribute for this component

Optional ariaRole

ariaRole: string

Corresponds to the role accessibility attribute for this component

Optional ariaSelected

ariaSelected: boolean

Corresponds to the aria-selected accessibility attribute for this component

contentLeft

contentLeft: string

The content inside the left text editor

contentRight

contentRight: string

The content inside the right text editor

Optional display

display: DisplayType

Corresponds to the display CSS property for the element

Readonly editorUriLeft

editorUriLeft: string

The left editor Uri which will be used as a reference for VSCode Language Service. Currently this is auto-generated by the framework but can be queried after view initialization is completed

Readonly editorUriRight

editorUriRight: string

The right editor Uri which will be used as a reference for VSCode Language Service. Currently this is auto-generated by the framework but can be queried after view initialization is completed

Optional enabled

enabled: boolean

Whether the component is enabled in the DOM

Optional height

height: string | number

Readonly id

id: string

isAutoResizable

isAutoResizable: boolean

Toggle for whether the editor should be automatically resized or not

languageMode

languageMode: string

The language mode for this text editor. The language mode is SQL by default.

minimumHeight

minimumHeight: number

Minimum height for editor component

Readonly onContentChanged

onContentChanged: Event<any>

An event called when the editor content is updated

Readonly onEditorCreated

onEditorCreated: Event<any>

An event called when the editor is created

Readonly onValidityChanged

onValidityChanged: Event<boolean>

Event fired to notify that the component's validity has changed

Optional position

position: PositionType

The position CSS property. Empty by default. This is particularly useful if laying out components inside a FlexContainer and the size of the component is meant to be a fixed size. In this case the position must be set to 'absolute', with the parent FlexContainer having 'relative' position. Without this the component will fail to correctly size itself

title

title: string

Title of editor

Readonly valid

valid: boolean

Whether the component is valid or not

Optional width

width: string | number

Methods

focus

  • focus(): Thenable<void>

  • Focuses the component.

    Returns Thenable<void>

updateCssStyles

  • updateCssStyles(cssStyles: CssStyles): Thenable<void>

  • Updates the specified CSS Styles and notifies the UI

    Parameters

    Returns Thenable<void>

    Thenable that completes once the update has been applied to the UI

updateProperties

  • updateProperties(properties: {}): Thenable<void>

  • Sends any updated properties of the component to the UI

    Parameters

    • properties: {}
      • [key: string]: any

    Returns Thenable<void>

    Thenable that completes once the update has been applied in the UI

updateProperty

  • updateProperty(key: string, value: any): Thenable<void>

  • Sends an updated property of the component to the UI

    Parameters

    • key: string
    • value: any

    Returns Thenable<void>

    Thenable that completes once the update has been applied in the UI

validate

  • validate(): Thenable<boolean>

  • Run the component's validations

    Returns Thenable<boolean>

Generated using TypeDoc