flutter_milestones 1.0.2 copy "flutter_milestones: ^1.0.2" to clipboard
flutter_milestones: ^1.0.2 copied to clipboard

A good way to show the progress of your workflow. Detailed progress is provided using the boolean value on each sub-point.

Flutter Milestones #

Pub Version License

Introduction #

This Package let you create a milestone timeline with gradients points and a list of sub-details where each one can be set as reached/enabled or not. Each milestone can have the same color or a different one. You can custom colors and font sizes as you prefer. Also it's possible to set a Widget as child of the milestone point to include it as shown in the preview.

What's new? #

Features Preview #

preview

Getting started #

Add dependency #

Please check the latest version before installation. If there is any problem with the new version, please use the previous version

dependencies:
  flutter:
    sdk: flutter
  # add flutter_milestones
  flutter_milestones: ^{latest version}

Usage #

Add the following imports to your Dart code #

import 'package:flutter_milestones/flutter_milestones.dart';

Parent Usage #

Milestones(
    items: [],
),

Child Usage Examples #

1. Red One

MilestoneElement(
    reached: true,
    title: 'Title 1',
    details: [
        (true, 'Detail 1'),
        (true, 'Detail 2'),
        (true, 'Detail 3')
    ],
    verticalDividerLength: 100,
    milestoneColor: Colors.red
)

red

2. Orange One

MilestoneElement(
    reached: true,
    title: 'Title 2',
    milestoneChild: Text(
        'Ok',
        style: TextStyle(
            color: Colors.black
        ),
    ),
    details: [
        (true, 'Detail 1'),
        (true, 'Detail 2'),
        (false, 'Detail 3')
    ],
    milestoneColor: Colors.orange
)

red

3. Blue One

MilestoneElement(
    reached: false,
    title: 'Title 3',
    milestoneChild: Icon(
        Icons.cancel_outlined,
        color: Colors.red,
    ),
    details: [
        (false, 'Detail 1'),
        (false, 'Detail 2'),
        (false, 'Detail 3')
    ],
    milestoneColor: Colors.blue
)

red

Properties #

Parent Properties #

Property Type Default Value Description
items List default The list of the MilestoneElement you want to show

MilestoneElement Properties #

Property Type Default Value Description
title String Empty String The title of your milestone
titleFontSize double 18 The title font size
reached bool false The value that represent your milestone is reached or not and will color the container representing it
details List<(bool, String)> Empty List The list representing the sub-points that can be set as reached or not and, in addition, the label to describe the sub-point itself
labelColor Color Colors.black the font color of the title and sub-points labels
milestoneColor Color Colors.white The color of the title and sub-points containers. If specified without specifying the milestoneGradient, this color will be use in a LinearGradient with white Color to determinate the milestone and sub-points gradient
milestoneGradient Gradient null The gradient used to color the milestone and sub-points containers. If not specified, will be considered the milestoneColor param
milestoneChild Widget null The widget to show inside the milestone container
verticalDividerLength double null The length of each milestone trace to the next one

Additional information #

Notes #

The Package is under development and I'm opened to every idea that can improve its functionality.

Support Me #

If you would like to help me improving my work, just consider to buy me a coffee

1
likes
160
pub points
12%
popularity

Publisher

verified publisherantwen.dev

A good way to show the progress of your workflow. Detailed progress is provided using the boolean value on each sub-point.

Repository (GitHub)
View/report issues

Documentation

API reference

License

MIT (license)

Dependencies

auto_size_text, flutter, gradient_borders

More

Packages that depend on flutter_milestones