External module "html"

Index

Interfaces

Type aliases

Functions

Type aliases

GetFooterFunction

GetFooterFunction: function

Function to generate (additional) footer content.

returns: The generated HTML code.

Type declaration

- (): string
- Returns string

GetHeaderButtonsFunction

GetHeaderButtonsFunction: function

Function to generate header buttons.

returns: The generated HTML code.

Type declaration

- (): string
- Returns string

GetResourceUriFunction

GetResourceUriFunction: function

The function that returns the URI of a resource.

param: The path inside the resource directory.
returns: The URI.

Type declaration

- (path: string): vscode.Uri
- Parameters
  - path: string
  Returns vscode.Uri

Functions

generateFooter

generateFooter(opts: GenerateFooterOptions): string

- Defined in html.ts:138
Generates the common content for footer.

Parameters
- opts: GenerateFooterOptions
  
  Options.
Returns string

The generated HTML code.

generateHeader

generateHeader(opts: GenerateHeaderOptions): string

- Defined in html.ts:172
Generates the common content for 'head' tag.

Parameters
- opts: GenerateHeaderOptions
  
  Options.
Returns string

The generated HTML code.

generateHtmlDocument

generateHtmlDocument(opts: GenerateHtmlDocumentOptions): string

- Defined in html.ts:243
Generates a full HTML document.

Parameters
- opts: GenerateHtmlDocumentOptions
  
  Options.
Returns string

The generated HTML code.

generateNavBarHeader

generateNavBarHeader(opts: GenerateNavBarHeaderOptions): string

- Defined in html.ts:270
Generates the common HTML for a header navbar.

Parameters
- opts: GenerateNavBarHeaderOptions
  
  Options.
Returns string

The generated HTML code.

getCustomCSSUri

getCustomCSSUri(): Uri

- Defined in html.ts:123
Returns the (possible) URI of the 'custom.css' file for the views.

Returns Uri

The URI of (a) 'custom.css' file.

Generated using TypeDoc