zeba_academy_tutorial_carousel 0.0.1 copy "zeba_academy_tutorial_carousel: ^0.0.1" to clipboard
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!

  1. Fork the repository
  2. Create a feature branch
  3. Commit your changes
  4. 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! šŸŽ‰


0
likes
140
points
45
downloads

Documentation

API reference

Publisher

verified publisherzeba.academy

Weekly Downloads

A customizable Flutter package for building multi-step guided tutorials and onboarding flows with swipe support, animated indicators, and offline persistence.

Homepage

Topics

#tutorial #onboarding #carousel #ui #flutter

License

GPL-3.0 (license)

Dependencies

flutter, shared_preferences

More

Packages that depend on zeba_academy_tutorial_carousel