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

add documentation

Browse Source
This commit is contained in:
Jacob Overgaard
2023-08-01 10:57:21 +02:00
parent 6bacd22d84
commit e270844b24
1 changed files with 14 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
src/Umbraco.Web.UI.Client/src/packages/core/extension-registry/models/translations.model.ts
View File

@@ -7,14 +7,24 @@ export interface ManifestTranslations extends ManifestDefaultExport<Record<strin
export interface MetaTranslations {
/**
* The culture of the translations.
* @example "en-US"
* @summary The culture of the translations.
* @description
* The culture is a combination of a language and a country. The language is represented by an ISO 639-1 code and the country is represented by an ISO 3166-1 alpha-2 code.
* The language and country are separated by a dash.
* The value is used to describe the language of the translations according to the extension system
* and it will be set as the `lang` attribute on the `<html>` element.
* @see https://en.wikipedia.org/wiki/Language_localisation#Language_tags_and_codes
* @examples ["en-us", "en-gb", "da-dk"]
*/
culture: string;
/**
* The direction of the translations (left-to-right or right-to-left).
* @example "ltr"
* @summary The direction of the translations (left-to-right or right-to-left).
* @description
* The value is used to describe the direction of the translations according to the extension system
* and it will be set as the `dir` attribute on the `<html>` element. It defaults to `ltr`.
* @see https://en.wikipedia.org/wiki/Right-to-left
* @examples ["ltr"]
* @default "ltr"
*/
direction?: 'ltr' | 'rtl';