Options
All
  • Public
  • Public/Protected
  • All
Menu

Provides a vscode.TreeItem with some customization to fit the needs of the HN Tree View.

Hierarchy

  • TreeItem
    • Story

Index

Constructors

constructor

  • new Story(label: string, collapsibleState: TreeItemCollapsibleState, cValue: string, url?: vscode.Uri, command?: vscode.Command): Story
  • Parameters

    • label: string

      Title of the Story displayed

    • collapsibleState: TreeItemCollapsibleState

      Can this element be expanded (Collapsed) or not (None)?

    • cValue: string

      Context value (top, show, ask, new) of Story

    • Optional url: vscode.Uri

      URL of Story Item

    • Optional command: vscode.Command

      Command to execute when Story Item is clicked on

    Returns Story

Properties

cValue

cValue: string

Context value (top, show, ask, new) of Story

collapsibleState

collapsibleState: TreeItemCollapsibleState

Can this element be expanded (Collapsed) or not (None)?

Optional command

command: vscode.Command

Command to execute when Story Item is clicked on

contextValue

contextValue: string = this.cValue

Optional iconPath

iconPath: string | Uri | object | ThemeIcon

The icon path or ThemeIcon for the tree item. When falsy, Folder Theme Icon is assigned, if item is collapsible otherwise File Theme Icon. When a ThemeIcon is specified, icon is derived from the current file icon theme for the specified theme icon using resourceUri (if provided).

Optional id

id: undefined | string

Optional id for the tree item that has to be unique across tree. The id is used to preserve the selection and expansion state of the tree item.

If not provided, an id is generated using the tree item's label. Note that when labels change, ids will change and that selection and expansion state cannot be kept stable anymore.

label

label: string

Title of the Story displayed

Optional resourceUri

resourceUri: Uri

The uri of the resource representing this item.

Will be used to derive the label, when it is not provided. Will be used to derive the icon from current icon theme, when iconPath has ThemeIcon value.

Optional tooltip

tooltip: string | undefined

The tooltip text when you hover over this item.

Private Optional url

url: vscode.Uri

URL of Story Item

Accessors

description

description: