Javascript functions

All functions you can call in your Javascript code

The JS library exposes functions that you can use anywhere in your code. (just make sure the library is already loaded when calling one of these functions)

Weglot.translate(payload, callback)

Parameters

• payload(Object):

  • words(Array)

    • t(Integer): word type, see word types reference

    • w(String): string to translate

  • languageTo(String): translation destination language code

• callback(Function)

Response

Promise containing translated strings

Example

Weglot.translate(
    {
    'words':[ { "t":1,"w": "Red" } ],
    'languageTo':'fr'
    } 
    , function(data) { console.log(data) }
);

Weglot.getCurrentLang(): String

Parameters

None

Response

String: the ISO 639-1 2-letter code of the current language on the page

Weglot.getLanguageName(code): String

Parameters

• code(String): the ISO 639-1 2-letter code of a language supported by Weglot

Response

String: the local name of the language, as defined by ISO 639-1

For example, calling Weglot.getLanguageName("es") returns "Español"

Weglot.getBestAvailableLanguage(): String

Parameters

None

Response

• code(String): the ISO 639-1 2-letter code of the best available language

This function checks the visitors preferred languages, and finds the best match among the languages you support on Weglot. It's the function used internally when you use the autoSwitch function

Weglot.search(term, callback): Boolean

Parameters

• term(String): Any term written in the current language of the page.

• callback(Function): A function that will be called whenever the search term in the original language is available. Takes one String argument

Response

true if there is a search to be made (the current language of the page differs from the original language)

false if there is no search to be made. In this case the callback is called immediately with the original term

Weglot.switchTo(code): void

Parameters

• code(String): the ISO 639-1 2-letter code of a language you're supporting on your website

  code is either originalLanguage or one of the destinationLanguages

Response

Nothing

Weglot.on(eventName, callback)

You can subscribe your own code to Weglot-specific events. When these events occur, the callback function you have defined will be called.

languageChanged (only JS integration)

This is called right after a language has changed on the page

Weglot.on("languageChanged", callbackFunction)

The callback function will be called with two optional arguments:

1. newLanguage (String): the 2-letter code of the language the page changed to

2. previousLanguage (String): the 2-letter code of the previous language of the page

Example:

Weglot.on("languageChanged", function(newLang, prevLang) {
    console.log("The language on the page just changed to (code): " + newLang)
    console.log("The full name of the language is: " + Weglot.getLanguageName(newLang))
})

This event is only available with our Javascript integration, not with subdomain or subdirectory integration.

initialized

This is called right after the call to Weglot.initialize(options) has been successful, but before the switchers are created and the page is translated

Weglot.on("initialized", callbackFunction)

The callback function will be called with no argument.

If you register your callback after Weglot has been initialized, this will have no effect.

To check whether Weglot is already initialized or not, you can read the boolean Weglot.initialized

switchersReady

This is called right after the switchers have been created.

Weglot.on("switchersReady", callbackFunction)

The callback function will be called with one optional argument: initialLanguage

Example:

Weglot.on("switchersReady", function(initialLanguage) {
  console.log("the switchers are ready, I can tweak them")
})

Weglot.off(eventName, callback): Boolean

With Weglot.off, you can unsubscribe the events you subscribed to with Weglot.on

Parameters

eventName(String): mandatory field, the name of the event you want to unsubscribe from

callbackFunction(Function): optional field, if you'd like to target a specific function

Response

true if one or more events have been unregistered

false otherwise

Weglot.initialize(options): void

Called to initialize Weglot. See Initialization code