Merge pull request #24 from emreesen27/develop-v110

1.1.0 done.

CHANGELOG.md

@@ -1,3 +1,8 @@
+## [1.1.0] - 20.05.2022
+* Bug Fix.
+* Cancel option added.
+* Dialog status callback added.
+
 ## [1.0.9] - 09.12.2022
 * Assets path edited.
 * The close function can be used with delay.

README.md

@@ -7,7 +7,7 @@ Progress dialog package for flutter
 You must add the library as a dependency to your project.
 ```yaml
 dependencies:
- sn_progress_dialog: ^1.0.9
+ sn_progress_dialog: ^1.1.0
 ```
 
 You should then run `flutter packages get`

example/README.md

@@ -28,6 +28,11 @@ class Home extends StatelessWidget {
       max: 100,
       msg: 'File Downloading...',
       progressBgColor: Colors.transparent,
+      cancel: Cancel(
+        cancelClicked: () {
+          /// ex: cancel the download
+        },
+      ),
     );
     for (int i = 0; i <= 100; i++) {
       /// You don't need to update state, just pass the value.

example/lib/main.dart

@@ -25,6 +25,11 @@ class Home extends StatelessWidget {
       max: 100,
       msg: 'File Downloading...',
       progressBgColor: Colors.transparent,
+      cancel: Cancel(
+        cancelClicked: () {
+          /// ex: cancel the download
+        },
+      ),
     );
     for (int i = 0; i <= 100; i++) {
       /// You don't need to update state, just pass the value.

example/pubspec.lock

@@ -99,7 +99,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "1.0.9"
+    version: "1.1.0"
   source_span:
     dependency: transitive
     description:

lib/options/cancel.dart

@@ -0,0 +1,25 @@
+import 'package:flutter/material.dart';
+
+class Cancel {
+  /// [cancelClicked] If you want to execute an action when the dialog is canceled, pass a void function.
+  // (Default: null)
+  final GestureTapCallback? cancelClicked;
+
+  /// [cancelImage] The default does not contain any value, if the value is assigned another asset image is created.
+  final AssetImage? cancelImage;
+
+  /// [cancelImageSize] set cancel image dimensions
+  // (Default: 15.0)
+  final double cancelImageSize;
+
+  /// [cancelImageColor] set cancel image color
+  // (Default: black)
+  final Color? cancelImageColor;
+
+  Cancel({
+    this.cancelClicked,
+    this.cancelImage,
+    this.cancelImageSize = 15.0,
+    this.cancelImageColor = Colors.black,
+  });
+}

lib/completed.dart → lib/options/completed.dart

@@ -3,7 +3,7 @@ import 'package:flutter/material.dart';
 class Completed {
   /// [completedMsg] Assign the completed Message
   // (Default: "completed")
-  final String completedMsg;
+  String completedMsg;
 
   /// [completionDelay] The time the dialog window will wait to close
   // (Default: 1500 ms)

lib/progress_dialog.dart

@@ -1,10 +1,13 @@
 import 'package:flutter/material.dart';
-import 'package:sn_progress_dialog/completed.dart';
+import 'package:sn_progress_dialog/options/completed.dart';
+import 'package:sn_progress_dialog/options/cancel.dart';
 
 enum ValuePosition { center, right }
 
 enum ProgressType { normal, valuable }
 
+enum DialogStatus { opened, closed, completed }
+
 class ProgressDialog {
   /// [_progress] Listens to the value of progress.
   //  Not directly accessible.
@@ -22,6 +25,10 @@ class ProgressDialog {
   // Can only be accessed with the constructor.
   late BuildContext _context;
 
+  /// [_onStatusChanged] Keeps track of the current status of the dialog window.
+  // Value assignment is done later.
+  ValueChanged<DialogStatus>? _onStatusChanged;
+
   ProgressDialog({required context}) {
     this._context = context;
   }
@@ -39,6 +46,7 @@ class ProgressDialog {
       if (_dialogIsOpen) {
         Navigator.pop(_context);
         _dialogIsOpen = false;
+        setDialogStatus(DialogStatus.closed);
       }
     });
   }
@@ -48,6 +56,11 @@ class ProgressDialog {
     return _dialogIsOpen;
   }
 
+  ///[setDialogStatus] Dialog window sets your new state.
+  void setDialogStatus(DialogStatus status) {
+    if (_onStatusChanged != null) _onStatusChanged!(status);
+  }
+
   /// [_valueProgress] Assigns progress properties and updates the value.
   //  Not directly accessible.
   _valueProgress({Color? valueColor, Color? bgColor, required double value}) {
@@ -87,6 +100,9 @@ class ProgressDialog {
   /// [completed] Widgets that will be displayed when the process is completed are assigned through this class.
   // If an assignment is not made, the dialog closes without showing anything.
 
+  /// [cancel] Use it to have a close button on the dialog.
+  // Manage other properties related to cancel button via this class.
+
   /// [hideValue] If you are not using the progress value, you can hide it.
   // Default (Default: false)
 
@@ -98,6 +114,7 @@ class ProgressDialog {
     required int max,
     required String msg,
     Completed? completed,
+    Cancel? cancel,
     ProgressType progressType: ProgressType.normal,
     ValuePosition valuePosition: ValuePosition.right,
     Color backgroundColor: Colors.white,
@@ -117,9 +134,12 @@ class ProgressDialog {
     bool barrierDismissible: false,
     bool hideValue: false,
     int closeWithDelay: 100,
+    ValueChanged<DialogStatus>? onStatusChanged,
   }) {
     _dialogIsOpen = true;
     _msg.value = msg;
+    _onStatusChanged = onStatusChanged;
+    setDialogStatus(DialogStatus.opened);
     return showDialog(
       barrierDismissible: barrierDismissible,
       barrierColor: barrierColor,
@@ -137,13 +157,38 @@ class ProgressDialog {
             valueListenable: _progress,
             builder: (BuildContext context, dynamic value, Widget? child) {
               if (value == max) {
+                setDialogStatus(DialogStatus.completed);
                 completed == null
                     ? close(delay: closeWithDelay)
                     : close(delay: completed.completionDelay);
               }
               return Column(
                 mainAxisSize: MainAxisSize.min,
                 children: [
+                  cancel != null
+                      ? Align(
+                          alignment: Alignment.topRight,
+                          child: InkWell(
+                            highlightColor: Colors.transparent,
+                            splashColor: Colors.transparent,
+                            onTap: () {
+                              close();
+                              if (cancel.cancelClicked != null)
+                                cancel.cancelClicked!();
+                            },
+                            child: Image(
+                              width: cancel.cancelImageSize,
+                              height: cancel.cancelImageSize,
+                              color: cancel.cancelImageColor,
+                              image: cancel.cancelImage ??
+                                  AssetImage(
+                                    "images/cancel.png",
+                                    package: "sn_progress_dialog",
+                                  ),
+                            ),
+                          ),
+                        )
+                      : Container(),
                   Row(
                     children: [
                       value == max && completed != null

lib/sn_progress_dialog.dart

@@ -2,4 +2,5 @@ library sn_progress_dialog;
 
 /// Exporting package files
 export 'progress_dialog.dart';
-export 'completed.dart';
+export 'options/completed.dart';
+export 'options/cancel.dart';

pubspec.yaml

@@ -1,7 +1,6 @@
 name: sn_progress_dialog
 description: Customizable progress dialog package for Flutter.(Captures the progress value)
-version: 1.0.9
-author: A.Emre ESEN <emreesen27@gmail.com>
+version: 1.1.0
 homepage: https://github.com/emreesen27/Flutter-Progress-Dialog.git
 
 environment:
@@ -25,6 +24,7 @@ flutter:
 # To add assets to your package, add an assets section, like this:
   assets:
     - images/completed.png
+    - images/cancel.png
 #
 # For details regarding assets in packages, see
 # https://flutter.dev/assets-and-images/#from-packages