zeb_permissions_helper 1.0.0

zeb_permissions_helper: ^1.0.0 copied to clipboard

🛡️ Zeb Permissions Helper #

A powerful, flexible Flutter package that simplifies managing permissions across different libraries — with customizable UI dialogs, sequential flows, and unified APIs.

🚀 Overview #

zeb_permissions_helper provides a consistent and developer-friendly way to request permissions in Flutter apps. It allows you to:

• Choose which underlying package to use for specific permissions (e.g., location for GPS, permission_handler for camera/mic).
• Display purpose dialogs explaining why a permission is needed.
• Request single, multiple, or sequential permissions with minimal code.
• Handle results, errors, and fallbacks gracefully across iOS and Android.

📦 Installation #

Add to your pubspec.yaml:

dependencies:
  zeb_permissions_helper: ^1.0.0

Then run:

flutter pub get

⚙️ Import #

import 'package:zeb_permissions_helper/zeb_permissions_helper.dart';

🧩 Basic Usage #

✅ Single Permission

final helper = ZebPermissionsHelper();

final result = await helper.requestPermission(
  context,
  Permission.camera,
  requestConfig: const SingleRequestConfig(
    showPurposeDialog: true,
    dialogText: DialogText(
      title: 'Camera Access Required',
      explanation: 'We need camera access to let you capture profile photos.',
      caution: 'Please enable this permission in settings if denied.',
    ),
  ),
);

print('Granted: ${result.isGranted}, Used package: ${result.usedPackage}');

🔁 Multiple Permissions #

final results = await helper.requestMultiplePermissions(
  context,
  [Permission.camera, Permission.microphone, Permission.photos],
  requestConfigs: {
    Permission.camera: const SingleRequestConfig(showPurposeDialog: false),
  },
);

for (final r in results) {
  print('${r.permission}: ${r.isGranted ? "GRANTED" : "DENIED"}');
}

🔄 Sequential Flow (Onboarding Style) #

final results = await helper.requestPermissionsSequentially(
  context,
  sequentialConfig: SequentialRequestConfig(
    permissions: [
      Permission.camera,
      Permission.location,
      Permission.notification,
    ],
    packageOverrides: {
      Permission.location: PermissionPackage.location,
      Permission.notification: PermissionPackage.notifications,
    },
    showPurposeDialogs: true,
    delayBetweenRequests: Duration(milliseconds: 500),
  ),
);

for (final r in results) {
  print('${r.permission}: ${r.isGranted ? "GRANTED" : "DENIED"}');
}

🧠 Key Features #

🧪 Example App #

This package includes a full example app demonstrating:

• Single permission flow
• Multiple permissions
• Sequential permission onboarding
• Custom dialog texts
• Status checks and edge cases

Run the example:

cd example
flutter run

🧰 Classes & Configs #

ZebPermissionsHelper

The main class used to handle permission requests.

SingleRequestConfig

Configuration for a single permission request:

• package: choose which library to use
• dialogText: customize the dialog text
• showPurposeDialog: whether to show a pre-request dialog

SequentialRequestConfig

Controls sequential permission requests:

• permissions: list of permissions to request
• packageOverrides: map of permission → package
• showPurposeDialogs: whether to show purpose dialogs before each request
• delayBetweenRequests: optional delay between each step

DialogText

Defines the title, explanation, and caution messages shown in dialogs.

🧾 Example UI Scenarios #

You can test the flows directly from the example app’s home page:

📱 Platform Support #

🧩 Dependencies #

• permission_handler
• location
• (Optionally) other permission-specific packages

🧑‍💻 Contributing #

Contributions, issues, and feature requests are welcome! Feel free to open a PR or issue on GitHub.

📄 License #

This project is licensed under the MIT License.

🌟 Author #

Developed by Sufi Aurangzeb Hossain

Simplifying permission handling for every Flutter app.

🪄 Badges #

[![pub package](https://img.shields.io/pub/v/zeb_permissions_helper.svg)](https://pub.dev/packages/zeb_permissions_helper)
[![likes](https://img.shields.io/pub/likes/zeb_permissions_helper)](https://pub.dev/packages/zeb_permissions_helper)
[![points](https://img.shields.io/pub/points/zeb_permissions_helper)](https://pub.dev/packages/zeb_permissions_helper)
[![popularity](https://img.shields.io/pub/popularity/zeb_permissions_helper)](https://pub.dev/packages/zeb_permissions_helper)

Would you like me to include a License file (MIT) and example folder structure section for your repo as well (so your GitHub looks professional and ready for pub.dev)?