Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GettingStartedWidget

Default implementation of the GettingStartedWidget. The widget is displayed when there are currently no workspaces present. Some of the features displayed include:

  • open commands.
  • recently used workspaces.
  • settings commands.
  • help commands.
  • helpful links.

Hierarchy

  • ReactWidget
    • GettingStartedWidget

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • Optional options: IOptions

    Returns GettingStartedWidget

Properties

Protected Readonly appServer

appServer: ApplicationServer

Protected applicationInfo

applicationInfo: undefined | ApplicationInfo

The ApplicationInfo for the application if available. Used in order to obtain the version number of the application.

Protected applicationName

applicationName: string = ...

The application name which is used for display purposes.

Protected Readonly commandRegistry

commandRegistry: CommandRegistry

Protected Readonly documentationUrl

documentationUrl: "https://www.theia-ide.org/docs/" = 'https://www.theia-ide.org/docs/'

Collection of useful links to display for end users.

Protected Readonly environments

environments: EnvVariablesServer

Protected Readonly extensionUrl

extensionUrl: "https://www.theia-ide.org/docs/authoring_extensions" = 'https://www.theia-ide.org/docs/authoring_extensions'

Protected home

home: undefined | string

Protected Readonly labelProvider

labelProvider: LabelProvider

Readonly onDidChangeVisibility

onDidChangeVisibility: Event<boolean>

Protected Readonly onDidChangeVisibilityEmitter

onDidChangeVisibilityEmitter: Emitter<boolean>

Readonly onDidDispose

onDidDispose: Event<void>

Protected Readonly onDidDisposeEmitter

onDidDisposeEmitter: Emitter<void>

Protected Readonly onRender

onRender: DisposableCollection

Readonly onScrollUp

onScrollUp: Event<void>

Protected Readonly onScrollUpEmitter

onScrollUpEmitter: Emitter<void>

Readonly onScrollYReachEnd

onScrollYReachEnd: Event<void>

Protected Readonly onScrollYReachEndEmitter

onScrollYReachEndEmitter: Emitter<void>

Protected Readonly pluginUrl

pluginUrl: "https://www.theia-ide.org/docs/authoring_plugins" = 'https://www.theia-ide.org/docs/authoring_plugins'

Protected recentLimit

recentLimit: number = 5

The recently used workspaces limit. Used in order to limit the number of recently used workspaces to display.

Protected recentWorkspaces

recentWorkspaces: string[] = []

The list of recently used workspaces.

Protected Optional scrollBar

scrollBar: PerfectScrollbar

Protected Optional scrollOptions

scrollOptions: Options

Protected Readonly toDispose

toDispose: DisposableCollection

Protected Readonly toDisposeOnDetach

toDisposeOnDetach: DisposableCollection

Protected Readonly windowService

windowService: WindowService

Protected Readonly workspaceService

workspaceService: WorkspaceService

Static Readonly ID

ID: "getting.started.widget" = 'getting.started.widget'

The widget id.

Static Readonly LABEL

LABEL: string = ...

The widget label which is used for display purposes.

Methods

Protected addClipboardListener

  • addClipboardListener<K>(element: HTMLElement, type: K, listener: EventListenerOrEventListenerObject<K>): void

  • Type parameters

    • K: "copy" | "cut" | "paste"

    Parameters

    • element: HTMLElement
    • type: K
    • listener: EventListenerOrEventListenerObject<K>

    Returns void

Protected addEventListener

  • addEventListener<K>(element: HTMLElement, type: K, listener: EventListenerOrEventListenerObject<K>, useCapture?: boolean): void

  • Type parameters

    • K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"

    Parameters

    • element: HTMLElement
    • type: K
    • listener: EventListenerOrEventListenerObject<K>
    • Optional useCapture: boolean

    Returns void

Protected addKeyListener

  • addKeyListener<K>(element: HTMLElement, keysOrKeyCodes: Predicate | Key | KeyCode | (Key | KeyCode)[], action: (event: KeyboardEvent) => boolean | void | Object, ...additionalEventTypes: K[]): void

  • Type parameters

    • K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"

    Parameters

    • element: HTMLElement
    • keysOrKeyCodes: Predicate | Key | KeyCode | (Key | KeyCode)[]
    • action: (event: KeyboardEvent) => boolean | void | Object
        • (event: KeyboardEvent): boolean | void | Object

        • Parameters

          • event: KeyboardEvent

          Returns boolean | void | Object

    • Rest ...additionalEventTypes: K[]

    Returns void

