spectacular-dashboard / DashboardViewProvider / DashboardViewProvider

Class: DashboardViewProvider

DashboardViewProvider.DashboardViewProvider

Implements

• WebviewViewProvider

Table of contents

Constructors

• constructor

Properties

• _extensionUri
• _fileWatcher
• _rootPath
• _view
• viewType

Methods

• _getHtmlForWebview
• _getThemeKind
• _handleGetFileTree
• _handleMessage
• _handleReadFile
• _handleSelectDirectory
• _postMessage
• _sendConfig
• _startWatching
• _stopWatching
• resolveWebviewView

Constructors

constructor

• new DashboardViewProvider(_extensionUri): DashboardViewProvider

Parameters

Name	Type
_extensionUri	Uri

Returns

DashboardViewProvider

Defined in

src/DashboardViewProvider.ts:11

Properties

_extensionUri

• Private Readonly _extensionUri: Uri

Defined in

src/DashboardViewProvider.ts:11

---

_fileWatcher

• Private _fileWatcher: undefined | FileSystemWatcher

Defined in

src/DashboardViewProvider.ts:9

---

_rootPath

• Private _rootPath: undefined | string

Defined in

src/DashboardViewProvider.ts:8

---

_view

• Private Optional _view: WebviewView

Defined in

src/DashboardViewProvider.ts:7

---

viewType

▪ Static Readonly viewType: "spectacular.dashboardView"

Defined in

src/DashboardViewProvider.ts:5

Methods

_getHtmlForWebview

▸ _getHtmlForWebview(webview): string

Parameters

Name	Type
webview	Webview

Returns

string

Defined in

src/DashboardViewProvider.ts:220

---

_getThemeKind

▸ _getThemeKind(theme): "dark" | "light"

Parameters

Name	Type
theme	ColorTheme

Returns

"dark" | "light"

Defined in

src/DashboardViewProvider.ts:209

---

_handleGetFileTree

▸ _handleGetFileTree(rootPath): Promise<void>

Parameters

Name	Type
rootPath	string

Returns

Promise<void>

Defined in

src/DashboardViewProvider.ts:105

---

_handleMessage

▸ _handleMessage(message): Promise<void>

Parameters

Name	Type
message	Object
message.command	string

Returns

Promise<void>

Defined in

src/DashboardViewProvider.ts:55

---

_handleReadFile

▸ _handleReadFile(filePath): Promise<void>

Parameters

Name	Type
filePath	string

Returns

Promise<void>

Defined in

src/DashboardViewProvider.ts:117

---

_handleSelectDirectory

▸ _handleSelectDirectory(): Promise<void>

Returns

Promise<void>

Defined in

src/DashboardViewProvider.ts:132

---

_postMessage

▸ _postMessage(message): void

Parameters

Name	Type
message	Object
message.data?	unknown
message.type	string

Returns

void

Defined in

src/DashboardViewProvider.ts:216

---

_sendConfig

▸ _sendConfig(): void

Returns

void

Defined in

src/DashboardViewProvider.ts:194

---

_startWatching

▸ _startWatching(rootPath): void

Parameters

Name	Type
rootPath	string

Returns

void

Defined in

src/DashboardViewProvider.ts:151

---

_stopWatching

▸ _stopWatching(): void

Returns

void

Defined in

src/DashboardViewProvider.ts:186

---

resolveWebviewView

▸ resolveWebviewView(webviewView, _context, _token): void

Parameters

Name	Type
webviewView	WebviewView
_context	WebviewViewResolveContext<unknown>
_token	CancellationToken

Returns

void

Implementation of

vscode.WebviewViewProvider.resolveWebviewView

Defined in

src/DashboardViewProvider.ts:16