Brief Overview
The auto-toggle method is the recommended way to implement WalkMe Multi-Language on your website or platform. This method involves WalkMe detecting a language variable on your website to determine which language WalkMe text should appear in.
The following steps take you through implementing auto-toggle.
How It Works
1. Find Your Language Variable
On external websites, you should implement the JavaScript function walkme_get_language on your website, and this function will return the Language Custom Identifier(s) you specified in the admin.walkme.com during the initial language setup.
In order to implement the walkme_get_language function, you must first have a language variable at the window level that detects the end-user's language. Ask your IT team for the following:
- Language Variable Name
- Language Variable Outputs
2. Create Your Multi-Language Code
- Copy the following code to a Text Editor:
- Note: The highlighted text should be replaced with your own values
-
<script type="text/javascript"> window.walkme_get_language = function (){ if (window.langCode) { if (window.langCode == 'EN') { return ''; } else if (window.langCode == 'FR') { return 'FR'; } else { return '' } } } </script>
- Change the language variable name (in the example above its
window.langCode
), to the language variable name your IT team created- We will use
window.langvar
as our IT team's variable name throughout this example - The result looks like this:
<script type="text/javascript">
window.walkme_get_language = function (){
if (window.langvar)
- We will use
- Define your default language:
Where the example above says this:
if (window.langCode == 'EN') { return ''; }
change it to this:
if (window.langvar == 'EN') { return '';
- Change the variable output for whatever language you have set as default (in this example EN is our default language)
- The return function should be left blank for the default language or be the Language Custom Identifier found in the insights.walkme.com ACCOUNT tab
- Repeat the process above (for EN in this case) with each alternative language you want to translate to
- For our example, we'll add 'FR' as our alternate language - this would appear as follows:
else if (window.langvar == 'FR') { return 'FR'; } else { return '' }
Your final result should look like this:
<script type="text/javascript">
window.walkme_get_language = function (){
if (window.langvar)
{
if (window.langvar == 'EN') {
return '';
}
else if (window.langvar == 'FR') {
return 'FR';
}
else {
return ''
}
}
}
</script>
3. Add The Multi-Language Code to Your Website
- Copy your completed code
- Open the head tag for your site
- Paste the Multi-Language code on every page
In order to function correctly, Multi-Language code must be placed in the head tag of every page on which WalkMe will appear.