Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sidlatau/flutter_document_picker
Allows user pick a document. Picked document is copied to app temporary directory. Optionally allows pick document with specific extension only.
https://github.com/sidlatau/flutter_document_picker
dart flutter plugin
Last synced: 4 months ago
JSON representation
Allows user pick a document. Picked document is copied to app temporary directory. Optionally allows pick document with specific extension only.
- Host: GitHub
- URL: https://github.com/sidlatau/flutter_document_picker
- Owner: sidlatau
- License: apache-2.0
- Created: 2018-08-30T12:01:57.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-06-07T20:55:49.000Z (over 1 year ago)
- Last Synced: 2024-10-12T23:10:57.081Z (4 months ago)
- Topics: dart, flutter, plugin
- Language: Kotlin
- Homepage:
- Size: 129 KB
- Stars: 40
- Watchers: 5
- Forks: 26
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# flutter_document_picker
Allows user pick a document. Picked document is copied to app temporary directory. Optionally allows pick document with specific extension only.
When file is picked its extension is checked using `allowedFileExtensions` parameter. Then file is copied to app temp directory. Copied file path is returned as result. If picked file extension is not in `allowedFileExtensions` list then `extension_mismatch` error is returned.
In Android `Intent.ACTION_OPEN_DOCUMENT` is used. This intent is supported only from Android 19 (KitKat) SDK version. So this plugin can be used only if app `minSdkVersion` is 19 or more.
In iOS `UIDocumentPickerViewController` is used. Files can be filtered by list of UTI types using `allowedUtiTypes` parameter. Picked file path is returned as result.
### Params
Plugin has 3 optional parameters to help pick only specific document type:
* `List allowedUtiTypes` (used only in **iOS**)
In iOS Uniform Type Identifiers is used to check document types.
If list is null or empty "public.data" document type will be provided.
Only documents with provided UTI types will be enabled in iOS document picker.
More info:
https://developer.apple.com/library/archive/qa/qa1587/_index.html
* `List allowedFileExtensions` (used both in **iOS** and in **Android**)
List of file extensions that picked file should have.
If list is null or empty - picked document extension will not be checked.
* `List allowedMimeTypes` (used only in **Android**)
Only files with provided MIME types will be shown in document picker.
If list is null or empty - `*/*` MIME type will be used.
* `List invalidFileNameSymbols` (used both in **iOS** and in **Android**)
List symbols that will be sanitized to "`_`" in the selected document name.
I.e. Google Drive allows symbol '/' in the document name, but this symbol is not allowed in file name that will be saved locally.
Default list: `['/']`.
Example: file name 'Report_2018/12/08.txt' will be replaced to 'Report_2018_12_08.txt'
# Example
```dart
//Without parameters:
final path = await FlutterDocumentPicker.openDocument();
...
//With parameters:
FlutterDocumentPickerParams params = FlutterDocumentPickerParams(
allowedFileExtensions: ['mwfbak'],
allowedUtiTypes: ['com.sidlatau.example.mwfbak'],
allowedMimeTypes: ['application/*'],
invalidFileNameSymbols: ['/'],
);
final path = await FlutterDocumentPicker.openDocument(params: params);
//Pick multiple files:
final paths = await FlutterDocumentPicker.openDocuments(params: params);
```