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

    Module @theia/preferences


    theia-ext-logo

    ECLIPSE THEIA - PREFERENCES EXTENSION


    The @theia/preferences extension implements the preferences API defined in @theia/core, including the four preference providers:

    • Default Preference, which serves as default values of preferences,
    • User Preference for the user home directory, which has precedence over the default values,
    • Workspace Preference for the workspace, which has precedence over User Preference, and
    • Folder Preference for the root folder, which has precedence over the Workspace Preference

    To set:

    • User Preferences: Create or edit a settings.json under the .theia folder located either in the user home.
    • Workspace Preference: If one folder is opened as the workspace, create or edit a settings.json under the root of the workspace. If a multi-root workspace is opened, create or edit the "settings" property in the workspace file.
    • Folder Preferences: Create or edit a settings.json under any of the root folders.

    Example of a settings.json below:

    {
    // Enable/Disable the line numbers in the monaco editor
    "editor.lineNumbers": "off",
    // Tab width in the editor
    "editor.tabSize": 4,
    "files.watcherExclude": "path/to/file"
    }

    Example of a workspace file below:

    {
    "folders": [
    {
    "path": "file:///home/username/helloworld"
    },
    {
    "path": "file:///home/username/dev/byeworld"
    }
    ],
    "settings": {
    // Enable/Disable the line numbers in the monaco editor
    "editor.lineNumbers": "off",
    // Tab width in the editor
    "editor.tabSize": 4,
    }
    }

    "Theia" is a trademark of the Eclipse Foundation https://www.eclipse.org/theia

    Theia - Preferences Extension

    Modules

    browser
    browser/folder-preference-provider
    browser/folders-preferences-provider
    browser/frontend-preference-storage
    browser/monaco-jsonc-editor
    browser/preference-bindings
    browser/preference-frontend-contribution
    browser/preference-frontend-module
    browser/preference-open-handler
    browser/preference-transaction-manager
    browser/preference-tree-model
    browser/preferences-contribution
    browser/preferences-json-schema-contribution
    browser/preferences-monaco-contribution
    browser/util/preference-layout
    browser/util/preference-scope-command-manager
    browser/util/preference-tree-generator
    browser/util/preference-tree-label-provider
    browser/util/preference-types
    browser/views/components/preference-array-input
    browser/views/components/preference-boolean-input
    browser/views/components/preference-file-input
    browser/views/components/preference-json-input
    browser/views/components/preference-markdown-renderer
    browser/views/components/preference-node-renderer
    browser/views/components/preference-node-renderer-creator
    browser/views/components/preference-null-input
    browser/views/components/preference-number-input
    browser/views/components/preference-select-input
    browser/views/components/preference-string-input
    browser/views/preference-editor-widget
    browser/views/preference-scope-tabbar-widget
    browser/views/preference-searchbar-widget
    browser/views/preference-tree-widget
    browser/views/preference-widget
    browser/views/preference-widget-bindings
    browser/workspace-file-preference-provider
    browser/workspace-preference-provider
    common/abstract-resource-preference-provider
    common/cli-preferences
    common/jsonc-editor
    common/section-preference-provider
    common/user-configs-preference-provider
    common/user-preference-provider
    node/backend-preference-storage
    node/preference-backend-module
    node/preference-bindings
    node/preference-cli-contribution