openfilesdialog Asynchronous
Ask the user to select several files at once. Each selected file comes back as its own Document handle for a batch import.
Luau
openfilesdialog(options: FileDialogOptions?) -> {Document}?Parameters
| Parameter | Type | Description |
|---|---|---|
options | FileDialogOptions? | Optional FileDialogOptions table; use its named fields to guide the system picker. |
Argument fields
Luau
FileDialogOptions = {
defaultPath: string?, title: string?, extensionFilter: {string}?,
suggestedName: string?, defaultExtension: string?
}| Field | Description |
|---|---|
defaultPath | Initial picker location. The Android picker uses this only when it is a content:// URI. |
title | Optional chooser title for open dialogs. It is not used as the save filename. |
extensionFilter | Array of extensions, such as {"txt", "json"}. Known extensions are converted to MIME filters; unknown-only filters allow all types. Folder dialogs do not use this filter. |
suggestedName | Suggested filename for savefiledialog. Defaults to untitled when omitted or empty. |
defaultExtension | Extension appended to the suggested save filename when it does not already have that extension. Leading dots are removed. |
Returns
{Document}?An array of Documents, or nil if the picker is cancelled.
Usage notes
A Document is a handle to the user-selected location, not a workspace path. Call methods with a colon and keep the handle for later operations.
A non-nil array may still be empty; iterate the returned values rather than assuming a selection count.
Example
Luau
local documents = openfilesdialog({ title = "Choose files to import" })
if documents then
for _, document in ipairs(documents) do
print(document:GetName(), #document:Read(), "bytes")
end
end