Interface SourceControlInputBox

Represents the input box in the Source Control viewlet.

interface SourceControlInputBox {
    enabled: boolean;
    placeholder: string;
    value: string;
    visible: boolean;
    validateInput?(value, cursorPosition): ProviderResult<undefined | null | SourceControlInputBoxValidation>;
}

Index

Properties

enabled placeholder value visible

Methods

Properties

enabled

enabled: boolean

Controls whether the input box is enabled (default is true).

placeholder

placeholder: string

A string to show as place holder in the input box to guide the user.

value

value: string

Setter and getter for the contents of the input box.

visible

visible: boolean

Controls whether the input box is visible (default is true).

Methods

`Optional` validateInput

validateInput(value, cursorPosition): ProviderResult<undefined | null | SourceControlInputBoxValidation>
A validation function for the input box. It's possible to change the validation provider simply by setting this property to a different function.
Parameters
- value: string
- cursorPosition: number
Returns ProviderResult<undefined | null | SourceControlInputBoxValidation>
- Defined in packages/plugin/src/theia.proposed.scmValidation.d.ts:68