Editor Panel Module

The module allows creating 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. It is available only to the project members that have access to the Editor.

Structure

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

Properties

key

Type: string

Required: yes

Description: Module identifier within the Crowdin app.

position

Type: string

Required: yes

Allowed values: right

Description: The position where the module will be placed.

name

Type: string

Required: yes

Description: The human-readable name of the module.

modes

Type: array

Required: yes

Allowed values: assets, review, translate

Description: The Editor's mode list where the module will be available.

url

Type: string

Required: yes

Description: The relative URL to the content page of the module that will be integrated into the Crowdin Enterprise UI.

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.

Was this article helpful?