Protected addUpdateListener

  • addUpdateListener<K>(element: HTMLElement, type: K, useCapture?: boolean): void

  • Type parameters

    • K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"

    Parameters

    • element: HTMLElement
    • type: K
    • Optional useCapture: boolean

    Returns void

Protected buildPaths

  • buildPaths(workspaces: string[]): string[]

clearFlag

  • clearFlag(flag: Flag): void

  • Parameters

    • flag: Flag

    Returns void

Protected disableScrollBarFocus

  • disableScrollBarFocus(scrollContainer: HTMLElement): void

  • Parameters

    • scrollContainer: HTMLElement

    Returns void

dispose

  • dispose(): void

  • Returns void

Protected doOpen

  • doOpen(): Promise<unknown>

Protected doOpenEnter

  • doOpenEnter(e: KeyboardEvent<Element>): void

Protected doOpenExternalLink

  • doOpenExternalLink(url: string): undefined

Protected doOpenExternalLinkEnter

  • doOpenExternalLinkEnter(e: KeyboardEvent<Element>, url: string): void

Protected doOpenFile

  • doOpenFile(): Promise<unknown>

Protected doOpenFileEnter

  • doOpenFileEnter(e: KeyboardEvent<Element>): void

Protected doOpenFolder

  • doOpenFolder(): Promise<unknown>

Protected doOpenFolderEnter

  • doOpenFolderEnter(e: KeyboardEvent<Element>): void

Protected doOpenKeyboardShortcuts

  • doOpenKeyboardShortcuts(): Promise<unknown>

Protected doOpenKeyboardShortcutsEnter

  • doOpenKeyboardShortcutsEnter(e: KeyboardEvent<Element>): void

Protected doOpenPreferences

  • doOpenPreferences(): Promise<unknown>

Protected doOpenPreferencesEnter

  • doOpenPreferencesEnter(e: KeyboardEvent<Element>): void

Protected doOpenRecentWorkspace

  • doOpenRecentWorkspace(): Promise<unknown>

Protected doOpenRecentWorkspaceEnter

  • doOpenRecentWorkspaceEnter(e: KeyboardEvent<Element>): void

Protected doOpenWorkspace

  • doOpenWorkspace(): Promise<unknown>

Protected doOpenWorkspaceEnter

  • doOpenWorkspaceEnter(e: KeyboardEvent<Element>): void

Protected getScrollContainer

  • getScrollContainer(): MaybePromise<HTMLElement>

  • Returns MaybePromise<HTMLElement>

Protected init

  • init(): Promise<void>

Protected isEnterKey

  • isEnterKey(e: KeyboardEvent<Element>): boolean

Protected onAfterAttach

  • onAfterAttach(msg: Message): void

  • Parameters

    • msg: Message

    Returns void

Protected onAfterDetach

  • onAfterDetach(msg: Message): void

  • Parameters

    • msg: Message

    Returns void

Protected onBeforeAttach

  • onBeforeAttach(msg: Message): void

  • Parameters

    • msg: Message

    Returns void

Protected onBeforeDetach

  • onBeforeDetach(msg: Message): void

  • Parameters

    • msg: Message

    Returns void

Protected onCloseRequest

  • onCloseRequest(msg: Message): void

  • Parameters

    • msg: Message

    Returns void

Protected onUpdateRequest

  • onUpdateRequest(msg: Message): void

  • Parameters

    • msg: Message

    Returns void

Protected open

  • open(uri: default): void

Protected openEnter

  • openEnter(e: KeyboardEvent<Element>, uri: default): void

Protected render

  • render(): ReactNode

Protected renderHeader

  • renderHeader(): ReactNode

Protected renderHelp

  • renderHelp(): ReactNode

Protected renderOpen

  • renderOpen(): ReactNode

Protected renderRecentWorkspaces

  • renderRecentWorkspaces(): ReactNode

Protected renderSettings

  • renderSettings(): ReactNode

Protected renderVersion

  • renderVersion(): ReactNode

setFlag

  • setFlag(flag: Flag): void

  • Parameters

    • flag: Flag

    Returns void