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 Auswahl einer vorhandenen Datei oder durch Eingabe eines Namens für eine neue Datei.
Syntax
showSaveFilePicker()
showSaveFilePicker(options)
Parameter
optionsOptional-
Ein Objekt, das Optionen enthält, die wie folgt sind:
excludeAcceptAllOptionOptional-
Ein Boolescher Wert, der standardmäßig auf
falsegesetzt ist. Standardmäßig sollte der Picker eine Option enthalten, um keine Dateitypenfilter anzuwenden (ausgelöst durch die untenstehende Typoption). Wenn diese Option auftruegesetzt wird, ist diese Option nicht verfügbar. idOptional-
Durch die Angabe einer ID kann sich der Browser verschiedene Verzeichnisse für verschiedene IDs merken. Wenn dieselbe ID für einen anderen Picker verwendet wird, öffnet sich der Picker im selben Verzeichnis.
startInOptional-
Ein
FileSystemHandleoder ein bekanntes Verzeichnis ("desktop","documents","downloads","music","pictures"oder"videos") um den Dialog darin zu öffnen. suggestedNameOptional-
Ein
String. Der vorgeschlagene Dateiname. typesOptional-
Ein
Arrayder erlaubten Dateitypen zum Speichern. Jedes Element ist ein Objekt mit den folgenden Optionen:descriptionOptional-
Eine optionale Beschreibung der Kategorie der erlaubten Dateitypen. Standardwert ist ein leerer String.
accept-
Ein
Objectmit den Schlüsseln, die auf den MIME-Typen eingestellt sind, und den Werten, die einArrayvon Dateierweiterungen sind (siehe unten für ein Beispiel).
Rückgabewert
Ein Promise, dessen Erfüllungshandler ein FileSystemFileHandle-Objekt erhält.
Ausnahmen
AbortErrorDOMException-
Wird ausgelöst, wenn der Benutzer den Dateiauswahldialog ohne Auswahl oder Eingabe einer Datei schließt oder wenn der Benutzeragent eine ausgewählte Datei als zu sensibel oder gefährlich einstuft.
SecurityErrorDOMException-
Wird ausgelöst, wenn der Aufruf durch die Same-Origin-Policy blockiert wurde oder wenn er nicht durch eine Benutzerinteraktion wie einen Tastendruck ausgelöst wurde.
TypeError-
Wird ausgelöst, wenn Akzeptanztypen nicht verarbeitet werden können, was passieren kann, wenn:
- Ein Schlüsselstring der
accept-Optionen eines Elements in dentypes-Optionen keinen gültigen MIME-Typ parsen kann. - Ein Wertstring der
accept-Optionen eines Elements in dentypes-Optionen ungültig ist, zum Beispiel, wenn er nicht mit.beginnt, mit.endet oder ungültige Codepunkte enthält und seine Länge mehr als 16 ist. - Die
types-Optionen leer sind und dieexcludeAcceptAllOption-Optionentruesind.
- Ein Schlüsselstring der
Sicherheit
Eine vorübergehende Benutzerauslösung ist erforderlich. Der Benutzer muss mit der Seite oder einem UI-Element interagieren, damit diese Funktion funktioniert.
Beispiele
Die folgende Funktion zeigt einen Dateiauswahldialog, wobei Textdateien zur Auswahl hervorgehoben sind.
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> |