Easy Permissions Manager for Flutter #

A robust, JSON-based permission manager for Flutter that simplifies permission handling across Android, iOS, and Web. Easy Permissions Manager automates the tedious setup of AndroidManifest.xml and Info.plist, handles run-time requests, and provides a smart API to check and request permissions.

🚀 Features #

• JSON Configuration: Manage all permissions in a single easy_permissions.json file.
• Automated Setup: One command to update Android Manifest and iOS Info.plist automatically.
• Smart UI: Includes helper methods to check if permissions are granted, denied, or permanently denied.
• Web Support: Gracefully handles permission checks on Web (silencing unsupported API errors).
• Dependent on Permission Handler: Exports permission_handler so you don't need to add it separately.
• Supports: Camera, Location, Microphone, Photos, Contacts, Notifications, Bluetooth.

📦 Installation #

Requires Dart 3.11+ and Flutter 3.24+; use current stable Flutter for the example builds.

1. Add easy_permissions_manager to your pubspec.yaml:

   dependencies:
     easy_permissions_manager: ^0.0.4
   

2. Run flutter pub get.

🛠 Setup #

1. Create Configuration File #

Create a file named easy_permissions.json in your assets folder (e.g., assets/easy_permissions.json).

{
  "camera": {
    "required": true,
    "description": "We need access to your camera for profile photos."
  },
  "location": {
    "required": true,
    "description": "Location is required for finding nearby stores."
  },
  "microphone": true,
  "photos": false,
  "contacts": true,
  "notifications": true,
  "bluetooth": {
    "required": true,
    "description": "Bluetooth is needed to connect to accessories."
  }
}

2. Register Asset #

Ensure the asset is registered in your pubspec.yaml:

flutter:
  assets:
    - assets/easy_permissions.json

3. Run Setup Tool #

Inspect changes first with dart run easy_permissions_manager:setup --dry-run. Use --config <path> for another JSON file, and --remove-unused to remove explicitly disabled permissions. Shared declarations required by an enabled permission are preserved. Configuration keys are case insensitive.

Run the built-in setup command to automatically configure your native files. This will add the necessary <uses-permission> tags to AndroidManifest.xml and Usage Description keys to Info.plist.

dart run easy_permissions_manager:setup

Note: You must run this command whenever you change your easy_permissions.json file.

💻 Usage #

Initialization #

Initialize the library in your main() method.

import 'package:easy_permissions_manager/easy_permissions_manager.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  
  // load configuration
  await EasyPermissions.initFromAsset('assets/easy_permissions.json');
  
  runApp(const MyApp());
}

Requesting Permissions #

You can request a single permission or all enabled permissions at once.

// Request a specific permission (Type-Safe)
PermissionStatus status = await EasyPermissions.request(Permission.camera);

if (status.isGranted) {
  // open camera
}

// Request ALL permissions defined in your config
Map<String, PermissionStatus> results = await EasyPermissions.ask();

Checking Status #

Check the status of permissions without asking.

// Check single (Type-Safe)
PermissionStatus status = await EasyPermissions.check(Permission.location);

// Check all
Map<String, PermissionStatus> statuses = await EasyPermissions.checkStatus();

Detailed results #

The existing methods continue to return PermissionStatus for compatibility. Use the additive detailed API to distinguish unsupported platforms:

final result = await EasyPermissions.requestDetailed(Permission.camera);
if (!result.isSupported) {
  // Offer an alternative for this platform.
} else if (result.isPermanentlyDenied) {
  await EasyPermissions.openSettings();
}

askDetailed, checkDetailed, askPermissionDetailed, checkPermissionDetailed, and checkStatusDetailed are also available.

Background location needs an explicit locationAlways configuration entry. Typed Bluetooth scan/connect/advertise requests retain the exact native permission; the bluetooth string key aggregates Android scan and connect. Storage requests are kept distinct from photo-library requests. On Android 13+ use photo access for images; legacy storage permission is not a media-access substitute.

Android integration #

The current permission_handler Android backend requires API 37 compilation and Android API 24 or later. The example configures the installed android-37.0 platform explicitly for the app and permission plugin.

iOS integration #

Current permission_handler supports Swift Package Manager and discovers enabled permissions from Info.plist. The setup command adds usage descriptions; keep these descriptions accurate for your application. CocoaPods consumers must also configure the permission_handler PERMISSION_* preprocessor definitions in the Podfile as described in its documentation. The example uses Swift Package Manager.

🌐 Web Support #

Permissions on the Web are handled differently than mobile. easy_permissions_manager automatically detects if the app is running on Web and:

• Silences errors for unsupported permissions (like contacts or bluetooth) by returning PermissionStatus.denied instead of crashing.
• Allows supported permissions (like camera and microphone) to work normally.

📝 Configuration Options #

The JSON configuration supports simple booleans or detailed objects.

Object Example:

"bluetooth": {
  "required": true,
  "description": "We need Bluetooth to connect to the device."
}

❤️ Contributing #

Contributions are welcome! If you find a bug or want a feature, please open an issue.

Maintained by Greelogix, Bilal Imran (@bilalatgreelogix), bilal.imran@greelogix.com. Published under the verified greelogix.com publisher.

Permission prompts remain controlled by the operating system and browser. macOS and Linux return unsupported results because permission_handler has no backend for them. On web, only camera, microphone, and foreground location requests are attempted.