File picker and bookmarks API #8303

maxkatz6 · 2022-06-08T06:52:35Z

What does the pull request do?

Initial implementation of new file picker API.
API layer was also inspired by HTML5 browser File API and naming from UWP.
Xamarin Essentials, Qt, Electron and react-native-document-picker were used as a reference for implementation (aside from native API docs).

Current progress:

Open/save file and open folder dialogs API
Bookmark API (without required additions for WASM)
Implementation for main desktop OSes - win, osx, lin
iOS and Android implementation
Update managed file dialog to work with new interfaces
Folder picker support for Android.
FileAPI Browser support
Finalize the API and set it in stone

Out of this PR, but to be done in this release:

Fallback browser support with a ponyfil
macOS sandbox safe bookmarks implementation ([OSX] App Store Sandbox Bookmarks API #6540)
Export API. Or Share API, naming? I would prefer to keep it minimal. Required for iOS and WASM support, as there is no "Save" pickers (except newest new File API).

Potentially in the future:

StorageFile file type

Usage:

var folder = await window.StorageProvider.OpenFolderPickerAsync(new FolderPickerOpenOptions());
var openedFile = await window.StorageProvider.OpenFilePickerAsync(new FilePickerOpenOptions()
{
    SuggestedStartLocation = folder
});

// Open file to write.
var stream = await openedFile.OpenWrite();

// To save in local database.
var bookmarkId = openedFile.SaveBookmark();

var file = await window.StorageProvider.OpenFileBookmarkAsync(bookmarkId);

// Uri as it can be "file:" or "content:" or relative link depending on the platform. Following Qt API.
if (file.TryGetUri(out var uri) && uri.IsAbsoluteUri)
{
    var absolutePath = uri.LocalPath;
}

Checklist

Added unit tests (if possible)?
Added XML documentation to any related classes?
Consider submitting a PR to https://github.com/AvaloniaUI/Documentation with user documentation

Breaking changes

None

Obsoletions / Deprecations

SystemDialog and OpenFileDialog/SaveFileDialog/OpenFolderDialog are obsolete now.

Fixed issues

Fixes #7234
Fixes #7209

Questions

Q: Should I rename topLevel.StorageProvider to topLevel.FilePicker with related interface names? Or FileSystem? Or FileManager to match other *Manager classes.
Q: Should API be change in order to allow opening dialogs without window/toplevel at all? It's possible only on desktop.
Q: Replace bool properties with enum flags?

avaloniaui-team · 2022-06-08T07:38:28Z

You can test this PR using the following package version. 0.10.999-cibuild0021086-beta. (feed url: https://nuget.avaloniaui.net/repository/avalonia-all/index.json) [PRBUILDID]

robloo · 2022-06-08T16:48:10Z

Nice!

Symbai · 2022-06-12T07:34:39Z

Does it finally support multi folder selection? #7209

maxkatz6 · 2022-06-12T14:55:28Z

No. Main goal to have mobile/wasm compatible API.

Symbai · 2022-06-13T00:36:44Z

If you rewrite the whole API and obsolete existing API, wouldn't it make sense to look at existing issues and make sure they don't exist in the new one too? When, if not now, is the best chance for that?

maxkatz6 · 2022-06-13T00:46:03Z

I don't think I have seen anywhere multi-folder picker API in xplat frameworks. And overall usefulness seems low.
But I will look which platforms actually support it. If it's more than one or two, than it's possible to do now.

Symbai · 2022-06-13T01:10:31Z

No idea what xplat frameworks is. But multi folder picker is a common thing on Windows and MacOS and Linux (basically all desktop environments). Winforms support it therefore also WPF. WinUI currently seem to not support it, because it comes from UWP which also hasn't supported it but it was also requested. For mobile it might not make much sense but I have never used a mobile app that asked me to select a folder at all, because working with folders on mobile devices is quite uncommon.

timunie · 2022-06-13T17:57:44Z

I really think we will need some docs how to handle this once it is ready. What do you think @maxkatz6 ?

maxkatz6 · 2022-06-19T04:49:38Z

Demo of file picker with bookmarks (reusing same file without opening picker again).
Currently uses HTML5 File API, which is available only in Chromium browsers. Fallback for older browsers is planned for the next PR. Unfortunately, bookmarks will work only and only with File API impl, and fallback will require service worker as well.

1.mp4

maxkatz6 · 2022-06-19T04:52:12Z

This PR can now be tested, if anybody wants to try.

I have to update macOS implementation to support file types. And test macos/ios once more.
And probably I can try to make "default name with extension" behavior more consistent across platforms in this PR. Somewhere extension is appended automatically, somewhere it's not.

avaloniaui-team · 2022-06-19T05:09:02Z

You can test this PR using the following package version. 0.10.999-cibuild0021227-beta. (feed url: https://nuget.avaloniaui.net/repository/avalonia-all/index.json) [PRBUILDID]

avaloniaui-team · 2022-06-22T07:15:52Z

You can test this PR using the following package version. 0.10.999-cibuild0021285-beta. (feed url: https://nuget.avaloniaui.net/repository/avalonia-all/index.json) [PRBUILDID]

maxkatz6 · 2022-06-24T05:14:51Z

samples/ControlCatalog/Pages/NumericUpDownPage.xaml

@@ -76,21 +76,21 @@
      <StackPanel Orientation="Vertical" Margin="10">
        <Label Target="upDown" FontSize="14" FontWeight="Bold" VerticalAlignment="Center">Usage of decimal NumericUpDown:</Label>
        <NumericUpDown Name="upDown" Minimum="0" Maximum="10" Increment="0.5"
-                       CultureInfo="en-US" VerticalAlignment="Center" Value="{Binding DecimalValue}"


Removed default culture info, as it was crashing control catalog in the browser.

avaloniaui-team · 2022-06-24T05:25:33Z

You can test this PR using the following package version. 0.10.999-cibuild0021348-beta. (feed url: https://nuget.avaloniaui.net/repository/avalonia-all/index.json) [PRBUILDID]

avaloniaui-team · 2022-07-04T13:07:32Z

You can test this PR using the following package version. 0.10.999-cibuild0021548-beta. (feed url: https://nuget.avaloniaui.net/repository/avalonia-all/index.json) [PRBUILDID]

grokys · 2022-07-04T13:19:15Z

Q: Should I rename topLevel.StorageProvider to topLevel.FilePicker with related interface names? Or FileSystem? Or FileManager to match other *Manager classes.

From what I understand, this API will also be used later to provide access to e.g. a Share dialog, which isn't a "file picker" or related to the "file system", so StorageProvider makes sense to me here.

avaloniaui-team · 2022-07-05T16:40:07Z

You can test this PR using the following package version. 0.10.999-cibuild0021619-beta. (feed url: https://nuget.avaloniaui.net/repository/avalonia-all/index.json) [PRBUILDID]

kekekeks · 2022-07-05T17:18:17Z

src/Avalonia.Base/Platform/Storage/FilePickerSaveOptions.cs

+    /// <summary>
+    /// Gets or sets the file name that the file save picker suggests to the user.
+    /// </summary>
+    public string? SuggestedFileName { get; set; }


I think it's valid for both save and open dialogs

For "open" dialog it should be "SelectedFile" or something of IStorageFile type. We can add it later on top of that api.

kekekeks · 2022-07-05T17:18:45Z

src/Avalonia.Base/Platform/Storage/FilePickerSaveOptions.cs

+    /// <summary>
+    /// Gets or sets the initial location where the file open picker looks for files to present to the user.
+    /// </summary>
+    public IStorageFolder? SuggestedStartLocation { get; set; }


Could we move Title and SuggestedStartLocation to a common base class?

avaloniaui-team · 2022-07-05T23:22:53Z

You can test this PR using the following package version. 0.10.999-cibuild0021621-beta. (feed url: https://nuget.avaloniaui.net/repository/avalonia-all/index.json) [PRBUILDID]

maxkatz6 added feature os-macos os-linux os-windows os-ios os-android labels Jun 8, 2022

maxkatz6 force-pushed the file-picker branch from b9005c2 to a508adb Compare June 8, 2022 07:03

maxkatz6 force-pushed the file-picker branch from a508adb to 3e02b2f Compare June 12, 2022 05:06

maxkatz6 force-pushed the file-picker branch from 3e02b2f to cb9e10f Compare June 19, 2022 04:47

maxkatz6 mentioned this pull request Jun 21, 2022

Missing FileDialog filter options #2949

Closed

maxkatz6 added 8 commits June 24, 2022 00:59

Add file picker interface definitions

0289a51

Update headless implementations, managed and samples

e717cce

Update Windows implementations

3dac396

Update macOS implementations with some UTType support

06e141b

Update GTK and FreeDesktop implementations

eacd679

Add iOS implementation

3ddd068

Add android implementation

eb403ea

Add Browser implementation

347a36e

maxkatz6 force-pushed the file-picker branch from a1ef467 to 347a36e Compare June 24, 2022 05:05

maxkatz6 changed the title ~~[WIP] File picker API~~ File picker API Jun 24, 2022

maxkatz6 changed the title ~~File picker API~~ File picker and bookmarks API Jun 24, 2022

maxkatz6 marked this pull request as ready for review June 24, 2022 05:08

maxkatz6 requested review from kekekeks and a team June 24, 2022 05:08

maxkatz6 commented Jun 24, 2022

View reviewed changes

maxkatz6 requested a review from danwalmsley June 24, 2022 05:16

Merge branch 'master' into file-picker

69decc1

Merge branch 'master' into file-picker

8fea718

kekekeks approved these changes Jul 5, 2022

View reviewed changes

Add base PickerOptions + some formatting

daa071e

maxkatz6 enabled auto-merge July 5, 2022 22:54

maxkatz6 merged commit 4a2b731 into master Jul 5, 2022

maxkatz6 deleted the file-picker branch July 5, 2022 23:15

jeffward01 mentioned this pull request Dec 10, 2022

Allow to add multiple folders to be searched/excluded 0x90d/videoduplicatefinder#255

Closed

maxkatz6 mentioned this pull request Sep 4, 2023

Onboarding process #12756

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

File picker and bookmarks API #8303

File picker and bookmarks API #8303

maxkatz6 commented Jun 8, 2022 •

edited

Loading

avaloniaui-team commented Jun 8, 2022

robloo commented Jun 8, 2022

Symbai commented Jun 12, 2022

maxkatz6 commented Jun 12, 2022 •

edited

Loading

Symbai commented Jun 13, 2022

maxkatz6 commented Jun 13, 2022

Symbai commented Jun 13, 2022

timunie commented Jun 13, 2022

maxkatz6 commented Jun 19, 2022 •

edited

Loading

maxkatz6 commented Jun 19, 2022

avaloniaui-team commented Jun 19, 2022

avaloniaui-team commented Jun 22, 2022

maxkatz6 Jun 24, 2022

avaloniaui-team commented Jun 24, 2022

avaloniaui-team commented Jul 4, 2022

grokys commented Jul 4, 2022

avaloniaui-team commented Jul 5, 2022

kekekeks Jul 5, 2022

maxkatz6 Jul 5, 2022

kekekeks Jul 5, 2022

maxkatz6 Jul 5, 2022

avaloniaui-team commented Jul 5, 2022

File picker and bookmarks API #8303

File picker and bookmarks API #8303

Conversation

maxkatz6 commented Jun 8, 2022 • edited Loading

What does the pull request do?

Checklist

Breaking changes

Obsoletions / Deprecations

Fixed issues

Questions

avaloniaui-team commented Jun 8, 2022

robloo commented Jun 8, 2022

Symbai commented Jun 12, 2022

maxkatz6 commented Jun 12, 2022 • edited Loading

Symbai commented Jun 13, 2022

maxkatz6 commented Jun 13, 2022

Symbai commented Jun 13, 2022

timunie commented Jun 13, 2022

maxkatz6 commented Jun 19, 2022 • edited Loading

maxkatz6 commented Jun 19, 2022

avaloniaui-team commented Jun 19, 2022

avaloniaui-team commented Jun 22, 2022

maxkatz6 Jun 24, 2022

Choose a reason for hiding this comment

avaloniaui-team commented Jun 24, 2022

avaloniaui-team commented Jul 4, 2022

grokys commented Jul 4, 2022

avaloniaui-team commented Jul 5, 2022

kekekeks Jul 5, 2022

Choose a reason for hiding this comment

maxkatz6 Jul 5, 2022

Choose a reason for hiding this comment

kekekeks Jul 5, 2022

Choose a reason for hiding this comment

maxkatz6 Jul 5, 2022

Choose a reason for hiding this comment

avaloniaui-team commented Jul 5, 2022

maxkatz6 commented Jun 8, 2022 •

edited

Loading

maxkatz6 commented Jun 12, 2022 •

edited

Loading

maxkatz6 commented Jun 19, 2022 •

edited

Loading