Modules allow apps to extend the Crowdin user interface, create integrations with external services, etc.
More Crowdin Apps modules are coming soon.
Integrations module provides a possibility to create and insert a new integration within the Crowdin project. You can find it in the Project Settings, Integrations tab. This module is available to project members with manager permissions (or higher).
Integration module structure:
{
"integrations": [
{
"key": "my-module-key",
"name": "Module name",
"description": "Module description",
"logo": "/logo.png",
"url": "/integration-page"
}
]
}
Properties:
key | Type: Required: yes Description: Module identifier within the Crowdin app. |
name | Type: Required: yes Description: The human-readable name of the module. |
description | Type: Description: The human-readable description of what the module does. |
logo | Type: Required: yes Description: The relative URL to the integration's logo, that will be displayed in the Crowdin UI. |
url | Type: Required: yes Description: The relative URL to the content page of the module, that will be integrated into the Crowdin UI. |
Editor-panels module provides a possibility to create additional tabs in the Editor. When using this module in your Crowdin app, you can choose the Editor mode where you’d like the additional tabs to be displayed. Editor-panels module is available only to the project members that have access to the Editor.
Editor-panel module structure:
{
"editor-panels": [
{
"key": "my-module-key",
"position": "right",
"name": "Module name",
"modes": ["translate", "proofread"],
"url": "/editor-page"
}
]
}
Properties:
key | Type: Required: yes Description: Module identifier within the Crowdin app. |
position | Type: Required: yes Allowed values: Description: The position where the module will be placed. |
name | Type: Required: yes Description: The human-readable name of the module. |
modes | Type: Required: yes Allowed values: Description: The Editor's mode list where the module will be available. |
url | Type: Required: yes Description: The relative URL to the content page of the module, that will be integrated into the Crowdin UI. |
Resources module provides a possibility to create an additional panel in the project owner’s resources. This module is available only to project owner.
Resource module structure:
{
"resources": [
{
"key": "my-module-key",
"name": "Module name",
"url": "/resource-page"
}
]
}
Properties:
key | Type: Required: yes Description: Module identifier within the Crowdin app. |
name | Type: Required: yes Description: The human-readable name of the module. |
url | Type: Required: yes Description: The relative URL to the content page of the module, that will be integrated into the Crowdin UI. |
To use a module in your app, declare the module in your App Descriptor file under modules, including any required properties. The properties you include control the customization options for your module.
Basic module structure:
{
"{module_type}": [
{
"key": "my-module-key",
"name": "Module Name",
"description": "Module description"
}
]
}
{module_type} | Type: Required: yes Allowed values Description: The type of module Crowdin app uses. |
key | Type: Required: yes Description: Module identifier within the Crowdin app. |
name | Type: Required: yes Description: The human-readable name of the module. |
description | Type: Description: A human-readable description of what the module does. |