Skip to content

UI Modules Overview

UI Modules allow apps to extend the Crowdin user interface, create integrations with external services, etc.

ModuleTypeApp ScopeCrowdinCrowdin Enterprise
Integrationsproject-integrationsProject
Toolsproject-toolsProject
Reportsproject-reportsProject
Project Menuproject-menuProject
Project Menu (Crowdsource View)project-menu-crowdsourceProject 
Editor Paneleditor-right-panelProject
Organization Menuorganization-menuOrganization 
Organization Menu (Crowdsource View)organization-menu-crowdsourceOrganization 
Resources Menuprofile-resources-menuAccount 
Custom MT Enginecustom-mtAccount/Organization
Context Menucontext-menuConfigurable
ModalmodalConfigurable
Custom Spellcheckercustom-spellcheckerOrganization 

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.

manifest.json
{
"identifier": "application-identifier",
"name": "New Cool App",
"logo": "/app-logo.png",
"baseUrl": "https://app.example.com",
"authentication": {
"type": "none"
},
"scopes": [],
"modules": {
"{module_type}": [
{
"key": "your-module-key",
"name": "Module Name"
}
]
}
}
{module_type}

Type: string

Required: yes

Description: The type of module Crowdin app uses.

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.

Was this page helpful?