A Flutter plugin for finding commonly used locations on the filesystem. Supports iOS and Android.
To use this plugin, add path_provider
as a dependency in your pubspec.yaml file.
Directory tempDir = await getTemporaryDirectory();
String tempPath = tempDir.path;
Directory appDocDir = await getApplicationDocumentsDirectory();
String appDocPath = appDocDir.path;
Please see the example app of this plugin for a full example.
example/lib/main.dart
// Copyright 2017 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
import 'dart:async';
import 'dart:io';
import 'package:flutter/material.dart';
import 'package:path_provider/path_provider.dart';
void main() {
runApp(new MyApp());
}
class MyApp extends StatelessWidget {
@override
Widget build(BuildContext context) {
return new MaterialApp(
title: 'Path Provider',
theme: new ThemeData(
primarySwatch: Colors.blue,
),
home: new MyHomePage(title: 'Path Provider'),
);
}
}
class MyHomePage extends StatefulWidget {
MyHomePage({Key key, this.title}) : super(key: key);
final String title;
@override
_MyHomePageState createState() => new _MyHomePageState();
}
class _MyHomePageState extends State<MyHomePage> {
Future<Directory> _tempDirectory;
Future<Directory> _appDocumentsDirectory;
Future<Directory> _externalDocumentsDirectory;
void _requestTempDirectory() {
setState(() {
_tempDirectory = getTemporaryDirectory();
});
}
Widget _buildDirectory(
BuildContext context, AsyncSnapshot<Directory> snapshot) {
Text text = const Text('');
if (snapshot.connectionState == ConnectionState.done) {
if (snapshot.hasError) {
text = new Text('Error: ${snapshot.error}');
} else if (snapshot.hasData) {
text = new Text('path: ${snapshot.data.path}');
} else {
text = const Text('path unavailable');
}
}
return new Padding(padding: const EdgeInsets.all(16.0), child: text);
}
void _requestAppDocumentsDirectory() {
setState(() {
_appDocumentsDirectory = getApplicationDocumentsDirectory();
});
}
void _requestExternalStorageDirectory() {
setState(() {
_externalDocumentsDirectory = getExternalStorageDirectory();
});
}
@override
Widget build(BuildContext context) {
return new Scaffold(
appBar: new AppBar(
title: new Text(widget.title),
),
body: new Center(
child: new Column(
mainAxisAlignment: MainAxisAlignment.spaceEvenly,
children: <Widget>[
new Column(
children: <Widget>[
new Padding(
padding: const EdgeInsets.all(16.0),
child: new RaisedButton(
child: const Text('Get Temporary Directory'),
onPressed: _requestTempDirectory,
),
),
],
),
new Expanded(
child: new FutureBuilder<Directory>(
future: _tempDirectory, builder: _buildDirectory),
),
new Column(
children: <Widget>[
new Padding(
padding: const EdgeInsets.all(16.0),
child: new RaisedButton(
child: const Text('Get Application Documents Directory'),
onPressed: _requestAppDocumentsDirectory,
),
),
],
),
new Expanded(
child: new FutureBuilder<Directory>(
future: _appDocumentsDirectory, builder: _buildDirectory),
),
new Column(children: <Widget>[
new Padding(
padding: const EdgeInsets.all(16.0),
child: new RaisedButton(
child: new Text('${Platform.isIOS ?
"External directories are unavailable "
"on iOS":
"Get External Storage Directory" }'),
onPressed:
Platform.isIOS ? null : _requestExternalStorageDirectory,
),
),
]),
new Expanded(
child: new FutureBuilder<Directory>(
future: _externalDocumentsDirectory,
builder: _buildDirectory),
),
],
),
),
);
}
}
Add this to your package's pubspec.yaml file:
dependencies:
path_provider: ^0.2.2
You can install packages from the command line:
with pub:
$ pub get
with Flutter:
$ flutter packages get
Alternatively, your editor might support pub get
or flutter packages get
.
Check the docs for your editor to learn more.
Now in your Dart code, you can use:
import 'package:path_provider/path_provider.dart';
Version | Uploaded | Documentation | Archive |
---|---|---|---|
0.5.0+1 | Feb 8, 2019 |
|
|
0.5.0 | Jan 24, 2019 |
|
|
0.4.1 | Jun 1, 2018 |
|
|
0.4.0 | Mar 9, 2018 |
|
|
0.3.1 | Jan 12, 2018 |
|
|
0.3.0 | Dec 20, 2017 |
|
|
0.2.2 | Dec 4, 2017 |
|
|
0.2.1+1 | May 17, 2017 |
|
|
0.2.0 | May 10, 2017 |
|
|
0.1.3 | May 9, 2017 |
|
|
Popularity:
Describes how popular the package is relative to other packages.
[more]
|
100
|
Health:
Code health derived from static analysis.
[more]
|
--
|
Maintenance:
Reflects how tidy and up-to-date the package is.
[more]
|
--
|
Overall:
Weighted score of the above.
[more]
|
50
|
The package version is not analyzed, because it does not support Dart 2. Until this is resolved, the package will receive a health and maintenance score of 0.
Support Dart 2 in pubspec.yaml
.
The SDK constraint in pubspec.yaml
doesn't allow the Dart 2.0.0 release. For information about upgrading it to be Dart 2 compatible, please see https://www.dartlang.org/dart-2#migration.
Make sure dartdoc
successfully runs on your package's source files. (-10 points)
Dependencies were not resolved.
Package | Constraint | Resolved | Available |
---|---|---|---|
Direct dependencies | |||
Dart SDK | >=1.8.0 <2.0.0 |