Awesome

IntroViews is inspired by Paper Onboarding and developed with love from scratch. Checkout our fully responsive live example app.

Table of contents

• Features
• Getting Started
• Usage
• Documentation
  • PageViewModel Class
  • IntroViewFlutter Class
• Bugs or Requests
• Donate
• Contributors
• License

Features

• Easy addition of pages.

• Circular page reveal.

• Cool Animations.

• Animation control, if the user stops sliding in the midway.

• Skip button, for skipping the app intro.

• Custom font selection.

• Material Design.

Getting Started

You should ensure that you add the intro_views_flutter as a dependency in your flutter project.

dependencies:
  intro_views_flutter: '^3.2.0'

You can also reference the git repository directly if you want:

dependencies:
  intro_views_flutter:
    git: git://github.com/aagarwal1012/IntroViews-Flutter

You should then run flutter packages get in your terminal so as to get the package.

Usage

• IntroViewsFlutter widget require a list of PageViewModel , and some other parameters. Refer the code below to create a PageViewModel page.

  import 'package:intro_views_flutter/intro_views_flutter.dart';
  
  ...
  
  final page = PageViewModel(
      pageColor: const Color(0xFF607D8B),
        iconImageAssetPath: 'assets/taxi-driver.png',
        body: Text(
          'Easy  cab  booking  at  your  doorstep  with  cashless  payment  system',
        ),
        title: Text('Cabs'),
        mainImage: Image.asset(
          'assets/taxi.png',
          height: 285.0,
          width: 285.0,
          alignment: Alignment.center,
        ),
        titleTextStyle: TextStyle(fontFamily: 'MyFont', color: Colors.white),
        bodyTextStyle: TextStyle(fontFamily: 'MyFont', color: Colors.white),
      );
  

• Now refer the code below to get the IntroViewsFlutter widget.

  final Widget introViews = IntroViewsFlutter(
        page,
        onTapDoneButton: () {
          // Void Callback
        },
        showSkipButton: true,
        pageButtonTextStyles: TextStyle(
            color: Colors.white,
            fontSize: 18.0,
            fontFamily: 'Regular',
          ),
      );
  

  For further usage refer the example available.

  For Landscape preview click the link.

  Note : If you added more than four pages in the list then there might be overlapping between page icons and skip button, so my suggestion is just make the showSkipButton: false.

Documentation

PageViewModel Class

IntroViewFlutter Class

For help on editing package code, view the flutter documentation.

Bugs or Requests

If you encounter any problems feel free to open an issue. If you feel the library is missing a feature, please raise a ticket on GitHub and I'll look into it. Pull request are also welcome.

See Contributing.md.

Donate

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 :coffee:

• PayPal

Contributors

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome! See Contributing.md.

License

IntroViews-Flutter is licensed under MIT license.