A new Flutter package which helps developers in creating walkthrough of their app.

Overview

flutter_walkthrough

A new Flutter package for both android and iOS which helps developers in creating animated walkthrough of their app.

Show some ❤️ and star the repo to support the project

Screenshots

Usage

Example

To use this package :

  dependencies:
    flutter:
      sdk: flutter
    flutter_walkthrough:

How to use

class TestScreen extends StatelessWidget {
  
  /*here we have a list of walkthroughs which we want to have, 
  each walkthrough have a title,content and an icon.
  */
  final List<Walkthrough> list = [
    Walkthrough(
      title: "Title 1",
      content: "Content 1",
      imageIcon: Icons.restaurant_menu,
    ),
    Walkthrough(
      title: "Title 2",
      content: "Content 2",
      imageIcon: Icons.search,
    ),
    Walkthrough(
      title: "Title 3",
      content: "Content 3",
      imageIcon: Icons.shopping_cart,
    ),
    Walkthrough(
      title: "Title 4",
      content: "Content 4",
      imageIcon: Icons.verified_user,
    ),
  ];

  @override
  Widget build(BuildContext context) {
    //here we need to pass the list and the route for the next page to be opened after this.
    return new IntroScreen(
      list,
      new MaterialPageRoute(builder: (context) => new TestScreen()),
    );
  }
}

Pull Requests

I welcome and encourage all pull requests. It usually will take me within 24-48 hours to respond to any issue or request. Here are some basic rules to follow to ensure timely addition of your request:

  1. Match coding style (braces, spacing, etc.) This is best achieved using Reformat Code feature of Android Studio CMD+Option+L on Mac and CTRL + ALT + L on Linux + Windows .
  2. If its a feature, bugfix, or anything please only change code to what you specify.
  3. Please keep PR titles easy to read and descriptive of changes, this will make them easier to merge :)
  4. Pull requests must be made against develop branch. Any other branch (unless specified by the maintainers) will get rejected.
  5. Check for existing issues first, before filing an issue.
  6. Make sure you follow the set standard as all other projects in this repo do
  7. Have fun!

Created & Maintained By

Pawan Kumar (@imthepk) (Youtube) (Insta)

If you found this project helpful or you learned something from the source code and want to thank me, consider buying me a cup of

License

Copyright 2018 Pawan Kumar

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Getting Started

For help getting started with Flutter, view our online documentation.

For help on editing package code, view the documentation.

You might also like...

A pokemon app that let's you explore a large libarary of pokemons, view their strenghts and save your favorite pokemons

A pokemon app that let's you explore a large libarary of pokemons, view their strenghts and save your favorite pokemons

A pokemon app that let's you explore a large libarary of pokemons, view their strenghts and save your favorite pokemons!. (Built using freezed and flutter_bloc)

Aug 19, 2022

An (Sample)app that allows users to donate their pets and adopt others pets.

An (Sample)app that allows users to donate their pets and adopt others pets.

PetApp An (Sample)app that allows users to donate their pets and adopt others pets. About I created this app to learn more about Flutter and UI/UX in

Sep 6, 2022

Collection of all the widgets with their tutorial

Flutter Widgets A collection of flutter widgets with tutorials. Season 1 Episode 1 - Sized Box Episode 2 - Animated Builder Episode 3 - Draggable and

Aug 30, 2022

This is a User Profile where the user can edit their information.

This is a User Profile where the user can edit their information.

Flutter User Profile App This repository shows how I built a simple User Profile UI using Flutter. Please note that I was unable to get the Profile Im

Jul 23, 2022

LogiFresh helps you build a login easily with a friendly design, and very flexible for its construction

LogiFresh helps you build a login easily with a friendly design, and very flexible for its construction

Login Fresh LogiFresh helps you build a login easily with a friendly design, and very flexible for its construction. Installation Follow the install i

Apr 20, 2022

Check out the new style for App Design aims for Payment App

Check out the new style for App Design aims for Payment App

💰 Payment App UI Check out the new style for App Design aims for Payment App... 😉 😀 😁 😎 You can Install and test latest app from below 👇 📸 Scre

Sep 14, 2022

Flutter HBO Profile - A new Flutter project inspired by the HBO App

Flutter HBO Profile - A new Flutter project inspired by the HBO App

