Fancy OnBoarding Screen Library

Overview

πŸ‘ FancyOnBoarding

Say Thanks! Twitter

A Fancy OnBoarding Screen Library for Easy and Quick Usage.

  • Checkout the Original Author : GitHub followers
  • Checkout the Original Designer : GitHub followers

The source code is 100% Dart, and everything resides in the /lib folder.

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

GitHub stars GitHub forks GitHub watchers GitHub followers
Twitter Follow

Open Source Love License Build Status CodeCov

GIF

GIF

πŸ’» Installation

In the dependencies: section of your pubspec.yaml, add the following line:

Version

fancy_on_boarding: <latest_version>

❔ Usage

Import this class

import 'package:fancy_on_boarding/fancy_on_boarding.dart';

Create a List of PageModel

  final pageList = [
    PageModel(
        color: const Color(0xFF678FB4),
        heroImagePath: 'assets/png/hotels.png',
        title: Text('Hotels',
            style: TextStyle(
              fontWeight: FontWeight.w800,
              color: Colors.white,
              fontSize: 34.0,
            )),
        body: Text('All hotels and hostels are sorted by hospitality rating',
            textAlign: TextAlign.center,
            style: TextStyle(
              color: Colors.white,
              fontSize: 18.0,
            )),
        iconImagePath: 'assets/png/key.png'),
    PageModel(
        color: const Color(0xFF65B0B4),
        heroImagePath: 'assets/png/banks.png',
        title: Text('Banks',
            style: TextStyle(
              fontWeight: FontWeight.w800,
              color: Colors.white,
              fontSize: 34.0,
            )),
        body: Text(
            'We carefully verify all banks before adding them into the app',
            textAlign: TextAlign.center,
            style: TextStyle(
              color: Colors.white,
              fontSize: 18.0,
            )),
        iconImagePath: 'assets/png/wallet.png'),
    PageModel(
      color: const Color(0xFF9B90BC),
      heroImagePath: 'assets/png/stores.png',
      title: Text('Store',
          style: TextStyle(
            fontWeight: FontWeight.w800,
            color: Colors.white,
            fontSize: 34.0,
          )),
      body: Text('All local stores are categorized for your convenience',
          textAlign: TextAlign.center,
          style: TextStyle(
            color: Colors.white,
            fontSize: 18.0,
          )),
      icon: Icon(
        Icons.shopping_cart,
        color: const Color(0xFF9B90BC),
      ),
    ),
    // SVG Pages Example
    PageModel(
        color: const Color(0xFF678FB4),
        heroImagePath: 'assets/svg/hotel.svg',
        title: Text('Hotels SVG',
            style: TextStyle(
              fontWeight: FontWeight.w800,
              color: Colors.white,
              fontSize: 34.0,
            )),
        body: Text('All hotels and hostels are sorted by hospitality rating',
            textAlign: TextAlign.center,
            style: TextStyle(
              color: Colors.white,
              fontSize: 18.0,
            )),
        iconImagePath: 'assets/svg/key.svg',
        heroImageColor: Colors.white),
    PageModel(
        color: const Color(0xFF65B0B4),
        heroImagePath: 'assets/svg/bank.svg',
        title: Text('Banks SVG',
            style: TextStyle(
              fontWeight: FontWeight.w800,
              color: Colors.white,
              fontSize: 34.0,
            )),
        body: Text(
            'We carefully verify all banks before adding them into the app',
            textAlign: TextAlign.center,
            style: TextStyle(
              color: Colors.white,
              fontSize: 18.0,
            )),
        iconImagePath: 'assets/svg/cards.svg',
        heroImageColor: Colors.white),
    PageModel(
      color: const Color(0xFF9B90BC),
      heroImagePath: 'assets/svg/store.svg',
      title: Text('Store SVG',
          style: TextStyle(
            fontWeight: FontWeight.w800,
            color: Colors.white,
            fontSize: 34.0,
          )),
      body: Text('All local stores are categorized for your convenience',
          textAlign: TextAlign.center,
          style: TextStyle(
            color: Colors.white,
            fontSize: 18.0,
          )),
      iconImagePath: 'assets/svg/cart.svg',
    ),
  ];

