dir_picker 0.2.1

dir_picker: ^0.2.1 copied to clipboard

dir_picker #

A Flutter plugin for picking a directory across all platforms using native system dialogs. Returns a Uri? — null if the user cancelled.

Features #

• 📁 All Platforms – Android, iOS, macOS, Windows, Linux, and Web
• ⚡ Native Performance – Powered by FFI (iOS/macOS/Windows) and JNI (Android) for near-zero overhead
• 🎨 Customizable Dialogs – Platform-specific options for title, button labels, and more
• 🔗 Persistent Permissions – Android SAF persistent URI access across reboots
• 🐧 Linux Portals – XDG Desktop Portal with zenity/kdialog fallback

If you want to say thank you, star us on GitHub or like us on pub.dev.

Installation #

First, follow the package installation instructions and add dir_picker to your app.

Quick Start #

Platform Setup #

<key>com.apple.security.files.user-selected.read-write</key>
<true/>

# GNOME
sudo apt install zenity

# KDE
sudo apt install kdialog

Basic Usage #

import 'package:dir_picker/dir_picker.dart';

final Uri? uri = await DirPicker.pick();

if (uri != null) {
  print('Selected: $uri');
} else {
  print('Cancelled');
}

Platform Options #

Each platform exposes its own options class for customizing the dialog. Pass them to DirPicker.pick():

final uri = await DirPicker.pick(
  androidOptions: const AndroidOptions(shouldPersist: true),
  macosOptions: const MacosOptions(acceptLabel: 'Choose', message: 'Select a project folder'),
  linuxOptions: const LinuxOptions(title: 'Select Folder', acceptLabel: 'Choose'),
  windowsOptions: const WindowsOptions(title: 'Select Folder', acceptLabel: 'Choose'),
);

AndroidOptions #

MacosOptions #

LinuxOptions #

WindowsOptions #

Core Concepts #

Return value #

Native Mechanisms #

Common Use Cases #

Simple directory pick #

final uri = await DirPicker.pick();
if (uri != null) {
  print('Selected: $uri');
}

Custom dialog labels #

final uri = await DirPicker.pick(
  macosOptions: const MacosOptions(
    acceptLabel: 'Use This Folder',
    message: 'Select the folder to import from',
  ),
  linuxOptions: const LinuxOptions(
    title: 'Import Folder',
    acceptLabel: 'Use This Folder',
  ),
  windowsOptions: const WindowsOptions(
    title: 'Import Folder',
    acceptLabel: 'Use This Folder',
  ),
);

Android — enable persistent permission #

final uri = await DirPicker.pick(
  androidOptions: const AndroidOptions(shouldPersist: true),
);

API Reference #

DirPicker.pick #

static Future<Uri?> pick({
  AndroidOptions? androidOptions,
  LinuxOptions? linuxOptions,
  MacosOptions? macosOptions,
  WindowsOptions? windowsOptions,
})

Returns the selected directory as a Uri, or null if the user cancelled.

Platform Support #

Minimum versions:

• Flutter ≥ 3.3.0
• Dart SDK ≥ 3.6.0
• Kotlin 2.1.0
• Swift 5.9
• Android API 21+
• iOS 13.0+
• macOS 10.15+
• Windows 10+
• Web: Chrome/Edge 86+

Contributing #

Contributions are welcome! Please feel free to submit a Pull Request.

License #

MIT License — see LICENSE file for details.