@3cr/translations-ts

Ecosystem integration for code translations for 3DICOM Core Renderer (3CR) within the Browser (client-side)

Install `@3cr/translations-ts` package

Use the package manager npm or yarn to install @3cr/translations-ts

npm

npm install @3cr/translations-ts

yarn

yarn add @3cr/translations-ts

Using the Package

Retrieve available Languages

Call the getAvailableLanguages function to retrieve a list of ISO-639 Language Codes that this project supports

Typescript (.ts)
```
import {
  getAvailableLanguages
} from "@3cr/translations-ts";

const languages: Array<string> = await getAvailableLanguages();
```

Set your language

Call setLanguage with an ISO-639 Language Code you derived from the previous step

Typescript (.ts)

import {
  setLanguage
} from "@3cr/translations-ts";

await setLanguage(languages[0]); // 'en' in this case

Translate your code

Call t and supply the code you wish to translate.

Typescript (.ts)

import {
  t
} from "@3cr/translations-ts";

const translation = t('F00004');

console.log(translation)
// "Unable to load scan due to its dimensions exceeding 2048 pixels."

Note: For codes that have dynamic parameter mapping, you will need to supply a key-map for what to resolve the parameters to:

Typescript (.ts)

import {
  t
} from "@3cr/translations-ts";

const translation = t('F00027', {ID: 'Some ID'});

console.log(translation)
// "Object with Id, Some ID, could not be found."

Translation Code Mapping

Mapping for each of the translation codes fall within our documentation, start here

Note: Each code is prefixed with its severity (i.e., bootstrap colouring):

Prefix	Status	Colour
`S`	Successful	`success`
`I`	Informational	`info`
`A`	Advisory	`warning`
`F`	Failure	`error`

Contributing

Pull requests are welcome. For changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT