Skip to content

Usage Suggestions

By default, we designed the SDK to be used as a floating window above your application's components. This behavior can be adjusted according to your needs, but for this guide, we will focus on this default behavior to provide suggestions.

For this type of application, we have two different recommendations:

Always Visible Window - Default

In this setup, the translator window remains visible at all times after activation.

This approach is recommended for applications with plenty of screen space, where the translator does not interfere with your solution’s interface.

Always visible window

  1. Resting window
  2. Translation loading
  3. Avatar translating
  4. Post-translation → Active rating button
  5. Post-rating

TIP

Since this is the default flow, there's no need to combine functionalities to achieve this behavior. Simply activating the SDK and performing translations will automatically follow this flow.

Minimized Window

In this variation, the translator window appears only while the translation is in progress. When there is no active translation, it retracts into a floating widget.

This type of setup is ideal for interfaces with limited space, as it reduces the occupied screen area and minimizes interference with the product’s interface.

Minimized window per translation

  1. Widget
  2. Widget with open menu
  3. Translation loading
  4. Avatar translating
  5. Post-translation → Widget with open menu

To achieve this flow, you need to combine functionalities, triggering them as needed:

The theoretical flow would be:

  1. Start SDK;
  2. Minimize;
  3. Maximize;
  4. Translate;
  5. Stop translation;
  6. Minimize.

Below, you can see an example of using these functionalities together:

Full translation with widget

Translation + Minimize and Maximize


Stop translation + Minimize and Maximize

Stop translation + Minimize and Maximize

Released under the MIT License.