@craftercms/studio-ui/utils/i18n.d.ts

Services, components, models & utils to build CrafterCMS authoring extensions.

/*
 * Copyright (C) 2007-2022 Crafter Software Corporation. All Rights Reserved.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3 as published by
 * the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

import { IntlShape, MessageDescriptor } from 'react-intl';
import TranslationOrText from '../models/TranslationOrText';
import { FormatXMLElementFn, PrimitiveType } from 'intl-messageformat';
import { ReactNode } from 'react';
export type BundledLocaleCodes = 'en' | 'es' | 'de' | 'ko';
export declare const intl$: import('rxjs').Observable<IntlShape>;
export declare function augmentTranslations(translations: { [localeCode: string]: object }): void;
export declare function getTranslation(
  key: string,
  table: Record<string, MessageDescriptor>,
  formatMessage: IntlShape['formatMessage']
): string;
export declare function getPossibleTranslation(
  titleOrDescriptor: TranslationOrText,
  formatMessage: IntlShape['formatMessage'],
  values?: Record<string, PrimitiveType | FormatXMLElementFn<any, any>>
): string | ReactNode[];
export declare function getCurrentLocale(username?: string): string;
export declare function getCurrentIntl(): IntlShape;
export declare function buildStoredLanguageKey(username: string): string;
export declare function getStoredLanguage(username?: string): string;
export declare function setStoredLanguage(language: string, username?: string): void;
export declare function dispatchLanguageChange(language: string): void;