A flutter package that helps you create on-boarding screen

on-boarding screen

a flutter package that helps you create on-boarding screen for your project with minutes just by passing a few parameters.

why we build?

can you build an on-boarding screen within minutes for your app? this is where we help you do that.

usage

import this class

import 'package:onboardme/src/on_boarding_me.dart';

add the on-boarding screen

onboardingme(
      /// number of pages for the screens
      numofpage: 5,

      /// no of colors you want for your screen
      noofbackgroundcolor: 4,

      /// list of background colors => in descending order
      bgcolor: [
        color(0xff3594dd),
        color(0xff4563db),
        color(0xff5036d5),
        color(0xff5b16d0),
      ],

      /// list of  call-to-action action
      ctatext: [
        'skip',
        'get started'
      ],

      /// list that maps your screen content
      screencontent: [
        {
          "scr 1 heading" : "screen 1 heading goes here",
          "scr 1 sub heading" : "screen 1 sub heading goes here",
          "scr 1 image path" : "assets/images/onboarding0.png",
        },
        {
          "scr 2 heading" : "screen 2 heading goes here",
          "scr 2 sub heading" : "screen 2 sub heading goes here",
          "scr 2 image path" : "assets/images/onboarding1.png",
        },
        {
          "scr 3 heading" : "screen 3 heading goes here",
          "scr 3 sub heading" : "screen 3 sub heading goes here",
          "scr 3 image path" : "assets/images/onboarding2.png",
        },
      ],

      /// bool for circle page indicator
      ispageindicatorcircle: true,

      /// home screen route that lands after on-boarding
      homeroute: '/home/',
    );

features

• you can customize your on boarding screens with content and styling.

todo

1. • [ ] add new on boarding screens
2. • [ ] add animation on the screens

contribution

the project is open for contribution. anyone willing to code fresh on-boarding screens, customize content for users will be welcomed.

1. download it
2. create your feature branch (git checkout -b my-new-feature)
3. commit your changes (git commit -m ‘add some feature’)
4. push to the branch (git push origin my-new-feature)
5. create new pull request