Window: showOpenFilePicker() Methode

Syntax

showOpenFilePicker()
showOpenFilePicker(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 Picker eine Option beinhalten, um keine Dateitypfilter anzuwenden (ausgelöst mit der unten genannten Typ-Option). Wenn diese Option auf true gesetzt wird, ist diese Option nicht verfügbar.

id Optional

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

multiple Optional

Ein boolescher Wert, der standardmäßig auf false gesetzt ist. Wenn auf true gesetzt, können mehrere Dateien ausgewählt werden.

startIn Optional

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

types Optional

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

description Optional

Eine optionale Beschreibung der Kategorie der erlaubten Dateitypen. Standardwert ist ein leerer String.

accept

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

Rückgabewert

Ein Promise, dessen Fulfillment-Handler ein Array von FileSystemFileHandle-Objekten erhält.

Ausnahmen

AbortError DOMException

Wird ausgelöst, wenn der Benutzer die Eingabeaufforderung ohne Auswahl abbricht oder wenn der User-Agent feststellt, dass ausgewählte Dateien zu sensibel oder gefährlich sind.

SecurityError DOMException

Wird ausgelöst, wenn der Aufruf durch die Same-Origin-Policy blockiert wurde oder nicht durch eine Benutzerinteraktion wie das Drücken eines Buttons erfolgt ist.

TypeError

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

• Ein Schlüsselstring der accept-Optionen eines Elements in den types-Optionen keinen gültigen MIME-Typ parsen kann.
• Ein Wertstring der accept-Optionen eines Elements in den types-Optionen ungültig ist, zum Beispiel, 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 sind.

Sicherheit

Vorübergehende Benutzeraktivierung ist erforderlich. Der Benutzer muss mit der Seite oder einem UI-Element interagieren, damit diese Funktion funktioniert.

Beispiele

Hier setzen wir das Optionsobjekt für den Aufruf der Methode. Wir erlauben die Auswahl von Bilddateitypen, ohne Option, alle Dateitypen zuzulassen oder mehrere Dateien auszuwählen.

const pickerOpts = {
  types: [
    {
      description: "Images",
      accept: {
        "image/*": [".png", ".gif", ".jpeg", ".jpg"],
      },
    },
  ],
  excludeAcceptAllOption: true,
  multiple: false,
};

Als Nächstes können wir eine asynchrone Funktion erstellen, die den Dateiauswahldialog anzeigt und die ausgewählte Datei zurückgibt.

// create a reference for our file handle
let fileHandle;

async function getFile() {
  // open file picker, destructure the one element returned array
  [fileHandle] = await window.showOpenFilePicker(pickerOpts);

  // run code with our fileHandle
}

Spezifikationen

Browser-Kompatibilität

Siehe auch

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