SCION Workbench Client - v1.0.0-beta.35
    Preparing search index...

    Type Alias WorkbenchTextProviderFn

    WorkbenchTextProviderFn: (
        key: string,
        params: { [name: string]: string },
    ) => Observable<string | undefined> | string | undefined

    Signature of a function to provide texts to the SCION Workbench and micro apps.

    Texts starting with the percent symbol (%) are passed to the text provider for translation, with the percent symbol omitted.

    A text provider can be registered via WorkbenchClient.registerTextProvider in the Activator.

    Type Declaration

      • (
            key: string,
            params: { [name: string]: string },
        ): Observable<string | undefined> | string | undefined
      • Parameters

        • key: string

          Translation key of the text.

        • params: { [name: string]: string }

          Parameters used for text interpolation.

        Returns Observable<string | undefined> | string | undefined

        Text associated with the key, or undefined if not found. Localized applications should return an Observable with the text in the current language, and emit the translated text each time when the language changes.