zeba_academy_tutorial_carousel 0.0.1
zeba_academy_tutorial_carousel: ^0.0.1 copied to clipboard
A customizable Flutter package for building multi-step guided tutorials and onboarding flows with swipe support, animated indicators, and offline persistence.
zeba_academy_tutorial_carousel #
A powerful, customizable Flutter package for building multi-step guided tutorials and onboarding flows with smooth animations, flexible layouts, and offline persistence.
✨ Features #
- 🔄 Horizontal & Vertical swipe support
- 🎯 Animated step indicators
- 💾 Offline persistence (mark tutorial as completed)
- 🎮 Controller support (next, previous, jump)
- 🧩 Modular and extensible architecture
- ⚡ Lightweight and dependency minimal
- 📱 Perfect for onboarding, walkthroughs, and learning apps
📦 Installation #
Add this to your pubspec.yaml:
dependencies:
zeba_academy_tutorial_carousel: ^0.0.1
Then run:
flutter pub get
🚀 Usage #
import 'package:zeba_academy_tutorial_carousel/zeba_academy_tutorial_carousel.dart';
TutorialCarousel(
storageKey: "onboarding_done",
steps: [
TutorialStep(
id: "step1",
content: Center(child: Text("Welcome")),
),
TutorialStep(
id: "step2",
content: Center(child: Text("Learn Features")),
),
TutorialStep(
id: "step3",
content: Center(child: Text("Get Started")),
),
],
onCompleted: () {
print("Tutorial Finished");
},
);
🎮 Controller Example #
final controller = TutorialController();
TutorialCarousel(
controller: controller,
storageKey: "tutorial",
steps: steps,
);
// Navigate programmatically
controller.next();
controller.previous();
controller.jumpTo(2);
🔄 Swipe Direction #
TutorialCarousel(
direction: SwipeDirection.vertical,
steps: steps,
storageKey: "vertical_tutorial",
);
💾 Persistence #
The package uses SharedPreferences to store completion state.
await TutorialStorage.isCompleted("onboarding_done");
🎯 Use Cases #
- App onboarding flows
- Feature walkthroughs
- Educational apps
- Step-by-step tutorials
- Product demos
🛠 Roadmap #
- ⏭ Skip button support
- 🎨 Custom indicator builder
- 🎬 Step transition animations
- 🌙 Theme customization
- 🔁 Auto-play mode
🤝 Contributing #
Contributions are welcome!
- Fork the repository
- Create a feature branch
- Commit your changes
- Open a pull request
📄 License #
This project is licensed under the GNU General Public License v3.0 (GPL-3.0).
🧑💻 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 https://sufyanism.com/ or connect with me on Linkedin: https://www.linkedin.com/in/sufyanism
🌐 Your all-in-one no-bloat hub! #
🚀 Explore cutting-edge resources in coding, tech, and development at zeba.academy and code.zeba.academy.
Zeba Academy is a learning platform dedicated to coding, technology, and development.
➡ Visit: https://zeba.academy ➡ Learn: https://code.zeba.academy ➡ YouTube: https://www.youtube.com/@zeba.academy ➡ Instagram: https://www.instagram.com/zeba.academy/
Thank you for visiting! 🎉