biometric_auth_flutter #

A simple Flutter plugin that enables biometric authentication on Android using method channels. Supports fingerprint, face unlock, and device credentials like PIN or pattern.

✨ Features #

• 🔐 Authenticate users using biometrics or device credentials.
• 💡 Native Android biometric prompt.
• ⚙️ Simple and lightweight API.
• 📱 Android platform supported.

🚀 Getting Started #

1. Add dependency #

In your pubspec.yaml:

dependencies:
  biometric_auth_flutter: ^0.0.1

2. Import it #

import 'package:biometric_auth_flutter/biometric_auth_flutter.dart';

3. Use it #

final isAuthenticated = await BiometricAuthFlutter().authenticate();

if (isAuthenticated) {
  // Navigate to secure area
} else {
  // Show fallback or error
}

📦 Platform Support #

iOS support will be added in a future release. PRs are welcome!

🧪 Example #

Use the plugin in your authentication screen like this:

ElevatedButton(
  onPressed: () async {
    bool auth = await BiometricAuthFlutter().authenticate();
    if (auth) {
      // proceed
    } else {
      // handle failure
    }
  },
  child: Text("Login with Biometrics"),
);

🧠 How It Works #

This plugin uses AndroidX BiometricPrompt APIs under the hood and communicates with Flutter via MethodChannel.

🛠️ Development #

Run tests #

flutter test

Folder Structure #

lib/
  biometric_auth_flutter.dart          # Public API
  biometric_auth_flutter_method_channel.dart
  biometric_auth_flutter_platform_interface.dart

android/
  ...                                  # Kotlin native code

📄 License #

This project is licensed under the MIT License - see the LICENSE file for details.

👤 Author #

Muhaimin K P M 📍 Kondotty, Kerala, India 🔗 GitHub 📧 [email protected]

💡 Contributions #

Feel free to open issues or submit PRs if you'd like to contribute. Thank you for helping improve the plugin! 🙌

---

## ✅ Summary

- This `README.md` includes:
  - Plugin description
  - Installation
  - Usage
  - Platform support
  - Author info (you)
  - Contribution instructions
  - License and badges

---

Let me know if you'd also like:
- A basic `example/` Flutter app to demo this
- Banner image or pub.dev thumbnail
- GitHub Actions CI for testing automatically

Would you like me to generate that too?

# biometric_auth_flutter

[![pub package](https://img.shields.io/pub/v/biometric_auth_flutter.svg)](https://pub.dev/packages/biometric_auth_flutter)

A simple Flutter plugin that enables biometric authentication on Android using method channels. Supports fingerprint, face unlock, and device credentials like PIN or pattern.

---

## ✨ Features

- 🔐 Authenticate users using biometrics or device credentials.
- 💡 Native Android biometric prompt.
- ⚙️ Simple and lightweight API.
- 📱 Android platform supported.

---

## 🚀 Getting Started

### 1. Add dependency

In your `pubspec.yaml`:

```yaml
dependencies:
  biometric_auth_flutter: ^0.0.1

2. Import it #

import 'package:biometric_auth_flutter/biometric_auth_flutter.dart';

3. Use it #

final isAuthenticated = await BiometricAuthFlutter().authenticate();

if (isAuthenticated) {
  // Navigate to secure area
} else {
  // Show fallback or error
}

📦 Platform Support #

iOS support will be added in a future release. PRs are welcome!

🧪 Example #

Use the plugin in your authentication screen like this:

ElevatedButton(
  onPressed: () async {
    bool auth = await BiometricAuthFlutter().authenticate();
    if (auth) {
      // proceed
    } else {
      // handle failure
    }
  },
  child: Text("Login with Biometrics"),
);

🧠 How It Works #

This plugin uses AndroidX BiometricPrompt APIs under the hood and communicates with Flutter via MethodChannel.

🛠️ Development #

Run tests #

flutter test

Folder Structure #

lib/
  biometric_auth_flutter.dart          # Public API
  biometric_auth_flutter_method_channel.dart
  biometric_auth_flutter_platform_interface.dart

android/
  ...                                  # Kotlin native code

📄 License #

This project is licensed under the MIT License - see the LICENSE file for details.

👤 Author #

Muhaimin K P M 📍 Kondotty, Kerala, India 🔗 GitHub 📧 [email protected]

💡 Contributions #

Feel free to open issues or submit PRs if you'd like to contribute. Thank you for helping improve the plugin! 🙌