worm_indicator's Introduction

Worm Indicator

A Flutter PageView indicator insprired by worm animation. It can be easily integrated with any Flutter PageView. Pull requests are welcome

Features

Use with PageView to display scroll progress

Getting Started

Make sure you add the lib dependency in your flutter project.

dependencies:
  worm_indicator: 0.3.0

Then you should run flutter packages get to update your packages in your IDE.

Example Project

Checkout the project inside example folder.

Screenshot:

Usage

Circle and Square DotShape need size. Rectangle DotShape need width and height.

WormIndicator(
  length: 3,
  controller: _controller,
  shape: Shape(
    size: 16,
    spacing: 8,
    shape: DotShape.Circle  // Similar for Square
  ),
),

WormIndicator(
  length: 3,
  controller: _controller,
  shape: Shape(
    width: 16,
    height: 24,
    spacing: 8,
    shape: DotShape.Rectangle
  ),
),

Properties:

Name	Usage	Type
`length`	Number of dots	`int`
`controller`	PageView controller	`PageController`
`shape`	Shape of dots	`Shape`
`color`	Color of normal dots	`Color`
`indicatorColor`	Color of current active dot	`Color`

Shape Constructor:

Name	Usage	Type
`width`	Width of dot (required if shape is Rectange)	`double`
`height`	Height of dot (required if shape is Rectange)	`double`
`size`	Size of dot (required if shape is Circle or Square)	`double`
`spacing`	Spacing between dots	`double`
`shape`	Shape of dots. One of Circle, Rectangle and Square	`DotShape`

Support

Email me at [email protected] for any support needed

worm_indicator's People

Contributors

Stargazers

Watchers

worm_indicator's Issues

Required a customised worm indicator

First of all thank you very much for making such a beautiful animated page view indicator to see the progress of scroller or swipe.

How easy it is for you to customise this package as per below customisations in existing worn indicator:

I want to show the progress of new page appearing as well as progress of old page disappearing.
I don't want worm overlapping the space between dots. White Space should be visible always.

let me know if more information is required. Thanks in advance.