Editor-Schaltflächenmodul

Mit diesem Modul können Schaltflächen zum Editor hinzugefügt werden, die auf ein anderes Modul derselben App wirken.

Positionen der Editor-Schaltflächen:

header-right: die obere rechte Ecke des Editor-Headers
header-left: die obere linke Ecke des Editor-Headers
menu: das Apps-Menü im Hauptmenü des Editors
translation-toolbar: die Symbolleiste mit den Aktionen für die aktuelle Übersetzung
strings-menu: das Menü des aktuell ausgewählten Strings bzw. der aktuell ausgewählten Strings

Eine Schaltfläche kann eine der folgenden Aktionen ausführen:

Ein angegebenes App-Modul im rechten Editorpanel öffnen (siehe Modul für das rechte Editorpanel)
Ein angegebenes App-Modul in einem modalen Dialog öffnen (siehe Modalmodul)
Ein editor.button.click-Ereignis an ein angegebenes App-Modul senden

Die Typen panel und modal sind an jeder Position verfügbar. Der Typ event ist an den Positionen translation-toolbar und strings-menu verfügbar.

Ein panel- oder event-Button wird nur in den Editor-Modi angezeigt, die auch das Zielmodul angibt. Stelle daher sicher, dass die modes des Buttons innerhalb der für das Zielmodul definierten Modi liegen. Ein modal-Button hängt ausschließlich von seinen eigenen modes ab.

Die Header-Positionen und die Übersetzungssymbolleiste zeigen jeweils bis zu vier Schaltflächen. Die übrigen sind im Dropdown Weitere App-Aktionen verfügbar. Im Modus assets sind Schaltflächen an den Positionen header-right, header-left und menu verfügbar. Auf Mobilgeräten sind Buttons an den Positionen menu, translation-toolbar und strings-menu verfügbar. In der Übersetzungsleiste wird jeweils nur ein Button gleichzeitig angezeigt.

Editor-Schaltflächen werden auch in der Befehlspalette des Editors aufgelistet. Für jede Schaltfläche kann unter Hilfe > Tastenkürzel ein Tastenkürzel zugewiesen werden.

Zugriff

Du kannst Zugriff auf dieses Modul für eine der folgenden Benutzerkategorien gewähren:

Für Crowdin:

Nur ich (also der Projektinhaber)
Ich, Projektmanager und Entwickler
Alle Projektmitglieder
Ausgewählte Benutzer

Für Crowdin Enterprise:

Nur Organisationsadministratoren
Organisationsadministratoren, Projektmanager und Entwickler
Alle Benutzer in den Projekten der Organisation
Ausgewählte Benutzer

Struktur

Panel

Die Schaltfläche öffnet das angegebene Modul im rechten Editorpanel.

{
  "modules": {
    "editor-button": [
      {
        "key": "editor-button-key",
        "name": "Name of Editor Button",
        "logo": "/editor-button-logo.png",
        "modes": [
          "translate"
        ],
        "options": {
          "location": "header-right",
          "type": "panel",
          "module": "editor-panel-module-key",
          "weight": 10
        }
      }
    ],
    "editor-right-panel": [
      {
        "key": "editor-panel-module-key",
        "name": "New Panel",
        "modes": [
          "translate"
        ],
        "url": "/editor-page"
      }
    ]
  }
}

Die Schaltfläche öffnet das angegebene Modul in einem modalen Dialog.

{
  "modules": {
    "editor-button": [
      {
        "key": "editor-button-key",
        "name": "Name of Editor Button",
        "modes": [
          "translate"
        ],
        "options": {
          "location": "menu",
          "type": "modal",
          "module": "modal-module-key"
        }
      }
    ],
    "modal": [
      {
        "key": "modal-module-key",
        "name": "New Modal",
        "url": "/path/to/modal/module"
      }
    ]
  }
}

Event

Die Schaltfläche sendet ein editor.button.click-Ereignis an das angegebene Modul, ohne es zu öffnen.

