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

    A PreferenceContribution allows adding additional custom preferences. For this, the PreferenceContribution has to provide a valid PrefernceSchema specifying which preferences are available including their types and description.

    const MyPreferencesSchema: PreferenceSchema = {
    'scope': PreferenceScope.Folder,
    'properties': {
    'myext.decorations.enabled': {
    'type': 'boolean',
    'description': 'Show file status',
    'default': true
    },
    // [...]
    }
    }
    @injectable()
    export class MyPreferenceContribution implements PreferenceContribution{
    schema= MyPreferencesSchema;
    }

    Hierarchy (View Summary)

    Implements

    Index
    commandRegistry: CommandRegistry
    editorManager: EditorManager
    fileService: FileService
    messageService: MessageService
    preferenceService: PreferenceService
    quickInputService: QuickInputService
    quickView: QuickViewService
    toggleCommand?: Command
    walkthroughService: WalkthroughService
    widgetManager: WidgetManager
    workspaceService: WorkspaceService
    • get effectiveWidgetId(): string

      The widget ID used for shell operations — viewContainerId if set, otherwise widgetId.

      Returns string

    • get viewId(): string

      Returns string

    • get viewLabel(): string

      Returns string

    • get widget(): Promise<T>

      Returns Promise<T>

    • Whether the restored layout already shows an editor, in which case the startup editor is not applied. Like in VS Code, any widget in the main area counts, not only text editors: custom editors, webviews, notebooks, previews etc. The Welcome page itself does not count, so that it is still revealed when restored.

      Returns boolean