---

Overview

Delivered the app. Client ghosts you. Sound familiar? `flutter_app_expiry` lets you ship a fully functional build that automatically locks itself on your terms — so you stay in control until the invoice is settled. Ideal for freelancers, agencies, and indie developers who need a reliable payment deadline gate without writing it from scratch.

ExpiryApp(
  expiryDate: DateTime(2026, 12, 31),
  child: const MyApp(),
)

That's it. One widget wraps everything.

---

✦ Features

🔒 Payment deadline gate	App locks on your terms — no payment, no access
🎨 Beautiful default UI	Animated lock screen with gradient, shown out of the box
🛠 Fully replaceable	Swap in your own expired widget with a single parameter
📅 ExpiryService utility	Query remaining days or duration programmatically
🖼 Unpaid branding	Stamp every screen with your watermark until the client pays
🪶 Zero extra dependencies	Pure Flutter — nothing added to your dependency tree

---

📦 Getting Started

1. Install

# pubspec.yaml
dependencies:
  flutter_app_expiry: ^0.0.1

flutter pub get

2. Wrap your app

import 'package:flutter/material.dart';
import 'package:flutter_app_expiry/flutter_app_expiry.dart';

void main() {
  runApp(
    ExpiryApp(
      expiryDate: DateTime(2026, 12, 31), // 🔑 set your date
      child: const MyApp(),
    ),
  );
}

Done. The app runs normally until expiryDate — then the lock screen takes over automatically.

---

🎨 Customization

Option A — Use your own expired screen

ExpiryApp(
  expiryDate: DateTime(2026, 12, 31),
  expiredWidget: const MyCustomExpiredScreen(), // full control
  child: const MyApp(),
)

Option B — Customize the built-in screen

ExpiryApp(
  expiryDate: DateTime(2026, 12, 31),
  expiredTitle: 'Trial Ended',
  expiredMessage: 'Please purchase a license to continue.',
  contactInfo: 'support@yourapp.com',
  child: const MyApp(),
)

Option C — Embed DefaultExpiredScreen directly

DefaultExpiredScreen(
  expiryDate: DateTime(2026, 12, 31),
  title: 'License Expired',
  message: 'Renew to keep going.',
  contactInfo: 'hello@example.com',
)

---

🖼 Watermark Overlay

Need to brand a demo build or remind unpaid clients they're on a trial? The watermark overlay floats your logo on top of the running app — persistent, unobtrusive, and impossible to miss.

Common use cases:

• Demo apps — make it clear the build isn't production-ready
• Unpaid clients — reinforce that a license is still pending
• Internal builds — distinguish staging from release

ExpiryApp(
  expiryDate: DateTime(2026, 12, 31),
  watermark: WatermarkConfig(
    image: AssetImage('assets/logo.png'),
  ),
  child: const MyApp(),
)

The watermark renders above your app's UI at all times and is removed automatically once a valid license is in place.

---

🧮 ExpiryService

Need to react to expiry in your own logic? Use ExpiryService for programmatic checks:

final service = ExpiryService();
final expiry = DateTime(2026, 12, 31);

// Check expiry state
final expired = service.isExpired(expiry);          // bool

// How much time is left?
final days     = service.remainingDays(expiry);     // int  (e.g. 42)
final duration = service.remainingDuration(expiry); // Duration

Great for showing in-app banners like "Your trial expires in 7 days".

---

📚 API Reference

ExpiryApp

Parameter	Type	Required	Description
expiryDate	DateTime	✅	The date the app will be blocked
child	Widget	✅	Your root app widget
expiredWidget	Widget?	—	Fully custom expired screen
expiredTitle	String?	—	Title on the default screen
expiredMessage	String?	—	Message on the default screen
contactInfo	String?	—	Contact text on the default screen
watermark	WatermarkConfig?	—	Logo overlay for demo/trial branding

expiredWidget takes precedence — if provided, expiredTitle, expiredMessage, and contactInfo are ignored.

WatermarkConfig

Parameter	Type	Required	Description
image	ImageProvider	✅	The image to display as a watermark

ExpiryService

Method	Returns	Description
isExpired(DateTime)	bool	true if the date has passed
remainingDays(DateTime)	int	Full calendar days remaining
remainingDuration(DateTime)	Duration	Precise duration until expiry

---

📂 Project Structure

flutter_app_expiry/
├── lib/
│   ├── flutter_app_expiry.dart       # Public barrel export
│   └── src/
│       ├── expiry_service.dart       # Core expiry logic
│       ├── expiry_screen.dart        # Default animated UI
│       ├── expiry_widget.dart        # ExpiryApp wrapper widget
│       └── watermark_overlay.dart    # Watermark overlay widget
├── example/
│   └── lib/main.dart
├── pubspec.yaml
├── CHANGELOG.md
├── README.md
└── LICENSE

---

🤝 Contributing

Issues and pull requests are welcome! If you find a bug or have a feature idea, please open an issue.

1. Fork the repo
2. Create your feature branch: git checkout -b feat/amazing-thing
3. Commit your changes: git commit -m 'feat: add amazing thing'
4. Push and open a PR

---

📄 License

MIT © see LICENSE for details.

---