{
  "modules": {
    "editor-button": [
      {
        "key": "editor-button-key",
        "name": "Name of Editor Button",
        "modes": [
          "translate"
        ],
        "options": {
          "location": "translation-toolbar",
          "type": "event",
          "module": "editor-panel-module-key"
        }
      }
    ],
    "editor-right-panel": [
      {
        "key": "editor-panel-module-key",
        "name": "New Panel",
        "modes": [
          "translate"
        ],
        "url": "/editor-page"
      }
    ]
  }
}

Der Event-Payload hängt von der Position der Schaltfläche ab. Siehe Unterstützte Ereignisse für die Struktur des Objekts.

Eigenschaften

`key`	Typ: `string` Erforderlich: Ja Beschreibung: Modulkennung innerhalb der Crowdin-App. Die Kennung muss sich von den Schlüsseln der `editor-right-panel`, `editor-background-worker`, und `modal` Module der App unterscheiden.
`name`	Typ: `string` Erforderlich: ja Beschreibung: Der für Menschen lesbare Name, der im Tooltip der Schaltfläche und als Eintragsbezeichnung in den Menüs angezeigt wird.
`logo`	Typ: `string` Beschreibung: Die relative URL zum Symbol der Schaltfläche. Das Symbol wird mit 16x16 Pixeln angezeigt. Wenn es nicht angegeben ist, verwendet die Schaltfläche das Logo der App.
`modes`	Typ: `Array` Erforderlich: ja Zulässige Werte: `translate`, `comfortable`, `side-by-side`, `multilingual`, `review`, `assets` Beschreibung: Die Liste der Modi des Editors, in denen das Modul verfügbar ist. Verwende `translate`, um das Modul in den folgenden Ansichten verfügbar zu machen: `comfortable`, `side-by-side` und `multilingual`. Für eine detailliertere Steuerung kannst du einen oder mehrere dieser Werte direkt angeben. Der Modus `review` ist nur in Crowdin Enterprise und nur im Workflow-Schritt Überprüfung des Ausgangstexts verfügbar. Der Modus `assets` wird zum Verwalten von Assets im Editor verwendet.
`options.location`	Typ: `String` Erforderlich: ja Zulässige Werte: `header-right`, `header-left`, `menu`, `translation-toolbar`, `strings-menu` Beschreibung: Die Position im Editor, an der die Schaltfläche hinzugefügt wird.
`options.type`	Typ: `string` Erforderlich: ja Zulässige Werte: `panel`, `modal`, `event` Beschreibung: Der Aktionstyp, den diese Schaltfläche ausführt. Der Typ `event` wird an den Positionen `translation-toolbar` und `strings-menu` unterstützt.
`options.module`	Typ: `string` Erforderlich: ja Beschreibung: Der `key` des Moduls, auf das die Schaltfläche wirkt. Das Modul muss in derselben App deklariert sein, und beide müssen mindestens einen gemeinsamen Wert für `environments` haben. Verwende ein Modul `editor-right-panel` mit dem Typ `panel`, ein `modal`-Modul mit dem Typ `modal` und ein `editor-right-panel`- oder `editor-background-worker`-Modul mit dem Typ `event`.
`options.weight`	Typ: `integer` Beschreibung: Die Reihenfolge der Schaltfläche unter den anderen Schaltflächen an derselben Position. Schaltflächen mit niedrigeren Werten werden zuerst platziert: links im Header und in der Übersetzungssymbolleiste, weiter hinten in den Menüs. Der Standardwert ist `100`.
`environments`	Typ: `string` Zulässige Werte: `crowdin`, `crowdin-enterprise` Beschreibung: Menge der Umgebungen, in denen ein Modul installiert werden kann. Dieser Parameter wird für produktübergreifende Anwendungen benötigt.

Laufzeitstatus

Eine App kann ihre eigenen Schaltflächen aktualisieren, während der Editor geöffnet ist: das Symbol festlegen, ein Badge hinzufügen, den Tooltip überschreiben oder eine Schaltfläche deaktivieren. Verwende die Methode AP.editor.updateButton, um die Änderungen anzuwenden, und AP.editor.resetButton, um die Schaltfläche in den im Manifest deklarierten Zustand zurückzusetzen.

War diese Seite hilfreich?