Class HyloLanguagesUrls

Manages different urls for different languages of the same page.

Properties

labels text urls

Methods

getLabel getLanguage getLanguages getPage getText getUrl

Events

hyloNewLanguageUrls

Properties

labels

labels: string

Provide labels for screen readers for each language in the currently displayed language in a JSON string like this:

'{"de:" "zur deutschen Version der Seite wechseln", "en:" "zur englischen Version der Seite wechseln"}'

text

text: string

Provide text for a language button for each language in the currently displayed language in a JSON string like this:

'{"de:" "DE", "en:" "EN"}'

urls

urls: string

Provide all urls for all languages of the current page in a JSON string like this:

'{"de": "/de/", "en": "/en/", "fr": "/fr/", "pl": "/pl/", "tr": "/tr/", "es": "/es/", "it": "/it/"}'

Methods

getLabel

  • getLabel(language): Promise<any>

  • Returns the label for the given language.

    Parameters

    • language: string

      e.g. 'de'

    Returns Promise<any>

getLanguage

  • getLanguage(): Promise<string>

  • Returns the current language displayed (key of the provided "urls" JSON object) by checking the provided urls against window.location.href.

    Returns Promise<string>

getLanguages

  • getLanguages(): Promise<string[]>

  • Returns all available languages (keys of the provided "urls" JSON object).

    Returns Promise<string[]>

getPage

  • getPage(language?): Promise<{
        active: boolean;
        key: string;
        label: string;
        text: string;
        url: string;
    }[]>

  • Returns the language setup of the current page in an array like [{key: 'de', 'url': ..., 'text': ..., 'label': ..., 'active': true || false}, ...]

    'text' and 'label' are provided in the active language if not set otherwise by the language parameter.

    Parameters

    • Optional language: string

      the language in which 'text' and 'label' is provided (optional)

    Returns Promise<{
        active: boolean;
        key: string;
        label: string;
        text: string;
        url: string;
    }[]>

getText

  • getText(language): Promise<any>

  • Returns the text for the given language.

    Parameters

    • language: string

      e.g. 'de'

    Returns Promise<any>

getUrl

  • getUrl(language): Promise<any>

  • Returns the url of the current page for the given language. Tries to guess if the language is not part of the provided urls JSON string.

    Parameters

    • language: string

      e.g. 'de'

    Returns Promise<any>

Events

hyloNewLanguageUrls

hyloNewLanguageUrls: EventEmitter<any>

Fires when this component got loaded and when "urls" changed.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc