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.
Plugin has 3 optional parameters to help pick only specific document type:
List<String> 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<String> 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.
allowedMimeType
(used only in Android)
Only files with provided MIME type will be shown in document picker.
If param is null - */*
MIME type will be used.
//Without parameters:
final path = await FlutterDocumentPicker.openDocument();
...
//With parameters:
FlutterDocumentPickerParams params = FlutterDocumentPickerParams(
allowedFileExtensions: ['mwfbak'],
allowedUtiTypes: ['com.sidlatau.example.mwfbak'],
allowedMimeType: 'application/*',
);
final path = await FlutterDocumentPicker.openDocument(params: params);
For help getting started with Flutter, view our online documentation.
For help on editing plugin code, view the documentation.
allowedMimeType
parameter to filter files by MIME type in Android.example/lib/main.dart
import 'package:flutter/material.dart';
import 'package:flutter_document_picker/flutter_document_picker.dart';
void main() => runApp(MyApp());
class MyApp extends StatefulWidget {
@override
_MyAppState createState() => _MyAppState();
}
class _MyAppState extends State<MyApp> {
String _path = '-';
bool _pickFileInProgress = false;
bool _iosPublicDataUTI = true;
bool _checkByCustomExtension = false;
bool _checkByMimeType = false;
final _utiController = TextEditingController(
text: 'com.sidlatau.example.mwfbak',
);
final _extensionController = TextEditingController(
text: 'mwfbak',
);
final _mimeTypeController = TextEditingController(
text: 'application/*',
);
@override
void initState() {
super.initState();
}
@override
Widget build(BuildContext context) {
return MaterialApp(
debugShowCheckedModeBanner: false,
home: Scaffold(
appBar: AppBar(
title: const Text('Plugin example app'),
actions: <Widget>[
IconButton(
icon: Icon(Icons.open_in_new),
onPressed: _pickFileInProgress ? null : _pickDocument,
)
],
),
body: SingleChildScrollView(
child: Padding(
padding: const EdgeInsets.all(16.0),
child: Column(
crossAxisAlignment: CrossAxisAlignment.start,
children: <Widget>[
Text(
'Picked file path:',
style: Theme.of(context).textTheme.title,
),
Text('$_path'),
_pickFileInProgress ? CircularProgressIndicator() : Container(),
_buildCommonParams(),
Theme.of(context).platform == TargetPlatform.iOS
? _buildIOSParams()
: _buildAndroidParams(),
],
),
),
),
),
);
}
_pickDocument() async {
String result;
try {
setState(() {
_path = '-';
_pickFileInProgress = true;
});
FlutterDocumentPickerParams params = FlutterDocumentPickerParams(
allowedFileExtensions: _checkByCustomExtension
? _extensionController.text
.split(' ')
.where((x) => x.isNotEmpty)
.toList()
: null,
allowedUtiTypes: _iosPublicDataUTI
? null
: _utiController.text
.split(' ')
.where((x) => x.isNotEmpty)
.toList(),
allowedMimeType: _checkByMimeType ? _mimeTypeController.text : null,
);
result = await FlutterDocumentPicker.openDocument(params: params);
} catch (e) {
print(e);
result = 'Error: $e';
} finally {
setState(() {
_pickFileInProgress = false;
});
}
setState(() {
_path = result;
});
}
_buildIOSParams() {
return ParamsCard(
title: 'iOS Params',
children: <Widget>[
Text(
'Example app is configured to pick custom document type with extension ".mwfbak"',
style: Theme.of(context).textTheme.body1,
),
Param(
isEnabled: !_iosPublicDataUTI,
description:
'Allow pick all documents("public.data" UTI will be used).',
controller: _utiController,
onEnabledChanged: (value) {
setState(() {
_iosPublicDataUTI = value;
});
},
textLabel: 'Uniform Type Identifier to pick:',
),
],
);
}
_buildAndroidParams() {
return ParamsCard(
title: 'Android Params',
children: <Widget>[
Param(
isEnabled: _checkByMimeType,
description: 'Filter files by MIME type',
controller: _mimeTypeController,
onEnabledChanged: (value) {
setState(() {
_checkByMimeType = value;
});
},
textLabel: 'Allowed MIME type:',
),
],
);
}
_buildCommonParams() {
return ParamsCard(
title: 'Common Params',
children: <Widget>[
Param(
isEnabled: _checkByCustomExtension,
description:
'Check file by extension - if picked file does not have wantent extension - return "extension_mismatch" error',
controller: _extensionController,
onEnabledChanged: (value) {
setState(() {
_checkByCustomExtension = value;
});
},
textLabel: 'File extensions (separated by space):',
),
],
);
}
}
class Param extends StatelessWidget {
final bool isEnabled;
final ValueChanged<bool> onEnabledChanged;
final TextEditingController controller;
final String description;
final String textLabel;
Param({
@required this.isEnabled,
this.onEnabledChanged,
this.controller,
this.description,
this.textLabel,
}) : assert(isEnabled != null),
assert(onEnabledChanged != null),
assert(description != null),
assert(textLabel != null),
assert(controller != null);
@override
Widget build(BuildContext context) {
return Column(
children: <Widget>[
Row(
children: <Widget>[
Expanded(
child: Padding(
padding: const EdgeInsets.only(bottom: 16.0),
child: Text(
description,
softWrap: true,
),
),
),
Checkbox(
value: isEnabled,
onChanged: onEnabledChanged,
),
],
),
TextField(
controller: controller,
enabled: isEnabled,
decoration: InputDecoration(
border: OutlineInputBorder(),
labelText: textLabel,
),
),
],
);
}
}
class ParamsCard extends StatelessWidget {
final String title;
final List<Widget> children;
ParamsCard({
@required this.title,
@required this.children,
}) : assert(title != null),
assert(children != null);
@override
Widget build(BuildContext context) {
return Padding(
padding: EdgeInsets.only(top: 24.0),
child: Card(
child: Padding(
padding: const EdgeInsets.all(16.0),
child: Column(
crossAxisAlignment: CrossAxisAlignment.start,
children: <Widget>[
Padding(
padding: const EdgeInsets.only(bottom: 16.0),
child: Text(
title,
style: Theme.of(context).textTheme.headline,
),
),
]..addAll(children),
),
),
),
);
}
}
Add this to your package's pubspec.yaml file:
dependencies:
flutter_document_picker: ^1.1.2
You can install packages from the command line:
with Flutter:
$ flutter packages get
Alternatively, your editor might support flutter packages get
.
Check the docs for your editor to learn more.
Now in your Dart code, you can use:
import 'package:flutter_document_picker/flutter_document_picker.dart';
Version | Uploaded | Documentation | Archive |
---|---|---|---|
1.4.0 | Jan 22, 2019 |
|
|
1.3.0 | Jan 9, 2019 |
|
|
1.2.0 | Dec 8, 2018 |
|
|
1.1.3 | Oct 19, 2018 |
|
|
1.1.2 | Oct 8, 2018 |
|
|
1.1.1 | Sep 28, 2018 |
|
|
1.1.0 | Sep 22, 2018 |
|
|
1.0.1 | Sep 14, 2018 |
|
|
1.0.0 | Sep 5, 2018 |
|
|
0.1.1 | Sep 5, 2018 |
|
|
Popularity:
Describes how popular the package is relative to other packages.
[more]
|
89
|
Health:
Code health derived from static analysis.
[more]
|
100
|
Maintenance:
Reflects how tidy and up-to-date the package is.
[more]
|
100
|
Overall:
Weighted score of the above.
[more]
|
94
|
We analyzed this package on Feb 14, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:
Detected platforms: Flutter
References Flutter, and has no conflicting libraries.
Package | Constraint | Resolved | Available |
---|---|---|---|
Direct dependencies | |||
Dart SDK | >=2.0.0-dev.68.0 <3.0.0 | ||
flutter | 0.0.0 | ||
Transitive dependencies | |||
collection | 1.14.11 | ||
meta | 1.1.6 | 1.1.7 | |
sky_engine | 0.0.99 | ||
typed_data | 1.1.6 | ||
vector_math | 2.0.8 |