Módulos

Os módulos permitem que os aplicativos estendam a interface do usuário Crowdin, criem integrações com serviços externos, etc.

Módulos suportados

  • Módulo de integrações – fornece a possibilidade de inserir uma nova página de integração no Crowdin.
  • O módulo de painéis do editor – oferece a possibilidade de criar guias adicionais no Editor.
  • O módulo de recursos – oferece a possibilidade de criar um painel adicional nos recursos do proprietário do projeto.

Mais módulos do Crowdin Apps serão disponibilizados em breve.

Visão geral do módulo

Módulo de integração

O módulo de integrações oferece a possibilidade de criar e inserir uma nova integração dentro do projeto Crowdin. You can find it in the Project Settings, Integrations tab. Este módulo está disponível para membros do projeto com permissões de gerente (ou superior).

Estrutura do módulo de integração:

{
  "integrations": [
    {
      "key": "my-module-key",
      "name": "Module name",
      "description": "Module description",
      "logo": "/logo.png",
      "url": "/integration-page"
    }
  ]
}

Propriedades:

chave

Tipo: string

Requerido: sim

Descrição: Identificador de módulo no aplicativo Crowdin.

name

Tipo: string

Requerido: sim

Descrição: O nome legível por humanos do módulo.

description

Tipo: string

Descrição: A descrição legível por humanos do que o módulo faz.
A descrição estará visível na interface do usuário do Crowdin.

logo

Tipo: string

Requerido: sim

Descrição: A URL relativa ao logotipo da integração, que será exibida na UI do Crowdin.
A resolução recomendada é de 48x48 pixels.

url

Tipo: string

Requerido: sim

Descrição: A URL relativa à página de conteúdo do módulo, que será integrada à UI do Crowdin.

Módulo de painéis do editor

O módulo de painéis do editor oferece a possibilidade de criar guias adicionais no Editor. Ao usar este módulo em seu aplicativo para Crowdin, você pode escolher o modo editor onde deseja que as guias adicionais sejam exibidas. O módulo de painéis do editor está disponível apenas para os membros do projeto que têm acesso ao Editor.

Estrutura do módulo do painel do editor:

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

Propriedades:

chave

Tipo: string

Requerido: sim

Descrição: Identificador de módulo no aplicativo Crowdin.

position

Tipo: string

Requerido: sim

Valores permitidos: right

Descrição: A posição onde o módulo será colocado.

name

Tipo: string

Requerido: sim

Descrição: O nome legível por humanos do módulo.

modes

Tipo: array

Requerido: sim

Valores permitidos: assets, review, translate, proofread

Descrição: A lista de modos do Editor onde o módulo estará disponível.

url

Tipo: string

Requerido: sim

Descrição: A URL relativa à página de conteúdo do módulo, que será integrada à UI do Crowdin.

Módulo de recursos

O módulo de recursos oferece a possibilidade de criar um painel adicional nos recursos do proprietário do projeto. Este módulo está disponível apenas para o proprietário do projeto.

Resource module structure:

{
  "resources": [
    {
      "key": "my-module-key",
      "name": "Module name",
      "url": "/resource-page"
    }
  ]
}

Propriedades:

chave

Tipo: string

Requerido: sim

Descrição: Identificador de módulo no aplicativo Crowdin.

name

Tipo: string

Requerido: sim

Descrição: O nome legível por humanos do módulo.

url

Tipo: string

Requerido: sim

Descrição: A URL relativa à página de conteúdo do módulo, que será integrada à UI do Crowdin.

Adicione módulos ao seu aplicativo Crowdin

Para usar um módulo no seu aplicativo, declare o módulo no seu arquivo do descritor de aplicativos nos módulos, incluindo quaisquer propriedades necessárias. As propriedades que você inclui controlam as opções de personalização para seu módulo.

Estrutura básica do módulo:

{
  "{module_type}": [
    {
      "key": "my-module-key",
      "name": "Module Name",
      "description": "Module description"
    }
  ]
}

Propriedades

{module_type}

Tipo: string

Requerido: sim

Valores permitidos integrations

Descrição: O tipo de módulo que o aplicativo Crowdin usa.

chave

Tipo: string

Requerido: sim

Descrição: Identificador de módulo no aplicativo Crowdin.

name

Tipo: string

Requerido: sim

Descrição: O nome legível por humanos do módulo.

description

Tipo: string

Descrição: Uma descrição legível por humanos do que o módulo faz.
A descrição estará visível na interface do usuário do Crowdin.

Este artigo foi útil?