onboardme 1.2.0

  • Readme
  • Changelog
  • Example
  • Installing
  • 85

On-Board Me #

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.

Build Status Build Status Build Status Build Status Build Status Build Status

Screenshots #

PieChart PieChart PieChart

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 #

    • [ ] Add new on boarding screens
    • [ ] 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. Fork 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

Changelog #

[1.2.0] - Current Release #

  • Context issue fixed

[1.1.3] - Current Release #

  • No need of context when navigating

[1.1.2] - Current Release #

  • console output in skip button fix

[1.1.1] - Current Release #

  • Home route bug fixed
  • Image Url bug fix

[1.0.0] - Current Release #

  • Added Example
  • Fix Android crashes

[0.0.1] - Initial Release #

example/lib/example.dart

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

class Example extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return 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/',
    );
  }
}

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  onboardme: ^1.2.0

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:onboardme/onboardme.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
71
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
85
Learn more about scoring.

We analyzed this package on Jul 3, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.8.4
  • pana: 0.13.13
  • Flutter: 1.17.5

Analysis suggestions

Package not compatible with SDK dart

because of import path [onboardme] that is in a package requiring null.

Health suggestions

Fix lib/src/on_boarding_me.dart. (-0.50 points)

Analysis of lib/src/on_boarding_me.dart reported 1 hint:

line 10 col 7: This class (or a class that this class inherits from) is marked as '@immutable', but one or more of its instance fields aren't final: OnboardingMe.numOfPage, OnboardingMe.noOfBackgroundColor, OnboardingMe.bgColor, OnboardingMe.screenContent, OnboardingMe.ctaText, OnboardingMe.isPageIndicatorCircle, OnboardingMe.homeRoute

Format lib/utilities/widgets/onboarding_screen/call_to_action_widget.dart.

Run flutter format to format lib/utilities/widgets/onboarding_screen/call_to_action_widget.dart.

Format lib/utilities/widgets/onboarding_screen/skip_button.dart.

Run flutter format to format lib/utilities/widgets/onboarding_screen/skip_button.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.12 1.14.13
meta 1.1.8
sky_engine 0.0.99
typed_data 1.1.6 1.2.0
vector_math 2.0.8
Dev dependencies
flutter_test