pickFile function

Future<List<ThemedFile>?> pickFile({ String? pickDialogTitle, LayrzAppLocalizations? i18n, FileType type = FileType.any, List<String>? allowedExtensions, bool allowMultiple = false, })

pickFile is a helper function to pick a file from the device.

This function is only for native implementations, that is, Android, iOS, Windows, and macOS. To implement this function multiplatform, follow this example

import 'package:layrz_theme/src/helpers/pick_file/native.dart'
  if (dart.library.html) 'package:layrz_theme/src/helpers/pick_file/web.dart';
// ...
pickFile() // <- this function

Returns a list of ThemedFiles. If the user cancels the picker, it returns null.

pickDialogTitle is the title of the pick dialog. When i18n is not null, this is ignored and use the translation layrz.file.pick instead. i18n is the localization object. type is the type of file to pick. allowedExtensions is the list of allowed extensions. allowMultiple is whether to allow multiple files to be picked.

Implementation

Future<List<ThemedFile>?> pickFile({
  String? pickDialogTitle,
  LayrzAppLocalizations? i18n,
  FileType type = FileType.any,
  List<String>? allowedExtensions,
  bool allowMultiple = false,
}) async {
  String dialogTitle = pickDialogTitle ?? i18n?.t('layrz.file.pick') ?? "Pick a file";

  if (Platform.isAndroid) {
    final result = await FilePicker.platform.pickFiles(
      dialogTitle: dialogTitle,
      allowMultiple: allowMultiple,
      type: type,
      allowedExtensions: type == FileType.custom ? allowedExtensions : [],
    );

    if (result != null) {
      return result.files.where((file) {
        return file.path != null;
      }).map((file) {
        return ThemedFile(
          name: file.name,
          path: file.path,
          bytes: File(file.path!).readAsBytesSync(),
        );
      }).toList();
    }

    return null;
  }

  if (Platform.isWindows) {
    var status = await Permission.storage.status;
    if (!status.isGranted) {
      status = await Permission.storage.request();
    }

    if (!status.isGranted) {
      return null;
    }

    final result = await FilePicker.platform.pickFiles(
      dialogTitle: dialogTitle,
      allowMultiple: allowMultiple,
      type: type,
      allowedExtensions: type == FileType.custom ? allowedExtensions : [],
    );

    if (result != null) {
      return result.files.where((file) {
        return file.path != null;
      }).map((file) {
        return ThemedFile(
          name: file.name,
          path: file.path,
          bytes: File(file.path!).readAsBytesSync(),
        );
      }).toList();
    }

    return null;
  }

  if (Platform.isIOS) {
    var status = await Permission.storage.status;
    if (!status.isGranted) {
      status = await Permission.storage.request();
    }

    if (!status.isGranted) {
      return null;
    }

    FilePickerResult? result;
    try {
      result = await FilePicker.platform.pickFiles(
        dialogTitle: dialogTitle,
        allowMultiple: allowMultiple,
        type: type,
        allowedExtensions: type == FileType.custom ? allowedExtensions : [],
      );
    } catch (e) {
      debugPrint("[layrz_theme] Error while picking file: $e");
      result = null;
    }

    if (result != null) {
      return result.files.where((file) {
        return file.path != null;
      }).map((file) {
        return ThemedFile(
          name: file.name,
          path: file.path,
          bytes: File(file.path!).readAsBytesSync(),
        );
      }).toList();
    }

    return null;
  }

  if (Platform.isMacOS) {
    FilePickerResult? result;
    try {
      result = await FilePicker.platform.pickFiles(
        dialogTitle: dialogTitle,
        allowMultiple: allowMultiple,
        type: type,
        allowedExtensions: type == FileType.custom ? allowedExtensions : [],
      );
    } catch (e) {
      debugPrint("[layrz_theme] Error while picking file: $e");
      result = null;
    }

    if (result != null) {
      return result.files.where((file) {
        return file.path != null;
      }).map((file) {
        return ThemedFile(
          name: file.name,
          path: file.path,
          bytes: File(file.path!).readAsBytesSync(),
        );
      }).toList();
    }

    return null;
  }

  if (Platform.isLinux) {
    FilePickerResult? result;
    try {
      result = await FilePicker.platform.pickFiles(
        dialogTitle: dialogTitle,
        allowMultiple: allowMultiple,
        type: type,
        allowedExtensions: type == FileType.custom ? allowedExtensions : [],
      );
    } catch (e) {
      debugPrint("[layrz_theme] Error while picking file: $e");
      result = null;
    }

    if (result != null) {
      return result.files.where((file) {
        return file.path != null;
      }).map((file) {
        return ThemedFile(
          name: file.name,
          path: file.path,
          bytes: File(file.path!).readAsBytesSync(),
        );
      }).toList();
    }

    return null;
  }

  return null;
}