Editor Right Panel Module

The module allows the creation of additional tabs in the Editor’s right panel. When using this module in your Crowdin app, you can choose the Editor mode where you’d like the additional tabs to be displayed.

Access

You can grant access to this module to one of the following user categories:

For Crowdin:

• Only me (i.e., project owner)
• Me, project managers and developers
• All project members
• Selected users

For Crowdin Enterprise:

• Only organization admins
• Organization admins, project managers and developers
• All users in the organization projects
• Selected users

Structure

manifest.json

{
  "modules": {
    "editor-right-panel": [
      {
        "key": "your-module-key",
        "name": "Module name",
        "modes": [
          "translate"
        ],
        "supportsMultipleStrings": false,
        "url": "/editor-page"
      }
    ]
  }
}

Properties

key	Type: string Required: yes Description: Module identifier within the Crowdin app.
name	Type: string Required: yes Description: The human-readable name of the module.
modes	Type: array Required: yes Allowed values: translate, comfortable, side-by-side, multilingual, review, assets Description: The Editor’s mode list where the module will be available. Use translate to make the module available in the following views: comfortable, side-by-side, and multilingual. For more granular control, specify one or more of these values directly. The review mode is available only in Crowdin Enterprise and only on the Source Text Review workflow step. The assets mode is used for managing assets in the Editor.
supportsMultipleStrings	Type: boolean Description: Indicates whether the module can remain active when multiple strings are selected in the Editor. Set to true if your module is designed to handle multiple selected strings. If set to false or omitted, the right panel will be disabled when multiple strings are selected.
url	Type: string Required: yes Description: The relative URL to the module content page that will be embedded in the Editor’s right panel.
environments	Type: string Allowed values: crowdin, crowdin-enterprise Description: Set of environments where a module could be installed. This parameter is needed for cross-product applications.