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! š