Interface TextReplacementContribution

Enables adopters to override text in the application. All TextReplacementContributions need to be bound in the frontendPreload scope of the package.json.

Example: Create a text replacement contribution

         import { TextReplacementContribution } from '@theia/core/lib/browser/preload/text-replacement-contribution';
export class TextSampleReplacementContribution implements TextReplacementContribution {
getReplacement(locale: string): Record<string, string> {
switch (locale) {
case 'en': {
return {
'About': 'About Theia',
};
}
case 'de': {
return {
'About': 'Über Theia',
};
}
}
return {};
}
}
interface TextReplacementContribution {
    getReplacement(locale): Record<string, string>;
}

Methods

  • This method returns a map of default values and their replacement values for the specified locale. Do not use the keys of the nls.localization call, but the English default values.

    Parameters

    • locale: string

      The locale for which the replacement should be returned.

    Returns Record<string, string>

    A map of default values and their replacement values.