version update v1.0.4

mdgspace · Dec 9, 2019 · a15814f · a15814f
1 parent 32854fa
commit a15814f
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 394 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,8 @@
+## [1.0.4] - Dec 9,2019
+* Resolved bug for [initalOverlayWidget == null]
+* One of the three callbacks and list of panels is compulsory
+* added documentation
+
 ## [1.0.3] - Dec 8,2019
 
 * Updated description

diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ A flutter package to implement **ScrollyTelling** in your flutter app. Using Scr
 
 ```yaml
 dependencies:
-  scrollytell: ^1.0.3
+  scrollytell: ^1.0.4
 ```
 
 ### ⚡️ Import
@@ -28,16 +28,17 @@ import 'package:scrollytell/scrollytell.dart';
 | props  | type  | default value | Description |
 | :------------ |:---------------:| :------------:| :------------:|
 | panels (required)      | List Widget |       | A list of panel widgets |
-| panelStartCallback (required)     | Function(num, Function)      |  | Called on start of new panel |
-| panelEndCallback (required) | Function(num, Function)        | |Called on end of existing panel |
-| panelProgressCallback (required) | Function(num, double, Function) |  |Called every frame |
+| panelStartCallback | Function(num, Function)      |  | Called on start of new panel |
+| panelEndCallback| Function(num, Function)        | |Called on end of existing panel |
+| panelProgressCallback | Function(num, double, Function) |  |Called every frame |
 | opacity | double | 1 | Set opacity of the panels |
 | lastPanelForceComplete | bool | false | Set true if the last panel hits bottom of the screen and can't be scrolled through |
 | initialOverlayWidget | Widget | none | Overlay widget before start of scrolling |
 | guidelinePosition | GuidelinePosition | GuidelinePosition.top | Set position of guideline |
 | stickyChartIndex | int | null | The panel of corresponding index will dock at center when scrolled past the center |
 | showDebugConsole | bool | false | show debug console (activePanelIndex, progress)  and debug line (guideline) |
 
+**At least one of the panelStartCallback, panelProgressCallback, panelEndCallback must be non-null.**
 
 ## Terminology and Explanation
 

diff --git a/example/README.md b/example/README.md
@@ -4,5 +4,5 @@ These examples explain how to use the library.
 | -----------                              | --------- |
 | Show basic usage of ScrollyWidget | [code](https://github.com/mdg-iitr/scrollytell/tree/master/example/basic_usage)      |
 | Fancy Panel used in Animal Farm | [code](https://github.com/mdg-iitr/scrollytell/tree/master/example/animal_farm)      |
-| Life in Image | [code](https://github.com/mdg-iitr/scrollytell/tree/master/example/story_teller) |
+| Story Telling app | [code](https://github.com/mdg-iitr/scrollytell/tree/master/example/story_teller) |
 
diff --git a/example/basic_usage/lib/main.dart b/example/basic_usage/lib/main.dart
@@ -1,7 +1,6 @@
 import 'package:flutter/material.dart';
 import 'package:scrollytell/scrollytell.dart';
 
-
 void main() => runApp(MyApp());
 
 class MyApp extends StatelessWidget {
@@ -52,7 +51,6 @@ class _MyHomePageState extends State<MyHomePage> {
     double rad;
 
     Widget _scrollyWidget = ScrollyWidget(
-
       showDebugConsole: true,
       guidelinePosition: GuidelinePosition.center,
       opacity: 0.5,
@@ -151,6 +149,9 @@ class _MyHomePageState extends State<MyHomePage> {
       panelStartCallback: (activePanelNumber, func) {
         print('panel start callback $activePanelNumber');
       },
+      panelEndCallback: (endingPanelNumber, func) {
+        print('panel end callback $endingPanelNumber');
+      },
       lastPanelForceComplete: true,
     );