Auf dieser Seite

Preview

Komponente für die Online-Vorschau von docx-, pptx-, pdf- und xlsx-Dateien.

Nimm sie, wenn du docx-, pptx-, pdf- oder xlsx-Dateien im Browser vorschauen willst. <r-preview> öffnet aus einer Datei-URL einen Vorschaudialog (inzwischen als eigenständiges Paket @ranui/preview ausgeliefert).

⚠️ Wichtiger Hinweis: Ab Version 0.1.10-alpha-27 enthält das ranui-Paket diese Komponente nicht mehr. Wechsle zum eigenständigen Paket @ranui/preview.

Schnellstart

Installation

# Das eigenständige Vorschau-Paket verwenden (empfohlen)
npm install @ranui/preview

# Oder das komplette ranui-Paket (vor Version 0.1.10-alpha-27)
npm install ranui

Grundlegende Verwendung

Datei für die Vorschau wählen
<r-preview id="preview-demo"></r-preview>
<r-button type="primary" onclick="uploadFile()">Datei für die Vorschau wählen</r-button>

<script>
  let selectedUrl;
  const uploadFile = () => {
    const preview = document.getElementById('preview-demo');
    const input = document.createElement('input');
    input.setAttribute('type', 'file');
    input.setAttribute('accept', '.docx,.pptx,.pdf,.xlsx,.xls');
    input.click();

    input.onchange = (e) => {
      const { files = [] } = input;
      if (files.length > 0) {
        const file = files[0];
        if (selectedUrl) URL.revokeObjectURL(selectedUrl);
        selectedUrl = URL.createObjectURL(file);
        preview.setAttribute('src', selectedUrl);
      }
    };
  };
  window.addEventListener('pagehide', (event) => {
    if (!event.persisted && selectedUrl) URL.revokeObjectURL(selectedUrl);
  });
</script>

API-Referenz

Eigenschaften

Attribut / Eigenschaft Typ Standard Beschreibung
src string — Datei-URL; das Setzen öffnet den Dialog
closeable string — Die Zeichenfolge false deaktiviert Schließen und Escape
baseUrl / baseurl string https://edit.chaxus.com URL der Office-Editorseite
readonly boolean false Optionaler Office-Schreibschutz
pdf-mode / pdfMode string eager PDF-Modus: eager oder virtual
label string Preview file Zugänglicher Name des Auslösers

Dateiquelle src

Setze die URL der Datei, um den Vorschaudialog zu öffnen; ein leerer Wert zeigt ihn nicht.

<r-preview src="https://example.com/document.docx"></r-preview>

Schließbarkeit closeable

Steuert, ob sich der Vorschaudialog schließen lässt.

<!-- Standardmäßig schließbar -->
<r-preview closeable="true"></r-preview>

<!-- Nicht schließbar -->
<r-preview closeable="false"></r-preview>

Eigener Dienst baseUrl

Wenn du den Dokument-Vorschaudienst selbst betreiben willst, gib seine Adresse über die Eigenschaft baseUrl an.

<r-preview baseUrl="https://edit.chaxus.com"></r-preview>

💡 Tipp: Standardmäßig wird der gehostete Vorschaudienst unter https://edit.chaxus.com verwendet. Zum Selbsthosten siehe OnlyOffice Web Local.

Kompatibilität mit 0.3.0

0.3.0 behält die automatische Registrierung und standardmäßig bearbeitbare Office-Dateien bei. Im PDF-Standardmodus eager folgt load auf das Zeichnen aller Seiten. Mit pdf-mode="virtual" (JavaScript: pdfMode = 'virtual') werden sichtbare Seiten gerendert; load bedeutet dann, dass der erste Ausschnitt und sein Puffer bereit sind. Der Worker bleibt bis zum Schließen, Quellwechsel oder Entfernen aktiv. Änderungen an readonly oder closeable erhalten den Office-Editor und ungespeicherte Änderungen.

<r-preview pdf-mode="virtual" src="/reports/long.pdf"></r-preview>
<r-preview readonly src="/reports/annual.docx"></r-preview>

PDFs werden lokal gerendert. Office-Dateien werden an den konfigurierten Editor-iframe übergeben, dessen Seite auf den Inhalt zugreifen kann. Für private oder interne Dokumente eine eigene baseUrl-Bereitstellung verwenden.

Migrationsleitfaden

Wenn du derzeit die Komponente r-preview aus dem ranui-Paket verwendest, empfehlen wir diese Schritte:

  1. Neues Paket installieren:

    npm install @ranui/preview
  2. Imports anpassen:

    // Vorher
    import 'ranui';
    
    // Jetzt
    import '@ranui/preview';
  3. Die Verwendung im HTML bleibt gleich:

    <r-preview src="your-file-url"></r-preview>