OnBoardingIntro

Say Thanks!

A OnBoarding Intro Screen Library for Easy and Quick Usage.

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

Show some :heart: and star the repo to support the project

Open Source Love License

GIF

GIF

💻 Installation

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

onboarding_intro: <latest_version>

❔ Usage

Import this class

import 'package:onboarding_intro/onboarding_intro.dart';

Create a List of OnBoardingData

  List<OnBoardingData> data = [
    OnBoardingData('images/onboarding1.svg',
        'First Screen Description...',
        isSvg: true),
    OnBoardingData(
      'images/onboarding2.svg',
      'Second Screen Description...',
      isSvg: true,
    ),
    OnBoardingData(
      'images/onboarding3.svg',
      'Third Screen Description...',
      isSvg: true,
    ),
  ];

Pass it into the OnBoardingIntro widget

  @override
  Widget build(BuildContext context) {
   return Scaffold(
      key: _key,
      body: OnBoardingIntro(
        isSvgImage: true,
        selectedColor: Color(0xff35200b),
        unSelectedColor: Colors.grey,
        finishText: 'Home',
        nextText: 'Next',
        backText: 'Back',
        skipText: 'Skip',
        onFinalClicked: () {
         Scaffold.of(context).showSnackBar(SnackBar(content: Text('Finished')));
        },
        onSkipClicked: () {
          Scaffold.of(context).showSnackBar(SnackBar(content: Text('Skiped')));
        },
        logoImage: 'images/logo.svg',
        style: TextStyle(
            fontSize: 17, fontWeight: FontWeight.bold, wordSpacing: 2),
        data: data,
      ),
    );
  }

🎨 Customization and Attributes

OnBoardingIntro attributes

Attribute Name Example Value Description
data List<OnBoardingData> The list of pages to be displayed
onFinalClicked (){} Function to be called on pressing done button
onSkipClicked (){} Function to be called on pressing skip button
finishText "Let's Go" Done button text "
skipText "Skip" Skip button text "
nextText "Next" Next button text "
isSvgImage true Logo image should be svg or not. Defaults to true
logoImage 8.0 App logo Image
style TextStyle(fontSize: 17, fontWeight: FontWeight.bold, wordSpacing: 2) Custom text style for details text
selectedColor Color(0xff35200b) selected color content defualt is Colors.blue
unSelectedColor Color(0xff35200b) selected color content defualt is Colors.grey

Contributors ✨

Thanks goes to these wonderful people (emoji key):


Ahmed Eslayed

💻

📃 License

Copyright (c) 2012 Pharous

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.

Libraries

image
indicator
on_boarding_model
onboarding_intro