Pass it into the FancyOnBoarding widget

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      body: FancyOnBoarding(
        doneButtonText: "Done",
        skipButtonText: "Skip",
        pageList: pageList,
        onDoneButtonPressed: () =>
            Navigator.of(context).pushReplacementNamed('/mainPage'),
        onSkipButtonPressed: () =>
            Navigator.of(context).pushReplacementNamed('/mainPage'),
      ),
    );
  }

🎨 Customization and Attributes

FancyOnBoarding attributes

Attribute Name Example Value Description
pageList List<PageModel> The list of pages to be displayed
onDoneButtonPressed (){} Function to be called on pressing done button
onSkipButtonPressed (){} Function to be called on pressing skip button
doneButtonText "Let's Go" Done button text content defaults to "Done"
skipButtonText "Skip" Skip button text content defaults to "Skip"
showSkipButton true Skip button should be visible or not. Defaults to true
bottomMargin 8.0 Indicator bottom margin. Defaults to 8.0
doneButton Button(onPressed:(){},child:Text('Done')) Custom DoneButton. Will replace default doneButton if provided
skipButton Button(onPressed:(){},child:Text('Skip')) Custom SkipButton. Will replace default doneButton if provided

PageModel attributes

Attribute Name Example Value Description
color Color(0xFF65B0B4) The background color of the page
heroAssetPath 'assets/banks.png' The main onboarding image
heroAssetColor Color(0xFF65B0B4) Main onboarding image color
title Text('Banks') Title of the page
body Text('We carefully verify all banks before adding them into the app') Body of the page
iconAssetPath 'assets/wallet.png' Icon for the floating bubble
icon Icon(Icons.shopping_cart) Icon for the floating bubble, Will replace 'iconAssetPath' if provided

πŸ‘ How to Contribute

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

πŸ“ƒ License

Copyright (c) 2018 Sahil Kumar

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Getting Started

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

For help on editing package code, view the documentation.

