onpage core

Framework-unabhängiger Kern für Click-to-Edit-Vorschauen, die über die Payload REST API als Entwurf speichern.

Community 0 2008/Wo. MIT v0.6.0

Installation

pnpm add @payload-onpage/core

Über

Das Core-Paket enthält die Teile von payload-onpage, die von keinem Framework abhängen: Dokumentreferenzen, Schema-Verarbeitung, Feldoperationen, den Stega-Codec zur Markierung editierbarer Texte im gerenderten HTML, Autosave und die Editor-Session. Dazu kommen die Port-Interfaces DataSource, MediaLibrary, Locator, Renderer und SessionAdapter, die Adapter implementieren. Das Paket ist kein eigenständiges Payload-Plugin. Feld-Editoren liegen in @payload-onpage/react, deshalb enthält dieses Paket keine React-Komponenten. Der Standard-DataSource-Adapter payloadRest() liest und schreibt Dokumente über die Payload REST API mit den Cookies des angemeldeten Benutzers. Eine API-Basis (Standard /api) und ein Endpoint-Präfix (Standard /onpage) lassen sich konfigurieren. Speichervorgänge laufen als PATCH mit draft=true und autosave=true, bei Globals als POST. Ein Publish setzt _status auf published. Access Control, Hooks, Validierung, Drafts und Versionen greifen dabei wie im Admin-Interface. Der Header If-Unmodified-Since übermittelt updatedAt. Hat ein anderer Speichervorgang zuerst stattgefunden, antwortet der Server mit 409, sodass keine veralteten Daten überschrieben werden. Für die Medienbibliothek liefert payloadUploads() den Standard-MediaLibrary-Adapter über eine Upload-Collection. Optionale Methoden des DataSource-Ports decken Relationssuche, Preview-Links, geplantes Veröffentlichen, versteckte Felder über admin.condition, Dokument-Sperren, Versionsverlauf mit Wiederherstellung, Kommentare, Review-Anfragen, Seitenduplizierung, Seitenerstellung sowie gespeicherte Muster ab. Eine Methode erscheint nur, wenn der jeweilige Adapter sie implementiert. Das Paket richtet sich an Next.js (App Router) und TanStack Start. Die UI-Texte liegen auf Englisch, Spanisch, Französisch und Deutsch vor. Voraussetzung ist Node 20.9 oder neuer. Der Build erfolgt mit tsc -b, die Tests laufen mit bun test.

Paketinformationen

Paketname
@payload-onpage/core
Neueste Version
0.6.0
Entpackte Größe
357 kB
Lizenz
MIT
Wöchentliche Downloads
2008
Zuletzt veröffentlicht
13. Okt. 2026

Mehr von jellologic

Profil ansehen

Ähnliche Plugins

Mehr in Content