yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

rename Translation types to set

Browse Source
This commit is contained in:
Niels Lyngsø
2023-08-02 12:28:04 +02:00
parent a6065e8ed1
commit 4e4ab39465
4 changed files with 38 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/Umbraco.Web.UI.Client/src/libs/localization-api/index.ts
View File

@@ -1,3 +1,3 @@
export * from './registry/translation.registry.js';
export * from './localize.controller.js';
export { registerTranslation, type DefaultTranslation, type Translation } from './manager.js';
export { registerTranslation } from './manager.js';

46
src/Umbraco.Web.UI.Client/src/libs/localization-api/localize.controller.ts
View File

@@ -12,17 +12,18 @@ The above copyright notice and this permission notice shall be included in all c
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
import {
DefaultTranslation,
DefaultTranslationSet,
FunctionParams,
Translation,
TranslationSet,
connectedElements,
documentDirection,
documentLanguage,
fallback,
translations,
} from './manager.js';
import { UmbController, UmbControllerHostElement } from '@umbraco-cms/backoffice/controller-api';
import { UmbController, UmbControllerHost } from '@umbraco-cms/backoffice/controller-api';
const LocalizeControllerAlias = Symbol();
/**
* The UmbLocalizeController enables localization for your element.
*
@@ -41,31 +42,36 @@ import { UmbController, UmbControllerHostElement } from '@umbraco-cms/backoffice
* }
* ```
*/
export class UmbLocalizeController<UserTranslation extends Translation = DefaultTranslation> implements UmbController {
host;
controllerAlias = 'localize';
export class UmbLocalizeController<TranslationType extends TranslationSet = DefaultTranslationSet>
implements UmbController
{
#host;
#hostEl;
controllerAlias = LocalizeControllerAlias;
constructor(host: UmbControllerHostElement) {
this.host = host;
this.host.addController(this);
constructor(host: UmbControllerHost) {
this.#host = host;
this.#hostEl = host.getHostElement() as HTMLElement;
this.#host.addController(this);
}
hostConnected(): void {
if (connectedElements.has(this.host)) {
if (connectedElements.has(this.#hostEl)) {
return;
}
connectedElements.add(this.host);
connectedElements.add(this.#hostEl);
}
hostDisconnected(): void {
connectedElements.delete(this.host);
connectedElements.delete(this.#hostEl);
}
destroy(): void {
// We do not need to call delete here, as hostDisconnected is called when controller is removed.
//connectedElements.delete(this.host);
this.host.removeController(this);
this.#host.removeController(this);
this.#hostEl = undefined as any;
}
/**
@@ -73,7 +79,7 @@ export class UmbLocalizeController<UserTranslation extends Translation = Default
* lowercase.
*/
dir() {
return `${this.host.dir || documentDirection}`.toLowerCase();
return `${this.#hostEl.dir || documentDirection}`.toLowerCase();
}
/**
@@ -81,21 +87,21 @@ export class UmbLocalizeController<UserTranslation extends Translation = Default
* lowercase.
*/
lang() {
return `${this.host.lang || documentLanguage}`.toLowerCase();
return `${this.#hostEl.lang || documentLanguage}`.toLowerCase();
}
private getTranslationData(lang: string) {
const locale = new Intl.Locale(lang);
const language = locale?.language.toLowerCase();
const region = locale?.region?.toLowerCase() ?? '';
const primary = <UserTranslation>translations.get(`${language}-${region}`);
const secondary = <UserTranslation>translations.get(language);
const primary = <TranslationType>translations.get(`${language}-${region}`);
const secondary = <TranslationType>translations.get(language);
return { locale, language, region, primary, secondary };
}
/** Outputs a translated term. */
term<K extends keyof UserTranslation>(key: K, ...args: FunctionParams<UserTranslation[K]>): string {
term<K extends keyof TranslationType>(key: K, ...args: FunctionParams<TranslationType[K]>): string {
const { primary, secondary } = this.getTranslationData(this.lang());
let term: any;
@@ -104,8 +110,8 @@ export class UmbLocalizeController<UserTranslation extends Translation = Default
term = primary[key];
} else if (secondary && secondary[key]) {
term = secondary[key];
} else if (fallback && fallback[key as keyof Translation]) {
term = fallback[key as keyof Translation];
} else if (fallback && fallback[key as keyof TranslationSet]) {
term = fallback[key as keyof TranslationSet];
} else {
return String(key);
}

16
src/Umbraco.Web.UI.Client/src/libs/localization-api/manager.ts
View File

@@ -11,25 +11,26 @@ The above copyright notice and this permission notice shall be included in all c
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
import { LitElement } from '@umbraco-cms/backoffice/external/lit';
import type { UmbTranslationEntry } from '@umbraco-cms/backoffice/extension-registry';
import type { LitElement } from '@umbraco-cms/backoffice/external/lit';
export type FunctionParams<T> = T extends (...args: infer U) => string ? U : [];
export interface Translation {
export interface TranslationSet {
$code: string; // e.g. en, en-GB
$dir: 'ltr' | 'rtl';
}
export interface DefaultTranslation extends Translation {
[key: string]: any;
export interface DefaultTranslationSet extends TranslationSet {
[key: string]: UmbTranslationEntry;
}
export const connectedElements = new Set<HTMLElement>();
const documentElementObserver = new MutationObserver(update);
export const translations: Map<string, Translation> = new Map();
export const translations: Map<string, TranslationSet> = new Map();
export let documentDirection = document.documentElement.dir || 'ltr';
export let documentLanguage = document.documentElement.lang || navigator.language;
export let fallback: Translation;
export let fallback: TranslationSet;
// Watch for changes on <html lang>
documentElementObserver.observe(document.documentElement, {
@@ -38,7 +39,7 @@ documentElementObserver.observe(document.documentElement, {
});
/** Registers one or more translations */
export function registerTranslation(...translation: Translation[]) {
export function registerTranslation(...translation: TranslationSet[]) {
translation.map((t) => {
const code = t.$code.toLowerCase();
@@ -65,6 +66,7 @@ export function update() {
[...connectedElements.keys()].map((el) => {
if (typeof (el as LitElement).requestUpdate === 'function') {
// TODO: We might want to implement a specific Umbraco method for informing about this. and then make the default UmbLitElement call requestUpdate..? Cause then others can implement their own solution?
(el as LitElement).requestUpdate();
}
});

4
src/Umbraco.Web.UI.Client/src/libs/localization-api/registry/translation.registry.ts
View File

@@ -1,4 +1,4 @@
import { Translation, registerTranslation } from '../manager.js';
import { TranslationSet, registerTranslation } from '../manager.js';
import { hasDefaultExport, loadExtension } from '@umbraco-cms/backoffice/extension-api';
import {
UmbBackofficeExtensionRegistry,
@@ -41,7 +41,7 @@ export class UmbTranslationRegistry {
}
// Notify subscribers that the inner dictionary has changed.
const translation: Translation = {
const translation: TranslationSet = {
$code: userCulture,
$dir: extension.meta.direction ?? 'ltr',
...innerDictionary,