Comments
  • fluter_svg needs to be upgraded to 0.18.0

    fluter_svg needs to be upgraded to 0.18.0

    flutter_svg (0.18.0) is adapted to flutter lastest stable channel (v1.20.2), if it is lower than 0.18.0, it fails to run. This library depends on the lower version of flutter_svg, so an error is reported when running on the lastest stable channel.

    opened by OHeroJ 10
  • build errors with flutter_svg when upgrading to 1.20

    build errors with flutter_svg when upgrading to 1.20

    I upgraded to Flutter 1.20 and could no longer build my project. I believe that it's because of the dependency on flutter_svg: ^0.17.4

    For anyone running into this problem, you can fix it by adding the following to your pubspec.yaml:

    dependency_overrides:
      flutter_svg: ^0.18.0
    
    opened by M1Joe 10
  • Error: 'Page' is imported from both pages.dart and navigator.dart

    Error: 'Page' is imported from both pages.dart and navigator.dart

    Compiler message:
    ../../flutter/.pub-cache/hosted/pub.dartlang.org/fancy_on_boarding-1.5.0/lib/src/fancy_on_boarding.dart:67:9: Error: 'Page' is imported from both 'package:fancy_on_boarding/src/pages.dart' and 'package:flutter/src/widgets/navigator.dart'.
            Page(
            ^^^^
    ../../flutter/.pub-cache/hosted/pub.dartlang.org/fancy_on_boarding-1.5.0/lib/src/fancy_on_boarding.dart:73:18: Error: 'Page' is imported from both 'package:fancy_on_boarding/src/pages.dart' and 'package:flutter/src/widgets/navigator.dart'.
              child: Page(
                     ^^^^
    

    Steps to reproduce:

    import "package:flutter/material.dart";
    import 'package:fancy_on_boarding/fancy_on_boarding.dart' as boarder;
    
    final pageList = [
        boarder.PageModel(
            color: const Color(0xFF678FB4),
            heroAssetPath: 'assets/heart.png',
            title: Text('Hotels',
                style: TextStyle(
                  fontWeight: FontWeight.w800,
                  color: Colors.white,
                  fontSize: 34.0,
                )),
            body: Text('All hotels and hostels are sorted by hospitality rating',
                textAlign: TextAlign.center,
                style: TextStyle(
                  color: Colors.white,
                  fontSize: 18.0,
                )),
            iconAssetPath: 'assets/heart.png'),
        boarder.PageModel(
            color: const Color(0xFF65B0B4),
            heroAssetPath: 'assets/heart.png',
            title: Text('Banks',
                style: TextStyle(
                  fontWeight: FontWeight.w800,
                  color: Colors.white,
                  fontSize: 34.0,
                )),
            body: Text(
                'We carefully verify all banks before adding them into the app',
                textAlign: TextAlign.center,
                style: TextStyle(
                  color: Colors.white,
                  fontSize: 18.0,
                )),
            iconAssetPath: 'assets/heart.png'),
        boarder.PageModel(
          color: const Color(0xFF9B90BC),
          heroAssetPath: 'assets/heart.png',
          title: Text('Store',
              style: TextStyle(
                fontWeight: FontWeight.w800,
                color: Colors.white,
                fontSize: 34.0,
              )),
          body: Text('All local stores are categorized for your convenience',
              textAlign: TextAlign.center,
              style: TextStyle(
                color: Colors.white,
                fontSize: 18.0,
              )),
          iconAssetPath: 'assets/heart.png',
        ),
    ];
    
    
    class Onboarding extends StatelessWidget {
    
      @override
      Widget build(BuildContext context) {
        return Scaffold(
          body: boarder.FancyOnBoarding(
            doneButtonText: "Done",
            skipButtonText: "Skip",
            pageList: pageList,
            onDoneButtonPressed: () =>
                Navigator.of(context).pushReplacementNamed('/mainPage'),
            onSkipButtonPressed: () =>
                Navigator.of(context).pushReplacementNamed('/mainPage'),
          ),
        );
      }
    }
    

    Running Flutter (Channel beta, v1.17.0, on Mac OS X 10.15.4 19E287, locale en-NO)

    opened by madebycm 7
  • Please upgrade versions

    Please upgrade versions

    Because image >=3.0.0-nullsafety.0 <3.0.1 depends on xml ^5.0.0-nullsafety.1 and image >=3.0.1 depends on xml ^5.0.0, image >=3.0.0-nullsafety.0 requires xml ^5.0.0-nullsafety.1. And because flutter_launcher_icons >=0.9.0 depends on image ^3.0.0-nullsafety.0, flutter_launcher_icons >=0.9.0 requires xml ^5.0.0-nullsafety.1. And because fancy_on_boarding >=1.7.0 depends on flutter_svg ^0.19.1 which depends on xml ^4.2.0, flutter_launcher_icons >=0.9.0 is incompatible with fancy_on_boarding >=1.7.0. So, because senio_assist depends on both fancy_on_boarding ^1.7.0 and flutter_launcher_icons ^0.9.0, version solving failed.

    opened by vytautas-pranskunas- 4
  • allows user to change the bottom margin

    allows user to change the bottom margin

    this allows the users to change the margin bottom of the pagination & "DONE" buttons. they can use the "bottomMargin" argument to do change the bottom margin.

    opened by boulama 2
  • How to build a widget instead of the final pageList?

    How to build a widget instead of the final pageList?

    I am using the plugins for an app but it has two languages ​​and I use the context property to be able to translate the string of the title and the body of the pageModel however I have an error because I don't have a context for that ... how could I create a widget that allow to use buildcontext and in this way use languages?

    my code: final pageList = [ PageModel( color: dBlueSkyColor, heroAssetPath: 'assets/images/delivery1.png', title: Text('SAVE MONEY', style: GoogleFonts.montserrat( fontWeight: FontWeight.w800, color: dOrangeColor, fontSize: 30.0, )), body: Text( 'Weekly best deals picked by our price comparison team', textAlign: TextAlign.center, style: GoogleFonts.montserrat( color: dOrangeColor, fontSize: 15.0, ), ), iconAssetPath: 'assets/icons/postal.png', ), PageModel( color: const Color(0xFF65B0B4), heroAssetPath: 'assets/images/delivery2.png', title: Text('SAVE TIME', style: GoogleFonts.montserrat( fontWeight: FontWeight.w800, color: Colors.white, fontSize: 30.0, )), body: Text( 'Shop from over 1200 local stores at your fingertips', textAlign: TextAlign.center, style: GoogleFonts.montserrat( color: Colors.white, fontSize: 15.0, ), ), iconAssetPath: 'assets/icons/business.png', ), PageModel( color: const Color(0xFF9B90BC), heroAssetPath: 'assets/images/delivery3.png', title: Text('HOME DELIVERY', style: GoogleFonts.montserrat( fontWeight: FontWeight.w800, color: Colors.white, fontSize: 30.0, )), body: Text("You get everything you'd want from your local store to your door", textAlign: TextAlign.center, style: GoogleFonts.montserrat( color: Colors.white, fontSize: 15.0, )), iconAssetPath: 'assets/icons/over.png', ), ];

    instead of using plain text use S.of(context).simpleText with error in context

    opened by NestorDevs 1
  • Page class collides with new Navigator 2.0 Page class

    Page class collides with new Navigator 2.0 Page class

    See https://github.com/flutter/flutter/blob/beta/packages/flutter/lib/src/widgets/navigator.dart#L500

    The package no longer works with any Flutter version that uses Navigator 2.0

    opened by kuhnroyal 1
  • Landscape View : RenderFlex Overflowed

    Landscape View : RenderFlex Overflowed

    How Can I show Landscape view of my fancy-on-boarding? Whenever I turn my app in landscape mode, it appears to me that RenderFlex overflowed! So How can I solve it?

    opened by thealiflab 1
  • Other options to put widgets in Title and Body

    Other options to put widgets in Title and Body

    I just want to know that your parameters in PageModel of Title and Body have Text widget only, why not make it as "Widget"? so that we can have wide range of widgets to choose in each pagemodel

    enhancement hacktoberfest 
    opened by vinceramcesoliveros 1
  • Added web and desktop support

    Added web and desktop support

    • updated flutter_svg package version to latest 1.1.5
    • added web and desktop apps in example
    • updated old android app in example
    • handling network svg pictures in [FancyImage]
    • using PositionedDirectional instead of Positioned in [FancyOnBoarding]
    opened by wmfadel 0
Owner
Sahil Kumar
Flutter Engineer at @GetStream
Sahil Kumar
OnBoarding Animation provides page like animation to the onBoarding screens with the page indicator

OnBoarding Animation OnBoarding Animation provides page like animation to the onBoarding screens with the page indicator. Screenshots and Screen recor

null 13 Oct 12, 2022
Onboarding Screen

SKOnBoarding Screen A library that walks a user through multiple on-boarding screens in a simple and easy way GIF ?? Installation You just need to add

Senthil_Kumar 28 Nov 4, 2022
Onboarding flow and login screen made with flutter πŸ’–.

?? ?? Flutter Animated Onboarding And Login Page Flutter project for creating animated onboarding and login screen. Star ⭐ the repo if you like what y

Manish Dayma 5 Nov 26, 2022
Doctor Consultation App in Flutter containing splash screen on boarding screen Routing state management Dash board Bottom navigation Decorated Drawer and Doctors Screen in the last.

Online doctor Consultation App UI in Flutter Doctor Consultation App UI in Flutter Visit Website Features State Management Navigation Bar Responsive D

Habib ullah 14 Jan 1, 2023
Android test task master - Create PIN code screen, authentication by PIN code screen and menu screen

Here is described test tasks for a android dev. Need to implement three screens:

null 3 Oct 4, 2022
User onboarding library with smooth animation of objects and background colors

SlidingTutorial Cleveroad introduces Sliding Tutorial Library for Flutter Hey guys, hope you haven’t started developing a tutorial for your Flutter ap

Cleveroad 127 Dec 31, 2022
Fancy Containers Flutter Package

Fancy Containers Fancy container package lets you add a beautiful gradient container to your Flutter app. Installation Add the latest version of packa

Aditya Thakur 9 Oct 27, 2022
A basic demonstration for creating a Jardinains (Fancy Pong-Like) Game in Flutter

Jardinains Flutter! ?? Play Here - Web https://flutter-jardinains.web.app/#/ Demo Note: For optimal performance run the project in profile mode using

Paras Jain 60 Nov 12, 2022
A fancy easy to use Folding Menu for Flutter Applications

Folding Menu This is an easy to use package for adding Folding Menu to your Flutter Applications Demo Usage To Use, simply add Folding Menu to your St

Paras Jain 12 Nov 26, 2022
Fancy list loading effect or The Shimmer Effect in Flutter

Shimmer Effect in Shimmer Effect is really cool placeholder effect that you can show when you are loading data in the form of a list. To do it in flut

Ronak Punase 31 Oct 18, 2022
This is an easy to use Flutter Package for adding Fancy Foldable Sidebar to your Flutter Applications.

Foldable Sidebar An easy to implement Foldable Sidebar Navigation Drawer for Flutter Applications. Current Features Initial Release for Foldable Navig

Paras Jain 87 Nov 26, 2022
A fancy yet beautiful animated widget for your Flutter apps

FancyBar A fancy yet beautiful animated widget for your Flutter apps | Preview Version 1 | |---------|----------| | | | Preview Version 2 | |---------

Leo Elstin 33 Oct 10, 2022
A flutter Package provides you a modern animated fancy segment

animated_segment This package will animates a segment. Package provides you a mo

MindInventory 24 Dec 10, 2022
A fancy animated bottom navigation bar πŸ’«.

Stacky_bottom_nav_bar A fancy animated bottom navigation bar. Preview Default Light Mode Default Dark Mode ⚠️ IMPORTANT: when adding this widget don’t

null 5 Oct 23, 2022
App onboarding build in Flutter

onboarding_flutter App onboarding build in Flutter Getting Started This project is a starting point for a Flutter application. A few resources to get

Baljeet Singh 1 Jul 24, 2022
A beautifully crafted app that takes you through an onboarding experience

Onboarding App davidcobbina.com Beautifully crafted with flutter and love, a useful UI Kit for developers and designers who want to kick start their a

David-Legend 80 Dec 3, 2022
Arisonboardingscreen - Create your custom and beautiful onboarding screens easily with Flutter

Flutter Tutorial - Onboarding UI Screen Create your custom and beautiful onboard

Behruz Hurramov 5 Oct 30, 2022
Flutter-Onboarding-UI-Concept - A Flutter conceptual design for on boarding screens for mobile apps

flutter_onboarding_ui_concept A conceptual design for on boarding screens for mobile apps. This app provides you with all the information you need to

CODEHOMIE 265 Dec 25, 2022
A Flutter plugin for changing the Home Screen, Lock Screen (or both) Wallpaper on Android devices.

wallpaper_manager A Flutter plugin for changing the Home Screen, Lock Screen (or both) Wallpaper(s) on Android devices. Usage Installation In the pubs

Aditya Mulgundkar 38 Nov 28, 2022