overlay_tutorial 3.0.0
overlay_tutorial: ^3.0.0 copied to clipboard
A Flutter package for displaying overlay tutorial by cutting a hole on widget. It allows also to add hint aside the hole.
2.2.2 21/03/2022 #
- Fix broken screenshot in README.
2.2.0 20/03/2022 #
- Fix #34.
OverlayTutorialScope
never callsOverlayTutorialWidgetHint
builder ofOverlayTutorialCustomShapeEntry
.Breaking API Changes #
WidgetFromEntryBuilder
no longer providesrect
&rRect
. We merged them intoentryRect
of typeOverlayTutorialEntryRect
.-
Migration steps:
From
(context, rect, rRect) { return Positioned( top: rRect.top, left: rRect.left, child: Text('Hello'), ); }
To
(context, entryRect) { return Positioned( top: entryRect.rRect!.top, left: entryRect.rRect!.left, child: Text('Hello'), ); }
-
2.1.1 9/12/2021 #
- Add test
- Fix for flutter#91753 compatibility
2.1.0 6/11/2021 #
- Improve package performance.
- Previous version tends to rebuild recursively non-stop which is fixed in this release.
- Add more example
- Check the
example
project. - Due to community request, concrete example for disabling widget is added. Check
SimpleCounterTutorial
widget inexample
project.
- Check the
2.0.4 19/6/2021 #
- Update CHANGELOG.md.
2.0.3 19/6/2021 #
- Patch #23.
- Fix widget rebuild too frequently
- Fix FlutterError due to using setState when widget has already disposed
2.0.0 22/3/2021 #
- Complete enhancement#10.
Breaking API Changes #
is removed. UseOverlayTutorial
OverlayTutorialScope
instead.OverlayTutorialScope
does not take all theOverlayTutorialEntry
, pass these in new widget,OverlayTutorialHole
.OverlayTutorialHole
handles theOverlayTutorialEntry
. WrapOverlayTutorialHole
with your widget that intends to make hole. Thus, you no longer need to provide anyGlobalKey
.OverlayTutorialEntry
no longer takeswidgetKey
as argument.is removed. Use the property inOverlayTutorialController
OverlayTutorialScope
&OverlayTutorialHole
to control the visibility of the overlay tutorial.
1.0.0 10/3/2021 #
- Support dart null-safety.
0.2.1 7/9/2020 #
- Allow package to be used on flutter 1.17.5
0.2.0 5/9/2020 #
- Fix Overlay Entry delay in production.
0.1.2 1/9/2020 #
- Hotfix - Overlay not showing on first time
0.1.1 1/9/2020 #
- Remove print statement
- Make
shapeBuilder
required inOverlayTutorialCustomShapeEntry
- Improve documentation.
0.1.0 29/8/2020 #
- Improve performance by preventing canvas from drawing continuously.
0.0.8 28/8/2020 #
- Bugfix & Improve documentation
0.0.7 28/8/2020 #
- Breaking API Changes:
OverlayTutorialEntry
is now an abstract class, useOverlayTutorialRectEntry
instead. - Introduce
OverlayTutorialCircleEntry
&OverlayTutorialCustomShapeEntry
for drawing other shape. - Change use of
addPersistentFrameCallback
toaddTimingsCallback
as the former will cause Flutter Inspector Select Widget mode to be malfunction.
0.0.6 27/8/2020 #
- Remove print statement
0.0.5 27/8/2020 #
- Show
overlayTutorialEntries
&overlayChildren
only aftershowOverlayTutorial
is called.
0.0.4 27/8/2020 #
- Handle SafeArea
0.0.3 26/8/2020 #
- Add Description to
pubspec.yaml
0.0.2 26/8/2020 #
- Fix README image
0.0.1 26/8/2020 #
- Initial release
- Add OverlayTutorial widget