All files / src EC3Widget.ts

90% Statements 9/10
75% Branches 3/4
75% Functions 3/4
90% Lines 9/10

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47          4x                         4x 4x             2x 2x 2x                   720x       718x 718x      
/*---------------------------------------------------------------------------------------------
 * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
import type { Localization, TranslationOptions } from "@itwin/core-common";
import { IModelApp } from "@itwin/core-frontend";
 
export interface EC3WidgetConfig {
  // Provide custom localized strings to override default localized strings. Corresponding keys can be found in EC3Widget.json
  localizationOverrides?: Map<string, string>;
  localization?: Localization;
}
 
/**
 * Entry point for static initialization required by various
 * components used in the package.
 * @public
 */
export class EC3Widget {
  private static _defaultNs = "EC3Widget";
  public static localization: Localization;
  private static localizationOverrides?: Map<string, string>;
 
  /** Used to initialize the EC3Widget */
  public static async initialize(config?: EC3WidgetConfig): Promise<void> {
    // register namespace containing localized strings for this package
    EC3Widget.localization = config?.localization ?? IModelApp.localization;
    EC3Widget.localizationOverrides = config?.localizationOverrides;
    await EC3Widget.localization.registerNamespace(EC3Widget.localizationNamespace);
  }
 
  /** Unregisters internationalization service namespace and UiItemManager  */
  public static terminate() {
    IModelApp.localization.unregisterNamespace(EC3Widget.localizationNamespace);
  }
 
  /** The internationalization service namespace. */
  public static get localizationNamespace(): string {
    return EC3Widget._defaultNs;
  }
 
  public static translate(key: string, options?: TranslationOptions): string {
    const stringKey = `${this.localizationNamespace}.${key}`;
    return this.localizationOverrides?.get(key) ?? EC3Widget.localization.getLocalizedString(stringKey, { ...options, ns: EC3Widget._defaultNs });
  }
}