Skip to content

@jakguru/vueprint / @jakguru/vueprint/utilities/files / FilePickerOptions

Interface: FilePickerOptions

@jakguru/vueprint/utilities/files.FilePickerOptions

Describes the shape of the FilePickerOptions object

See

https://developer.mozilla.org/en-US/docs/Web/API/Window/showOpenFilePicker#options

Properties

excludeAcceptAllOption

Optional excludeAcceptAllOption: boolean

A boolean value that defaults to false. By default the picker should include an option to not apply any file type filters (instigated with the type option below). Setting this option to true means that option is not available.

Defined in

src/utilities/files.ts:30


id

Optional id: string

By specifying an ID, the browser can remember different directories for different IDs. If the same ID is used for another picker, the picker opens in the same directory.

Defined in

src/utilities/files.ts:34


multiple

Optional multiple: boolean

A boolean value that defaults to false. When set to true multiple files may be selected.

Defined in

src/utilities/files.ts:38


startIn

Optional startIn: FileSystemHandle | "desktop" | "documents" | "downloads" | "music" | "pictures" | "videos"

A FileSystemHandle or a well known directory ("desktop", "documents", "downloads", "music", "pictures", or "videos") to open the dialog in.

Defined in

src/utilities/files.ts:42


types

Optional types: FilePickerAcceptType[]

An Array of allowed file types to pick. Each item is an object with the following options:

Defined in

src/utilities/files.ts:53

Vueprint is a commercial work product released under the MIT License and is provided as-is with no warranty or guarantee of support.