Skip to content
A light weight library to easily manage a progress dialog with simple steps whenever you need to do it. You can easily show and hide it.
Dart Java Objective-C Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update FUNDING.yml Nov 2, 2019
.idea update readme.md Sep 13, 2019
android added example package Jan 30, 2019
assets Added stateful widget code Mar 19, 2019
docs Update index.html Oct 15, 2019
example fixed onshow of dialog nav push bug Sep 13, 2019
lib fixed onshow of dialog nav push bug Sep 13, 2019
.gitignore Initial commit Jan 29, 2019
.metadata Initial commit Jan 29, 2019
CHANGELOG.md
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Oct 13, 2019
CONTRIBUTING.md Create CONTRIBUTING.md Oct 13, 2019
EXAMPLE.md fixed onshow of dialog nav push bug Sep 13, 2019
LICENSE Update LICENSE Jan 29, 2019
PULL_REQUEST_TEMPLATE.md Create PULL_REQUEST_TEMPLATE.md Oct 13, 2019
README.md Update README.md Oct 21, 2019
pd_demo_dd.gif Add files via upload Sep 13, 2019
pd_demo_nd.gif Add files via upload Sep 13, 2019
progress_dialog.iml Initial commit Jan 29, 2019
progress_dialog_1.png
progress_dialog_2.png
pubspec.lock Added custom styling for widget in runtime, background color, elevati… Aug 31, 2019
pubspec.yaml Added custom styling for widget in runtime, background color, elevati… Aug 31, 2019

README.md

progress_dialog

A light weight package to show progress dialog. As it is a stateful widget, you can change the text shown on the dialog dynamically.

  LinkedIn   Follow   Fork   Star   Watches

Get the library   Example

Supported Dart Versions

Dart SDK version >= 2.1.0

Demo

Normal dialog Demo Download dialog Demo

Installation

Pub

Add the Package

dependencies:
  progress_dialog: ^1.2.0

How to use

Import the package in your dart file

import 'package:progress_dialog/progress_dialog.dart';

Create an instance of ProgressDialog

ProgressDialog pr;

Initialise the pr object inside the build() method passing context to it

  1. Initialize the ProgressDialog object
    pr = new ProgressDialog(context);
  2. By default it is a normal dialog to show some message, if you would like to use it to show percentage of progress done, specify the optional type parameter and specify if you want your dialog to dismiss when back button is pressed isDismissible parameter (Optional)
    //For normal dialog
    pr = new ProgressDialog(context,type: ProgressDialogType.Normal, isDismissible: true/false, showLogs: true/false);
        
    //For showing progress percentage
    pr = new ProgressDialog(context,type: ProgressDialogType.Download, isDismissible: true/false, showLogs: true/false);
  3. Style the progress dialog (Optional)
    pr.style(
      message: 'Downloading file...',
      borderRadius: 10.0,
      backgroundColor: Colors.white,
      progressWidget: CircularProgressIndicator(),
      elevation: 10.0,
      insetAnimCurve: Curves.easeInOut,
      progress: 0.0,
      maxProgress: 100.0,
      progressTextStyle: TextStyle(
         color: Colors.black, fontSize: 13.0, fontWeight: FontWeight.w400),
      messageTextStyle: TextStyle(
         color: Colors.black, fontSize: 19.0, fontWeight: FontWeight.w600)
      );
    Note: You don't need to use all parameters, all of them are optional
    
  4. Showing the progress dialog
    pr.show();
  5. Dynamically update the content shown out there
    pr.update(
      progress: 50.0,
      message: "Please wait...",
      progressWidget: Container(
        padding: EdgeInsets.all(8.0), child: CircularProgressIndicator()),
      maxProgress: 100.0,
      progressTextStyle: TextStyle(
        color: Colors.black, fontSize: 13.0, fontWeight: FontWeight.w400),
      messageTextStyle: TextStyle(
        color: Colors.black, fontSize: 19.0, fontWeight: FontWeight.w600),
      );
    Note: You don't need to use all parameters, all of them are optional
    
  6. Dismissing the progress dialog
    pr.hide().then((isHidden) {
      print(isHidden);
    });

Navigating to next screens must be done after the completion of Future - hide(). See here for example

Check if progress dialog is showing

bool isProgressDialogShowing = pr.isShowing();
print(isProgressDialogShowing);

Demo

Normal dialog Demo Download dialog Demo

Default configuration/styles

If you don't like to configure/style the dialog and continue with the default style, it's okay but just have a look at our default configuration.

Attribute Value
Dismissible true
ProgressDialogType ProgressDialogType.Normal
BackgroundColor Colors.white
BorderRadius RoundedRectangularBorder(radius: 8.0)
AnimationCurve Curves.easeInOut
Elevation 8.0
ProgressWidget Double_rings_loding_indicator
MessageTextStyle color: Colors.black, fontSize: 19.0, fontWeight: FontWeight.w600
ProgressTextStyle color: Colors.black, fontSize: 13.0, fontWeight: FontWeight.w400
showLogs false

Well let's discuss limits for configuring it

Attribute Can be updated during instantiating Can be updated during styling Can be updated during dialog is shown
Dismissible Yes No No
ProgressDialogType Yes No No
BackgroundColor No Yes No
BorderRadius No Yes No
AnimationCurve No Yes No
Elevation No Yes No
ProgressWidget No Yes Yes
MessageTextStyle No Yes Yes
ProgressTextStyle No Yes Yes
ShowLogs Yes No No

Want to contribute?

Pull requests and issues are always welcome!

How to contribute?

  1. Fork the repository
  2. Clone it to your local machine
  3. Open the project in your favourite editor
  4. Open cmd/terminal and run flutter clean and then flutter packages get
  5. Make the changes
  6. Create a Pull Request

View the issues here

This library is only tested for Android, iOS contributors are most welcome


Loading indicator -> https://loading.io/

You can’t perform that action at this time.