Multilang

Über

Dieses Plugin implementiert ein Lokalisierungsmodell für Payload CMS, bei dem jede Ubersetzung ein eigenstaendiges Dokument ist. Die Dokumente werden ueber versteckte Metadatenfelder miteinander verknuepft. Das Plugin ist eine Alternative zur eingebauten Feld-Level-Lokalisierung von Payload und ist mit dieser nicht kombinierbar. Waehrend der Konfiguration wirft das Plugin einen Fehler, wenn `config.localization` aktiviert ist. Daher bleibt `localization: false` gesetzt, und der uebersetzte Text liegt direkt auf dem jeweiligen Sprachdokument. Die Konfiguration erfolgt in `payload.config.ts`. Dort werden die zu uebersetzenden Collections und Globals angegeben sowie ein `languages`-Array definiert. Jeder Spracheintrag enthaelt Code, Name, Locale, Flag-Label, Schreibrichtung (LTR oder RTL), einen Default-Schalter sowie Sortierung und Aktiv-Status. Das Plugin fuegt den uebersetzten Collections die versteckten Felder `_multilangLanguage`, `_multilangGroup` und `_multilangMeta` hinzu. Die Feldnamen lassen sich ueberschreiben. Im Admin-Panel gibt es einen Sprachwaehler in der Dokument-Seitenleiste, eine `Translations`-Bearbeitungsansicht zum Erstellen und Verknuepfen von Uebersetzungen, einen Uebersetzungsstatus pro Sprache sowie einen Sprachfilter mit Shortcut-Spalten in der Collection-Liste. Lokalisierte Globals zeigen pro konfigurierter Sprache einen eigenen Tab. Auf Collection-Ebene steuern Optionen das Uebersetzungsverhalten. `synchronizedFields` haelt Top-Level-Felder wie Autor oder Beitragsbild ueber alle Uebersetzungen einer Gruppe identisch und aktualisiert verknuepfte Dokumente bei Aenderungen. `duplicate` ist standardmaessig aktiv und kopiert kompatible Quellfelder in eine neue Uebersetzung. Mit `duplicateExcludeFields` lassen sich einzelne Felder vom Kopieren ausschliessen. Das Plugin registriert zudem Custom-Endpoints an jeder uebersetzten Collection fuer Uebersetzungsaktionen. Die Helper-APIs decken typische Anwendungsfaelle ab: `withLanguage` filtert Local-API-Abfragen nach Sprache, `getDocumentTranslationsWithPayload` und `getDocumentTranslationWithPayload` laden eine Uebersetzungsgruppe oder eine einzelne Sprachversion mit request-spezifischer Access-Control. Fuer Globals lesen und schreiben `findGlobalByLanguageWithPayload` und `updateGlobalByLanguageWithPayload` gezielt eine Sprache, ohne die anderen zu beruehren. `localizedSlugQuery` und `getMultilangDocumentLanguage` unterstuetzen Frontend-Routing und Admin-Vorschau-URLs. Da jede Uebersetzung ein eigenes Dokument ist, muss die Slug-Eindeutigkeit pro Sprache sichergestellt werden. Ein globales `unique: true` funktioniert nur, wenn jede Sprache einen eindeutigen Slug verwendet. Andernfalls laesst sich die Eindeutigkeit ueber einen zusammengesetzten Index aus Sprache und Slug abbilden. Das Plugin benoetigt Payload 3.x als Peer-Dependency (`payload ^3.84.1`) und wird unter MIT-Lizenz vertrieben.

Paketinformationen

Paketname

@roxxel/payload-multilang

Neueste Version

0.0.12

Entpackte Größe

723 kB

Lizenz

MIT

Wöchentliche Downloads

568

Zuletzt veröffentlicht

5. Juli 2026