super_pager 0.0.1

  • Readme
  • Changelog
  • Example
  • Installing
  • 48

SuperPager is made to extend Flutter's PageView with some additional features.

Table of contents #

Features #

  • Page indicator.

  • Next button.

  • Skip button.

Getting Started #

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

dependencies:
  super_pager: '^0.0.1'

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

Usage #

  • Just wrap your PageView widget with PageViewIndicator , and add some parameters.

    PageViewIndicator(
          child: PageView(children: _getPages()),
          onSkip: (ctx) => _navigateToOtherRoute(ctx),
          showNextButton: true,
          defaultDotColor: Colors.deepOrange,
          currentDotColor: Colors.pinkAccent,
          buttonsColor: Colors.lime,
          backgroundColor: Colors.blueGrey,
        )),
    

Documentation #

PageViewIndicator Class #

Dart attributeDatatypeDescriptionDefault Value
childPageViewPageView to be wrapped.@required
onSkipVoidCallbackMethod executes on tapping done button.Null
showNextButtonBoolShow the Next button at the end of the indicator footer.true
defaultDotColorColorSet the indicator default dot color.Theme.of(context).primaryColor
currentDotColorColorSet the current step indicator dot color.Theme.of(context).primaryColorDark
buttonsColorColorSet the color of the Next and Skip buttons.Null
backgroundColorColorSet the color of the footer's background.Null

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

License #

SuperPager is licensed under MIT license.

[0.0.1] - TODO: Add release date.

  • TODO: Describe initial release.

example/README.md

example #

A new Flutter project.

Getting Started #

This project is a starting point for a Flutter application.

A few resources to get you started if this is your first Flutter project:

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

Use this package as a library

1. Depend on it

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


dependencies:
  super_pager: ^0.0.1

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:super_pager/super_pager.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
9
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
70
Overall:
Weighted score of the above. [more]
48
Learn more about scoring.

We analyzed this package on Oct 23, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.5.1
  • pana: 0.12.21
  • Flutter: 1.9.1+hotfix.4

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Maintenance suggestions

The package description is too short. (-20 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

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