Class GettingStartedWidget

Protected aiIsIncluded

Protected Readonly appServer

Protected applicationInfo

Protected applicationName

Protected Readonly commandRegistry

Protected Readonly compatibilityUrl

Protected Readonly documentationUrl

Protected Readonly environments

Protected Readonly extensionUrl

Protected Readonly ghProjectUrl

Protected home

Protected Readonly labelProvider

Protected Readonly pluginUrl

Protected Readonly preferenceService

Protected recentLimit

Protected recentWorkspaces

Protected Readonly theiaAIDocUrl

Protected Readonly windowService

Protected Readonly workspaceService

Protected buildPaths

• buildPaths(workspaces): string[]

• Build the list of workspace paths.

  Parameters

  • workspaces: string[]

    {string[]} the list of workspaces.

  Returns string[]

  the list of workspace paths.

Protected doCreateFile

• doCreateFile(): Promise<unknown>

• Trigger the create file command.

  Returns Promise<unknown>

Protected doCreateFileEnter

• doCreateFileEnter(e): void

• Parameters

  • e: KeyboardEvent<Element>

  Returns void

Protected doInit

• doInit(): Promise<void>

• Returns Promise<void>

Protected doOpen

• doOpen(): Promise<unknown>

• Trigger the open command.

  Returns Promise<unknown>

Protected doOpenAIChatView

• doOpenAIChatView(): Promise<unknown>

• Returns Promise<unknown>

Protected doOpenAIChatViewEnter

• doOpenAIChatViewEnter(e): void

• Parameters

  • e: KeyboardEvent<Element>

  Returns void

Protected doOpenEnter

• doOpenEnter(e): void

• Parameters

  • e: KeyboardEvent<Element>

  Returns void

Protected doOpenExternalLink

• doOpenExternalLink(url): undefined

• Open a link in an external window.

  Parameters

  • url: string

    the link.

  Returns undefined

Protected doOpenExternalLinkEnter

• doOpenExternalLinkEnter(e, url): void

• Parameters

  • e: KeyboardEvent<Element>
  • url: string

  Returns void

Protected doOpenFile

• doOpenFile(): Promise<unknown>

• Trigger the open file command.

  Returns Promise<unknown>

Protected doOpenFileEnter

• doOpenFileEnter(e): void

• Parameters

  • e: KeyboardEvent<Element>

  Returns void

Protected doOpenFolder

• doOpenFolder(): Promise<unknown>

• Trigger the open folder command.

  Returns Promise<unknown>

Protected doOpenFolderEnter

• doOpenFolderEnter(e): void

• Parameters

  • e: KeyboardEvent<Element>

  Returns void

Protected doOpenKeyboardShortcuts

• doOpenKeyboardShortcuts(): Promise<unknown>

• Trigger the open keyboard shortcuts command. Used to open the keyboard shortcuts widget.

  Returns Promise<unknown>

Protected doOpenKeyboardShortcutsEnter

• doOpenKeyboardShortcutsEnter(e): void

• Parameters

  • e: KeyboardEvent<Element>

  Returns void

Protected doOpenPreferences

• doOpenPreferences(): Promise<unknown>

• Trigger the open preferences command. Used to open the preferences widget.

  Returns Promise<unknown>

Protected doOpenPreferencesEnter

• doOpenPreferencesEnter(e): void

• Parameters

  • e: KeyboardEvent<Element>

  Returns void

Protected doOpenRecentWorkspace

• doOpenRecentWorkspace(): Promise<unknown>

• Trigger the open recent workspace command.

  Returns Promise<unknown>

Protected doOpenRecentWorkspaceEnter

• doOpenRecentWorkspaceEnter(e): void

• Parameters

  • e: KeyboardEvent<Element>

  Returns void

Protected doOpenWorkspace

• doOpenWorkspace(): Promise<unknown>

• Trigger the open workspace command.

  Returns Promise<unknown>

Protected doOpenWorkspaceEnter

• doOpenWorkspaceEnter(e): void

• Parameters

  • e: KeyboardEvent<Element>

  Returns void

Protected init

• init(): void

• Returns void

Protected isEnterKey

• isEnterKey(e): boolean

• Parameters

  • e: KeyboardEvent<Element>

  Returns boolean

Protected onActivateRequest

• onActivateRequest(msg): void

• Parameters

  • msg: Message

  Returns void

Protected open

• open(uri): void

• Open a workspace given its uri.

  Parameters

  • uri: URI

    {URI} the workspace uri.

  Returns void

Protected openEnter

• openEnter(e, uri): void

• Parameters

  • e: KeyboardEvent<Element>
  • uri: URI

  Returns void

Protected render

• render(): ReactNode

• Render the content of the widget.

  Returns ReactNode

Protected renderAIBanner

• renderAIBanner(): ReactNode

• Returns ReactNode

Protected renderHeader

• renderHeader(): ReactNode

• Render the widget header. Renders the title {applicationName} Getting Started.

  Returns ReactNode

Protected renderHelp

• renderHelp(): ReactNode

• Render the help section.

  Returns ReactNode

Protected renderPreferences

• renderPreferences(): ReactNode

• Returns ReactNode

Protected renderRecentWorkspaces

• renderRecentWorkspaces(): ReactNode

• Render the recently used workspaces section.

  Returns ReactNode

Protected renderSettings

• renderSettings(): ReactNode

• Render the settings section. Generally used to display useful links.

  Returns ReactNode

Protected renderStart

• renderStart(): ReactNode

• Render the Start section. Displays a collection of "start-to-work" related commands like open commands and some other.

  Returns ReactNode

Protected renderVersion

• renderVersion(): ReactNode

• Render the version section.

  Returns ReactNode