File Manager

FileManager is a wonderful widget that allows you to manage files and folders, pick files and folders, and do a lot more. Designed to feel like part of the Flutter framework.

Compatibility

✅   Android ✅   Linux ❌   Windows (in progress) ❌   MacOS (active issue: MacOS support)

Usage

Make sure to check out examples for more details.

Installation

Dependencies Add the following line to pubspec.yaml:

dependencies:
  file_manager: ^1.0.0

Give storage permission to application

Android

Beside needing to add WRITE_EXTERNAL_STORAGE , READ_EXTERNAL_STORAGE and MANAGE_EXTERNAL_STORAGE to your android/app/src/main/AndroidManifest.xml.

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.xxx.yyy">
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
    <uses-permission android:name="android.permission.MANAGE_EXTERNAL_STORAGE" />

...
</manifest>

also add for Android 10

    <application
      android:requestLegacyExternalStorage="true"   
      .../>

You also need Runtime Request Permission allow storage permission from app setting manually or you may use any package such as permission_handler.

or use FileManager to request permission at runtime.

  // request permission
  await FileManager.requestFilesAccessPermission();

Basic setup

The complete example is available here.

Required parameter for FileManager are controller and builder

• controller The controller updates value and notifies its listeners, and FileManager updates itself appropriately whenever the user modifies the path or changes the sort-type with an associated FileManagerController.

final FileManagerController controller = FileManagerController();

• builder This function allows you to create custom widgets and retrieve a list of entities List<FileSystemEntity>.

Sample code

FileManager(
    controller: controller,
    builder: (context, snapshot) {
    final List<FileSystemEntity> entities = snapshot;
      return ListView.builder(
        itemCount: entities.length,
        itemBuilder: (context, index) {
          return Card(
            child: ListTile(
              leading: FileManager.isFile(entities[index])
                  ? Icon(Icons.feed_outlined)
                  : Icon(Icons.folder),
              title: Text(FileManager.basename(entities[index])),
              onTap: () {
                if (FileManager.isDirectory(entities[index])) {
                    controller.openDirectory(entities[index]);   // open directory
                  } else {
                      // Perform file-related tasks.
                  }
              },
            ),
          );
        },
      );
  },
),

FileManager

FileManagerController

ControlBackButton

When the current directory is not root, this widget registers a callback to prevent the user from dismissing the window, or controllers the system's back button

ie:-

  // Wrap Scaffold containing FileManage with ControlBackButton
  ControlBackButton(
    controller: controller
    child: Scaffold(
      appBar: AppBar(...)
      body: FileManager(
        ...
      )
    )
  )

Others

Show some :heart: and :star: the repo

Project Created & Maintained By

• DevsOnFlutter

Contributions

Contributions are welcomed!

If you feel that a hook is missing, feel free to open a pull-request.

For a custom-hook to be merged, you will need to do the following:

• Describe the use-case.

• Open an issue explaining why we need this hook, how to use it, ... This is important as a hook will not get merged if the hook doesn't appeal to a large number of people.

• If your hook is rejected, don't worry! A rejection doesn't mean that it won't be merged later in the future if more people shows an interest in it. In the mean-time, feel free to publish your hook as a package on https://pub.dev.

• A hook will not be merged unless fully tested, to avoid breaking it inadvertently in the future.