Window: showSaveFilePicker() Methode

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Sicherer Kontext: Diese Funktion ist nur in sicheren Kontexten (HTTPS) in einigen oder allen unterstützenden Browsern verfügbar.

Experimentell: Dies ist eine experimentelle Technologie
Überprüfen Sie die Browser-Kompatibilitätstabelle sorgfältig vor der Verwendung auf produktiven Webseiten.

Die showSaveFilePicker() Methode der Window Schnittstelle zeigt einen Dateiauswahldialog, der es einem Benutzer ermöglicht, eine Datei zu speichern. Entweder durch Auswählen einer vorhandenen Datei oder durch Eingabe eines Namens für eine neue Datei.

Syntax

js
showSaveFilePicker()
showSaveFilePicker(options)

Parameter

options Optional

Ein Objekt, das Optionen enthält, die wie folgt sind:

excludeAcceptAllOption Optional

Ein boolescher Wert, der standardmäßig auf false gesetzt ist. Standardmäßig sollte der Auswahldialog eine Option enthalten, keine Dateitypfilter anzuwenden (veranlasst durch die unten angegebene Typ-Option). Wenn diese Option auf true gesetzt ist, steht diese Option nicht zur Verfügung.

id Optional

Durch Spezifizieren einer ID kann der Browser sich unterschiedliche Verzeichnisse für verschiedene IDs merken. Wenn dieselbe ID für einen anderen Picker verwendet wird, öffnet sich der Picker im selben Verzeichnis.

startIn Optional

Ein FileSystemHandle oder ein bekanntes Verzeichnis ("desktop", "documents", "downloads", "music", "pictures", oder "videos") in dem der Dialog geöffnet wird.

suggestedName Optional

Eine String. Der vorgeschlagene Dateiname.

types Optional

Ein Array der erlaubten Dateitypen zum Speichern. Jedes Element ist ein Objekt mit den folgenden Optionen:

description Optional

Eine optionale Beschreibung der Kategorie von erlaubten Dateitypen. Standardmäßig ein leerer String.

accept

Ein Object mit den Schlüsseln für den MIME-Typ und den Werten, einem Array von Dateierweiterungen (siehe unten für ein Beispiel).

Rückgabewert

Ein Promise dessen Erfüllungs-Handler ein FileSystemFileHandle Objekt erhält.

Ausnahmen

AbortError DOMException

Wird ausgelöst, wenn der Benutzer den Dateiauswahldialog schließt, ohne eine Datei auszuwählen oder einzugeben, oder wenn der Benutzeragent eine ausgewählte Datei als zu sensibel oder gefährlich betrachtet.

SecurityError DOMException

Wird ausgelöst, wenn der Aufruf durch die Same-Origin-Policy blockiert wurde oder er nicht durch eine Benutzerinteraktion wie einen Button-Druck vorgenommen wurde.

TypeError

Wird ausgelöst, wenn die akzeptierten Typen nicht verarbeitet werden können, was passieren kann, wenn:

  • Ein beliebiger Schlüssel-String der accept Optionen eines Elements in den types Optionen keinen gültigen MIME-Typ parsen kann.
  • Ein beliebiger Wert-String der accept Optionen eines Elements in den types Optionen ungültig ist, z.B. wenn er nicht mit . beginnt und mit . endet oder wenn er ungültige Codepunkte enthält und seine Länge mehr als 16 beträgt.
  • Die types Optionen leer sind und die excludeAcceptAllOption Optionen true ist.

Sicherheit

Übergangsaktivierung des Benutzers ist erforderlich. Der Benutzer muss mit der Seite oder einem UI-Element interagieren, damit diese Funktion funktioniert.

Beispiele

Die folgende Funktion zeigt einen Dateiauswahldialog, in dem Textdateien zur Auswahl hervorgehoben sind.

js
async function getNewFileHandle() {
  const opts = {
    types: [
      {
        description: "Text file",
        accept: { "text/plain": [".txt"] },
      },
    ],
  };
  return await window.showSaveFilePicker(opts);
}

Spezifikationen

Specification
File System Access
# api-showsavefilepicker

Browser-Kompatibilität

Siehe auch