Collaborative Comments

Über

Das Plugin erweitert das Payload-v3-Admin-Panel um ein Kommentarsystem mit drei Oberflächen. Ein Badge an jedem Feldlabel zeigt die Anzahl der Kommentare für das jeweilige Feld und öffnet ein Popup zum Schreiben. Eine Drawer-Ansicht in der Dokument-Seitenleiste listet alle Kommentare des aktuellen Dokuments. Ein Button im globalen Header öffnet einen Drawer mit allen Kommentaren über alle Collections und Globals hinweg. Kommentare werden in einer automatisch generierten `comments`-Collection gespeichert, die im Sidebar versteckt ist. Eine zusätzliche `commentReads`-Collection erfasst den Lesestatus. Jeder Eintrag dokumentiert `collectionSlug` oder `globalSlug`, `documentId`, `fieldPath` in Punkt-Notation (null entspricht Dokument-Ebene), `locale`, Autor, Erwähnungen, Resolving-Status sowie optional einen Tenant. Die Registrierung erfolgt als Standard-Payload-Plugin über `commentsPlugin()`. Das Plugin fügt Admin-Provider, Header-Buttons und angepasste Field-Label-Komponenten in die Payload-Konfiguration ein und bringt eigene i18n-Strings im bestehenden Namespace ein. Bei SQL-Adaptern ist eine Migration für die neue Collection nötig, MongoDB benötigt keine. Über die Konfiguration lässt sich pro Collection festlegen, welches Feld als Dokumenttitel angezeigt wird. Zugriffskontrolle, Hooks und Felder der `comments`-Collection lassen sich überschreiben, und `usernameFieldPath` lässt sich auf einen beliebigen Pfad in der Users-Collection zeigen. @mentions funktionieren über ein Autocomplete gegen die Users-Collection und speichern Tokens als `@(userId)`. Erwähnte Personen erhalten E-Mail-Benachrichtigungen über Resend. Das Senden wird über die Umgebungsvariablen `RESEND_API_KEY` und `RESEND_FROM_EMAIL` gesteuert: Fehlt die Absenderadresse, funktionieren Mentions weiterhin, E-Mails werden jedoch nicht verschickt. Kommentare lassen sich als erledigt markieren und wieder öffnen. Der Dokument-Drawer bietet Filter für Offen, Erledigt und „Mentioned me“. Optionales Multi-Tenancy ordnet Kommentare über `@payloadcms/plugin-multi-tenant` dem jeweiligen Tenant zu, mit konfigurierbarer Tenant-Collection und Document-Tenant-Field. Feld-Kommentare sind an ein Locale gebunden, Dokument-Kommentare erscheinen in allen Locales. Beim Löschen eines Dokuments entfernt ein Collection-Hook automatisch die zugehörigen Kommentare. Die UI aktualisiert sich optimistisch, sodass neue Kommentare erscheinen, bevor der Server die Bestätigung sendet.

Paketinformationen

Paketname

@focus-reactive/payload-plugin-comments

Neueste Version

1.11.3

Entpackte Größe

625 kB

Lizenz

MIT

Wöchentliche Downloads

3091

Zuletzt veröffentlicht

12. Okt. 2026