Interface SourceControlResourceGroup

A source control resource group is a collection of source control resource states.

interface SourceControlResourceGroup {
    contextValue?: string;
    hideWhenEmpty?: boolean;
    id: string;
    label: string;
    resourceStates: SourceControlResourceState[];
    dispose(): void;
}

Properties

contextValue? hideWhenEmpty? id label resourceStates

Methods

dispose

Properties

Optional contextValue

contextValue?: string

Context value of the resource group. This can be used to contribute resource group specific actions. For example, if a resource group is given a context value of exportable, when contributing actions to scm/resourceGroup/context using menus extension point, you can specify context value for key scmResourceGroupState in when expressions, like scmResourceGroupState == exportable.

"contributes": {
  "menus": {
    "scm/resourceGroup/context": [
      {
        "command": "extension.export",
        "when": "scmResourceGroupState == exportable"
      }
    ]
  }
}

This will show action extension.export only for resource groups with contextValue equal to exportable.

Optional hideWhenEmpty

hideWhenEmpty?: boolean

Whether this source control resource group is hidden when it contains no source control resource states.

Readonly id

id: string

The id of this source control resource group.

label

label: string

The label of this source control resource group.

resourceStates

resourceStates: SourceControlResourceState[]

This group's collection of source control resource states.

Methods

dispose

Settings

Member Visibility

Theme

On This Page

contextValuehideWhenEmptyidlabelresourceStatesdispose