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

    Interface FrontendApplicationPreferenceConfig

    Specialized FrontendApplicationConfig to configure default preference values for the PreferenceSchemaProvider.

    interface FrontendApplicationPreferenceConfig {
        applicationName: string;
        defaultIconTheme: string;
        defaultLocale: string;
        defaultTheme: DefaultTheme;
        electron: Partial;
        preferences: { [preferenceName: string]: any };
        reloadOnReconnect: boolean;
        validatePreferencesSchema: boolean;
        readonly [key: string]: any;
    }

    Hierarchy

    • FrontendApplicationConfig
      • FrontendApplicationPreferenceConfig

    Indexable

    • readonly [key: string]: any
    Index

    Properties

    applicationName defaultIconTheme defaultLocale defaultTheme electron preferences reloadOnReconnect validatePreferencesSchema

    Properties

    applicationName: string

    The name of the application.

    Defaults to Eclipse Theia.

    defaultIconTheme: string

    The default icon theme for the application.

    Defaults to none.

    defaultLocale: string

    The default locale for the application.

    Defaults to "".

    defaultTheme: DefaultTheme

    The default theme for the application.

    Defaults to dark if the OS's theme is dark. Otherwise light.

    electron: Partial

    Electron specific configuration.

    Defaults to ElectronFrontendApplicationConfig.DEFAULT.

    preferences: { [preferenceName: string]: any }

    Type Declaration

    • [preferenceName: string]: any

      eslint-disable-next-line @typescript-eslint/no-explicit-any

    reloadOnReconnect: boolean

    When 'true', the window will reload in case the front end reconnects to a back-end, but the back end does not have a connection context for this front end anymore.

    validatePreferencesSchema: boolean

    When true, the application will validate the JSON schema of the preferences on start and log warnings to the console if the schema is not valid.

    Defaults to true.

    Settings

    Member Visibility

    On This Page

    Properties