File Picker

https://pub.dev/packages/file_picker
Admin
A Flutter package that allows you to use the native file explorer to pick single or multiple files,...
Tokens:1,374
Snippets:26
Trust Score:9.9
Update:3 months ago
Show doc for...
Tokens:
Raw
### Initialize File Picker Demo

Source: https://pub.dev/packages/file_picker/example

Entry point for the file picker example application.

```dart
import 'package:file_picker_example/src/file_picker_demo.dart';
import 'package:flutter/widgets.dart';

void main() => runApp(FilePickerDemo());
```

--------------------------------

### Install file_picker package

Source: https://pub.dev/packages/file_picker

Add the dependency to your pubspec.yaml file.

```yaml
file_picker: ^11.0.2
```

--------------------------------

### Pick a directory

Source: https://pub.dev/packages/file_picker

Use this to select a directory path instead of a file.

```dart
String? selectedDirectory = await FilePicker.getDirectoryPath();

if (selectedDirectory == null) {
  // User canceled the picker
}
```

--------------------------------

### Pick multiple files

Source: https://pub.dev/packages/file_picker

Set allowMultiple to true to enable selecting more than one file.

```dart
FilePickerResult? result = await FilePicker.pickFiles(allowMultiple: true);

if (result != null) {
  List<File> files = result.paths.map((path) => File(path!)).toList();
} else {
  // User canceled the picker
}
```

--------------------------------

### Import the package

Source: https://pub.dev/packages/file_picker/install

Include this import statement at the top of your Dart files to access the file_picker functionality.

```dart
import 'package:file_picker/file_picker.dart';
```

--------------------------------

### Retrieve files as XFiles

Source: https://pub.dev/packages/file_picker

Convert picked files to XFile objects for cross-platform compatibility.

```dart
FilePickerResult? result = await FilePicker.pickFiles();

if (result != null) {
  // All files
  List<XFile> xFiles = result.xFiles;

  // Individually
  XFile xFile = result.files.first.xFile;
} else {
  // User canceled the picker
}
```

--------------------------------

### Pick a single file

Source: https://pub.dev/packages/file_picker

Use this to select one file from the native file explorer.

```dart
FilePickerResult? result = await FilePicker.pickFiles();

if (result != null) {
  File file = File(result.files.single.path!);
} else {
  // User canceled the picker
}
```

--------------------------------

### Add dependency via command line

Source: https://pub.dev/packages/file_picker/install

Use this command in your terminal to automatically add the latest version of file_picker to your project.

```bash
$ flutter pub add file_picker
```

--------------------------------

### Load result and file details

Source: https://pub.dev/packages/file_picker

Access metadata such as file name, size, extension, and raw bytes.

```dart
FilePickerResult? result = await FilePicker.pickFiles();

if (result != null) {
  PlatformFile file = result.files.first;

  print(file.name);
  print(file.bytes);
  print(file.size);
  print(file.extension);
  print(file.path);
} else {
  // User canceled the picker
}
```

--------------------------------

### Pick multiple files with extension filter

Source: https://pub.dev/packages/file_picker

Restrict file selection to specific extensions using FileType.custom.

```dart
FilePickerResult? result = await FilePicker.pickFiles(
  allowMultiple: true,
  type: FileType.custom,
  allowedExtensions: ['jpg', 'pdf', 'doc'],
);
```

--------------------------------

### Save-file dialog

Source: https://pub.dev/packages/file_picker

Open a dialog to let the user specify a location and name for saving a file.

```dart
String? outputFile = await FilePicker.saveFile(
  dialogTitle: 'Please select an output file:',
  fileName: 'output-file.pdf',
);

if (outputFile == null) {
  // User canceled the picker
}
```

--------------------------------

### Add dependency to pubspec.yaml

Source: https://pub.dev/packages/file_picker/install

Manually add this line to the dependencies section of your pubspec.yaml file.

```yaml
dependencies:
  file_picker: ^11.0.2
```

--------------------------------

### Upload file to Firebase Storage

Source: https://pub.dev/packages/file_picker

Demonstrates using file bytes to upload a picked file to Firebase Storage on Flutter Web.

```dart
FilePickerResult? result = await FilePicker.pickFiles();

if (result != null) {
  Uint8List fileBytes = result.files.first.bytes;
  String fileName = result.files.first.name;
  
  // Upload file
  await FirebaseStorage.instance.ref('uploads/$fileName').putData(fileBytes);
}
```
Tokens:
Raw