FLUTTER HBO PROFILE A new Flutter project inspired by the HBO App.

Jan 18, 2022

Tutorial for integrating flutter to your new or existing android app.

AddFlutter2Existing Android App Tutorial for adding flutter to your new or existing android app. Link to tutorial Android Create a Flutter module Let'

Jun 27, 2022

A Brand New Flutter Weather App

A Brand New Flutter Weather App

A Brand New Flutter Weather App

Aug 25, 2022
Comments
  • [ImgBot] Optimize images

    [ImgBot] Optimize images

    Beep boop. Your images are optimized!

    Your image file size has been reduced by 51% 🎉

    Details

    | File | Before | After | Percent reduction | |:--|:--|:--|:--| | /ss1.png | 102.13kb | 50.24kb | 50.81% | | /ss2.png | 103.28kb | 51.03kb | 50.60% | | | | | | | Total : | 205.42kb | 101.26kb | 50.70% |


    📝docs | :octocat: repo | 🙋issues | 🏅swag | 🏪marketplace

    opened by imgbot[bot] 0
  • Next page has back button on top bar

    Next page has back button on top bar

    After walkthrough finishes, a new page is loaded but with a back button at top (appBar). Are there any ways to hide or remove that button?

    I think it can be related in how next page is called internally. I assume if it's called as Navigator.pushReplacementNamed("some Route"); it should be fixed

    I'm checking this post.

    opened by gonzalonm 1
  • Can we make a todo.md ?

    Can we make a todo.md ?

    I would like to see the ability to walk a user through a real app with an assistant. You ask the user to fill in data and the assistant checks it before moving on to the next step.

    This is a bit different from the way the system works now but it's highly useful in training users on how to use a system. Normally I design apps to have a production data endpoint and a training data endpoint. The training one is for the training walkthroughs. You can then describe each training step at a data level . So all your doing is running an assistant widget that is talking to the training endpoint to get steps .

    Curious what you think.

    I can flesh it out more if you want. Or just ask me more questions.

    enhancement 
    opened by ghost 2
Owner
Pawan Kumar
GoogleDevExpert for Flutter, Firebase, Dart & Web Tech. Public Speaker, Blogger, Entrepreneur & YouTuber. Founder of MTechViral & Let's Flutter with Dart.
Pawan Kumar
Flutter Advanced: ARCore Tutorial | Sceneform | Exploring New Possibilities || Exploring New Possibilities

flutter_ar A new Flutter project. Getting Started This project is a starting point for a Flutter application. A few resources to get you started if th

Pawan Kumar 58 Jun 16, 2022
Bmi-app - A Flutter application which helps you to find your BMI

BMI APP ?? An simple flutter application for finding your body BMI Screenshots ?

Vivek K J 1 Jan 19, 2022
gceditor - a client/server application for creating a persistent data of an application

gceditor - a client/server application for creating a persistent data of an application

Sergey Tarasenko 7 Jul 13, 2022
Gif Finder in flutter using GIPHY API Developers

Gif Finder in flutter using GIPHY API Developers Getting Started This project is a starting point for a Flutter application. A few resources to get yo

Bruno Gluszczuk 1 Dec 30, 2021
A flutter app helps to keep track of what money is spent in order to help save

HaslTy This application helps to keep track of what money is spent in order to help save. Tools State management (BLoC). Local database (sqflite packa

Ahmed Khairy 4 Oct 29, 2021
A flutter quiz app that helps you learn about the City of Munich

MucQuiz MucQuiz is a quiz app that helps you learn about the City of Munich. It is a submission for the City of Munich challenge at hackaTUM 2021. Scr

Robin Holzinger 10 Sep 6, 2022
A flutter app that allows users to search books and display their details

Project find books This repository is the first part of the main project which aims to search books and find libraries containing them. I've decided t

Abdel 3 Jul 11, 2022
App in Flutter for managing Projects and their Requirements

App in Flutter for managing Projects and their Requirements. Activity for Integrating Project of the Faculty of Systems Analysis and Development.

Luciano Zimermann 1 Mar 16, 2022
Quizzler - a simple Quiz app that presents a few yes/no questions and checks their answers

Quizzler ❓ Our Goal In this tutorial we will be reviewing Stateful and Stateless Widgets as well as learning about the fundamental building blocks of

null 0 Jan 2, 2022