Widget to display dots indicator to show a position (for a PageView for example).
You just need to add
dots_indicator as a dependency in your pubspec.yaml file.
dependencies: dots_indicator: ^1.0.0
In these example,
pageLength is the total of dots to display and
currentIndexPage is the position to hightlight (the active dot).
A simple dots indicator #
new DotsIndicator( dotsCount: pageLength, position: currentIndexPage )
Custom colors #
new DotsIndicator( dotsCount: pageLength, position: currentIndexPage, decorator: DotsDecorator( color: Colors.black87, activeColor: Colors.redAccent, ), )
Custom size #
You can change the default size of dots.
So you can choose to have dots for no active positions and a rounded rectangle for active position for example.
By default, the shape of dots is CircleBorder, so to have a rounded rectangle for active, you need to change
new DotsIndicator( dotsCount: pageLength, position: currentIndexPage, decorator: DotsDecorator( size: const Size.square(9.0), activeSize: const Size(18.0, 9.0), activeShape: RoundedRectangleBorder(borderRadius: BorderRadius.circular(5.0)), ), )
Custom shape #
You can change the default shape of dots. By default it's a CircleBorder.
You can change the no active and active dot shape.
new DotsIndicator( dotsCount: pageLength, position: currentIndexPage, decorator: DotsDecorator( shape: const Border(), activeShape: RoundedRectangleBorder(borderRadius: BorderRadius.circular(5.0)), ), )
Change the space between dots #
By default a dot have a margin of 6 pixels on his left and right. It's
But if you want you can change it, for example to increase the space between dots or to add top margin.
new DotsIndicator( dotsCount: pageLength, position: currentIndexPage, decorator: DotsDecorator( spacing: const EdgeInsets.all(10.0), ), )
Axis and reverse property #
There is two other property,
Axis is to display dots indicator horizontally (default) or vertically.
Also, you can set
reversed: true to reverse the order of dots. (default: false).
For example, if you want to display the dots indicator vertically, but with the first dots on bottom :
axis: Axis.vertical and
Obviously, you can use reversed with
- Set position to
doubleand add transition between dots (Thanks to PR#8)
axisproperty to have possibility to display dots as vertical
reversedproperty to display dots in reverse position
- Add example app
- Fix assert on
- BREAKING : Now dots customizations like color, size and spacing are provided by a DotsDecorator model with
- Fix full width of the widget. (Thanks to fvisticot)
- Publish on Pub
- Add asserts to avoid bug
- Initial Release
Demonstrates how to use the dots_indicator plugin.
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: dots_indicator: ^1.1.0
2. Install it
You can install packages from the command line:
$ 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:
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
We analyzed this package on Jan 21, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:
- Dart: 2.7.0
- pana: 0.13.4
- Flutter: 1.12.13+hotfix.5