Welcome to Instabug's Documentation!
Here you'll find a comprehensive technical guide
to help you start working with the Instabug SDK efficiently.

Get Started

SDK Locale

This section covers how to change the language of the SDK in your app as well as the content of all Instabug messages that your users see.

Setting the Locale

The SDK will automatically use the current locale of your user's device, however, you can override it with the following method.

cordova.plugins.instabug.setLocale(
    'french',
    function () {
        console.log('Locale changed.');
    },
    function (error) {
        console.log('Failed to fail locale - ' + error);
    }
);

Here are the possible locale values.

'arabic'
'chineseSimplified'
'chineseTraditional'
'english'
'french'
'german'
'italian'
'japanese'
'korean'
'polish'
'portugueseBrazil'
'russian'
'spanish'
'swedish'
'turkish'
'czech'

Dashboard Language

At the moment, the Instabug dashboard only supports English. Changing the SDK locale will not change the language of your dashboard.


What's Next

The locale is reflected in all aspects of the Instabug SDK that your users see in your app, including the Welcome Message, bug reporting flow, and Prompt Options.

Welcome Message
Bug Reporting
Prompt Options

SDK Locale


This section covers how to change the language of the SDK in your app as well as the content of all Instabug messages that your users see.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.