Window: showSaveFilePicker()-Methode

Syntax

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, um keine Dateitypenfilter anzuwenden (initiiert mit der unten stehenden Typ-Option). Wenn diese Option auf true gesetzt ist, ist diese Option nicht verfügbar.

id Optional

Durch die Angabe einer ID kann der Browser verschiedene Verzeichnisse für unterschiedliche IDs speichern. Wenn die gleiche ID für einen anderen Auswahldialog verwendet wird, öffnet sich der Dialog im gleichen Verzeichnis.

startIn Optional

Ein FileSystemHandle oder ein bekanntes Verzeichnis ("desktop", "documents", "downloads", "music", "pictures" oder "videos") in dem sich das Dialogfenster öffnet.

suggestedName Optional

Ein String. Der vorgeschlagene Dateiname.

types Optional

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

description Optional

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

accept

Ein Object mit den Schlüsseln, die auf den MIME-Typ gesetzt sind, und den Werten, die ein Array von Dateiendungen sind (siehe unten für ein Beispiel).

Rückgabewert

Ein Promise, dessen Fulfillment-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 User Agent ausgewählte Dateien als zu sensibel oder gefährlich einstuft.

SecurityError DOMException

Wird ausgelöst, wenn der Aufruf durch die Same-Origin-Policy blockiert wurde oder nicht durch eine Benutzerinteraktion wie einen Tastendruck erfolgte.

TypeError

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

• Ein beliebiger Schlüsselstring der accept Optionen eines Elements in types keine gültige MIME-Type parsen kann.
• Ein beliebiger Wertstring der accept Optionen eines Elements in types ungültig ist, zum Beispiel, wenn er nicht mit . beginnt und mit . endet, oder wenn er ungültige Zeichen enthält und seine Länge mehr als 16 beträgt.
• Die types Optionen leer sind und die excludeAcceptAllOption Optionen true ist.

Sicherheit

Temporäre Benutzeraktivierung ist erforderlich. Der Benutzer muss mit der Seite oder einem UI-Element interagieren, damit diese Funktion funktioniert.

Beispiele

Die folgende Funktion zeigt einen Dateiauswahldialog an, mit hervorgehobenen Textdateien zur Auswahl.

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

Spezifikationen

Browser-Kompatibilität

Siehe auch

• File System API
• The File System Access API: simplifying access to local files