Theia API Documentation v1.66.0
    Preparing search index...

    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;
    }
    Index

    Properties

    contextValue? hideWhenEmpty? id label resourceStates

    Methods

    dispose

    Properties

    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.

    hideWhenEmpty?: boolean

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

    id: string

    The id of this source control resource group.

    label: string

    The label of this source control resource group.

    resourceStates: SourceControlResourceState[]

    This group's collection of source control resource states.

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods