Modal Module

The module allows the creation of a new modal dialog. The current module works only with the Context menu module that opens it.

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

For Crowdin:

  • Only me (i.e., project owner)
  • All project members
  • Selected users

For Crowdin Enterprise:

  • Only organization admins
  • All users in the organization projects
  • Selected users

Modal module structure:

{
  "modal": [
    {
      "key": "your-module-key",
      "name": "Module name",
      "url": "/module-url"
    }
  ]
}

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. Uses as Context menu text

url

Type: string

Required: yes

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

environments

Type: string

Allowed values: crowdin, crowdin-enterprise

Description: Define the environment in which the module will run.
This parameter is needed for cross-product applications.

Was this article helpful?