tuxin_tutorial_overlay 0.1.0 tuxin_tutorial_overlay: ^0.1.0 copied to clipboard
an overlay package that can be used for tutorials and walkthrough
tuxin_tutorial_overlay #
an overlay flutter package that can be used for tutorials and walk-through
I was looking for an easier way to add tutorial walk-through to an existing app without cascading more elements into my app.
I wanted a walk-through that I can use as an overlay, that can have several widget behind it being shown, some widgets to allow interaction and some not, and also to be able to have specific shapes of holes (rect, oval and so on) so I made this :)
btw.. I'm new to flutter programming so I apologize for any mistakes and would appreciate any comments. thanks!
API #
WidgetData.dart
contains the following definitions:
enum WidgetShape { Oval, Rect, RRect }
- to define the shape of the hole that will grant the requested widget visibility (default is Oval).
the Widget Data class:
class WidgetData {
GlobalKey key;
WidgetShape shape;
bool isEnabled;
double padding;
WidgetData(
{@required this.key,
this.shape = WidgetShape.Oval,
this.isEnabled = true,
this.padding = 0});
}
you use it to define each widget's relevant properties, like padding, enabled/disabled (allow user interaction) and the shape of the hole in the Overlay
TutorialOverlayUtil.dart
contains the following function:
OverlayEntry createTutorialOverlay(
{List<WidgetData> widgetsData = const [],
Function onTap,
Color bgColor,
Widget description})
widgetsData
- is a List of each widget that you want to be fully visible and the relevant properties (padding, enable/disable interaction and hole shape)
onTap
- a callback that will be called when the user taps on the overlay itself
bgColor
- a custom background color. default is Black with opacity of 0.4.
description
- a Widget to display on top of the overlay, usually contains instructions on current frame
it also contains two functions that pretty much have only one line of code, it's just for users that are not familiar with overlay concepts so it will be easier for them to implement this package.
void showOverlayEntry(BuildContext context, OverlayEntry entry);
void removeOverlayEntry(OverlayEntry entry);
showOverlayEntry()
is used to show the overlay that you created earlier with createTutorialOverlay()
.
removeOverlayEntry()
is used to hide the overlay
- please note that you need to use the
createTutorialOverlay()
function only after the elements have been drawn in order to get their proper location and size. in my example I created the overlay at theinitState()
function of myStatefulWidget
, so in order for the elements to be drawn first I needed to execute the function inside a post callback:
import 'package:flutter/scheduler.dart';
...
@override
void initState() {
SchedulerBinding.instance.addPostFrameCallback((_) {
OverlayEntry tut1 = createTutorialOverlay(
...
)
);
showOverlayEntry(context, tut1);
});
Simple Example #
import 'package:flutter/material.dart';
import 'package:flutter/scheduler.dart';
import 'package:tuxin_tutorial_overlay/TutorialOverlayUtil.dart';
import 'package:tuxin_tutorial_overlay/WidgetData.dart';
void main() => runApp(MyApp());
class MyApp extends StatelessWidget {
@override
Widget build(BuildContext context) {
return MaterialApp(
title: 'Tux-In Tutorial Overlay Example',
theme: ThemeData(
primarySwatch: Colors.blue,
),
home: MyHomePage(title: 'Tutorial Overlay Example Page'),
);
}
}
class MyHomePage extends StatefulWidget {
MyHomePage({Key key, this.title}) : super(key: key);
final String title;
@override
_MyHomePageState createState() => _MyHomePageState();
}
class _MyHomePageState extends State<MyHomePage> {
int _counter = 0;
final GlobalKey buttonKey = GlobalKey();
final GlobalKey counterKey = GlobalKey();
@override
void initState() {
SchedulerBinding.instance.addPostFrameCallback((_) {
OverlayEntry tut1 = createTutorialOverlay(
bgColor: Colors.green.withOpacity(
0.4), // Optional. uses black color with 0.4 opacity by default
onTap: () => print("TAP"),
widgetsData: <WidgetData>[
WidgetData(key: buttonKey, isEnabled: true, padding: 4),
WidgetData(
key: counterKey, isEnabled: false, shape: WidgetShape.Rect)
],
description: Text(
'hello',
textAlign: TextAlign.center,
style: TextStyle(decoration: TextDecoration.none),
));
showOverlayEntry(context, tut1);
});
super.initState();
}
void _incrementCounter() {
setState(() {
_counter++;
});
}
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title: Text(widget.title),
),
body: Center(
child: Column(
mainAxisAlignment: MainAxisAlignment.center,
children: <Widget>[
Text(
'You have pushed the button this many times:',
),
Text(
'$_counter',
key: counterKey,
style: Theme.of(context).textTheme.display1,
),
],
),
),
floatingActionButton: FloatingActionButton(
onPressed: _incrementCounter,
tooltip: 'Increment',
key: buttonKey,
child: Icon(Icons.add),
),
);
}
}
to execute this code see the example app :)