zeba_academy_ui_replay

🚀 Record & Replay UI Interactions in Flutter

zeba_academy_ui_replay is a lightweight Flutter package designed for recording and replaying user interactions such as taps and gestures. It is ideal for testing, debugging, and automation without relying on external services.

✨ Features

  • 🎥 Record taps & gestures
  • ▶️ Replay UI interactions
  • 💾 Export logs (JSON)
  • 📡 Works fully offline
  • ⚡ Lightweight & fast

📦 Installation

Add this to your pubspec.yaml:

dependencies:
  zeba_academy_ui_replay: ^0.0.1

Then run:

flutter pub get

🚀 Getting Started

1️⃣ Import Package

import 'package:zeba_academy_ui_replay/zeba_academy_ui_replay.dart';

2️⃣ Initialize Recorder & Replayer

final recorder = UIRecorder();
final replayer = UIReplayer();

3️⃣ Wrap Your UI

RecordableWidget(
  recorder: recorder,
  child: YourWidget(),
)

4️⃣ Start & Stop Recording

recorder.start();
recorder.stop();

5️⃣ Replay Events

await replayer.replay(
  recorder.events,
  (offset) {
    print("Tapped at: $offset");
  },
);

6️⃣ Export Logs

final path = await UIExporter.export(recorder.events);
print("Saved at: $path");

🧠 How It Works

User Interaction
      ↓
RecordableWidget
      ↓
UIRecorder → Stores Events
      ↓
Exporter → JSON File
      ↓
UIReplayer → Simulates Events

🧪 Testing

Run tests using:

flutter test

Includes:

  • Recorder tests
  • Replayer tests
  • Widget interaction tests

📁 Project Structure

lib/
 ├── src/
 │   ├── models/
 │   ├── recorder/
 │   ├── replay/
 │   ├── widgets/
 │   └── utils/
 └── zeba_academy_ui_replay.dart

🔮 Roadmap

  • Drag & swipe gesture support
  • Visual replay overlay
  • Speed control for replay
  • Widget key-based replay
  • Integration with Flutter test framework

📜 License

This project is licensed under the GNU General Public License v3.0 (GPL-3.0).

You are free to:

  • Use
  • Modify
  • Distribute

Under the condition that:

  • Source code must be disclosed
  • Same license must be applied

👨‍💻 About Me

✨ I’m Sufyan bin Uzayr, an open-source developer passionate about building and sharing meaningful projects. You can learn more about me and my work at sufyanism.com or connect with me on Linkedin

🌐 Your all-in-one no-bloat hub!

🚀 Explore cutting-edge resources in coding, tech, and development at zeba.academy and code.zeba.academy. Empower yourself with practical skills through curated directives, real-world projects, and hands-on experience. Level up your tech game today! 💻✨

Zeba Academy is a learning platform dedicated to coding, technology, and development.

➡ Visit our main site: https://zeba.academy ➡ Explore hands-on courses: https://code.zeba.academy ➡ YouTube: https://www.youtube.com/@zeba.academy ➡ Instagram: https://www.instagram.com/zeba.academy/

⭐ Support

If you like this project:

  • ⭐ Star the repo
  • 🍴 Fork it
  • 🛠 Contribute

🙌 Contributions

Contributions are welcome! Feel free to open issues or submit pull requests.

💬 Feedback

Have ideas or improvements? Open an issue or reach out — your feedback helps make this better.

Thank you for visiting! ❤️

Libraries

zeba_academy_ui_replay