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 your project’s Applications 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. |
tilstande | 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. |
Project menu module provides a possibility to create a new tab in the project. This module is available to project members with manager permissions (or higher).
Projektmenumodulstruktur:
{
"project-menu": [
{
"key": "min-modulnøgle",
"name": "Modulnavn",
"url": "/project-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. |
This module helps you connect machine translation engines that are not supported by Crowdin yet. Once you create this kind of app, you’ll be able to pre-translate your content with the connected MT or enable translation suggestions made by it to be shown in the editor for translators.
Custom MT module structure:
{
"custom-mt": [
{
"key": "custom-mt",
"name": "Custom MT",
"url": "/translate"
}
]
}
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 with Crowdin. |
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.
Basismodulstruktur:
{
"{module_type}": [
{
"key": "my-module-key",
"name": "Module Name",
"description": "Module description"
}
]
}
{module_type} | Type: Required: yes Allowed values Beskrivelse: Den af Crowdin-appen anvendte modultype. |
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. |