Textshine Bridge

Die Textshine Bridge ist eine API, um von einer Website aus die Textshine Browser Extension steuern zu können. Der primäre Anwendungsfall ist, die Textshine-Browser-Extension programmatisch aus dem CMS anzusteuern.

Achtung: Die Textshine-Browser-Extension muss beim Nutzer installiert sein, ansonsten wird ein Fehler geworfen.

Wir empfehlen, die Bridge über npm einzubinden, um automatische Updates zu erhalten.

Installation

npm install textshine-browser-extension-bridge

Nutzung

Entweder direkter Import des SDKs (vermeidet global scope pollution):

// ESM-Import (preferred)
import { startCorrection } from 'textshine-browser-extension-bridge'

// ODER CommonJS-Import
const { startCorrection } = require('textshine-browser-extension-bridge');

// Nutzung
startCorrection(params: { type, data }, callback)

oder bei älteren Umgebungen das register script, welches die API ins window-Objekt registriert (Achtung, funktioniert nicht bei SSR, weil es window-Existenz voraussetzt):

// ESM (preferred)
import 'textshine-browser-extension-bridge/register'

// or CommonJS
require('textshine-browser-extension-bridge/register');

window.textshineBridge.startCorrection(params: { type, data }, callback)

Sollte kein Buildprozess existieren, lässt sich auch die Datei node_modules/textshine-browser-extension-bridge/dist/browser/textshine-bridge.min.js kopieren und mittels Vanilla-HTML-Script-Tag einbetten.

API

toggleExtension()

Wechselt den Zustand der Extension (offen ↔ geschlossen), wie ein Klick auf das Toolbar-Icon. Ideal für Integrationen, die den Korrekturbutton im eigenen UI anbieten wollen.

startCorrection(input, callback)

Jeder Aufruf übergibt eine Liste von Items (oder Gruppen von Items) und erhält dieselbe Struktur zurück – nur mit korrigierten src-Werten. Diese Liste und optionale Gruppierung ergeben das Layout des Review-Editors in der Textshine-Extension.

Verwenden Sie für die Übergabe semantische HTML-Tags (z. B. h1/h2/h3, blockquote, p, strong, em etc.) anstelle von bloßen divs, damit der Review-Editor die Texte mit passender Formatierung anzeigen kann.

Signatur: