OneContext provides a simple way to deal with Dialogs, Overlays, Navigations, Theme* and MediaQuery* with no need of BuildContext.
If you are Flutter developer, you don’t have to learn something new. This package use the same identificators and names from framework. It’s not a specialized* implementation, so you have the power to create and do not get blocked because of that.
If you are Flutter package developer, OneContext can be very useful too! You can create a custom dialogs package with no need BuildContext, and release a version, that do not depends of the context, to the comunity.
BuildContext always is needed (in some cases we need to choose carefully the specific one to make things work as expected), but, to global things, like dialogs, it can be reached by OneContext package. 🎯
/// important: Use [OneContext().builder] in `MaterialApp` builder, in order to show dialogs and overlays.
/// important: Use [OneContext().key] in `MaterialApp` navigatorKey, in order to navigate.
return MaterialApp(
builder: OneContext().builder,
navigatorKey: OneContext().key,
...
); OneContext().pushNamed('/detail_page'); OneContext.instance.pushNamed('/detail_page'); OneContext().navigator.pushNamed(...);
OneContext().dialog.showDialog(...);
OneContext().overlay.addOverlay(...); OneContext().pushNamed(...);
OneContext().showDialog(...);
OneContext().addOverlay(...);
// and can access info from:
// OneContext().mediaQuery ...
// OneContext().textTheme ...
// OneContext().theme ...- Fast (O(1))
- Easy to learn/use
- It use same native function names from Flutter, to keep it simple and intuitive ;)
// example snackBar
OneContext().showSnackBar(
builder: (_) => SnackBar(content: Text('My awesome snackBar!'))
);// example dialog
OneContext().showDialog(
// barrierDismissible: false,
builder: (_) => AlertDialog(
title: new Text("The Title"),
content: new Text("The Body"),
)
);// example bottomSheet
OneContext().showBottomSheet(
builder: (context) => Container(
alignment: Alignment.topCenter,
height: 200,
child: IconButton(
icon: Icon(Icons.arrow_drop_down),
iconSize: 50,
color: Colors.white,
onPressed: () => Navigator.of(context).pop('sucess')), // or OneContext().popDialog('sucess');
),
);// example modalBottomSheet
OneContext().showModalBottomSheet<String>(
builder: (context) => Container(
child: Column(
mainAxisSize: MainAxisSize.min,
children: <Widget>[
ListTile(
leading: Icon(Icons.music_note),
title: Text('Music'),
onTap: () => OneContext().popDialog('Music'); //Navigator.of(context).pop('Music')),
ListTile(
leading: Icon(Icons.videocam),
title: Text('Video'),
onTap: () => Navigator.of(context).pop('Video'),
),
SizedBox(height: 45)
],
),
)
);// go to second page using named route
OneContext().pushNamed('/second');// go to second page using MaterialPageRoute
OneContext().push(MaterialPageRoute(builder: (_) => SecondPage()));// go back from second page
OneContext().pop();// Pop dialogs
OneContext().popDialog();// Retrieve data from route when it's pops
String result = await OneContext().push<String>(MaterialPageRoute(builder: (_) => SecondPage()));
print(result);// show the default progress indicator
OneContext().showProgressIndicator();// hide the default progress indicator
OneContext().hideProgressIndicator();// show the default progress indicator with some colors
OneContext().showProgressIndicator(
backgroundColor: Colors.blue.withOpacity(.3),
circularProgressIndicatorColor: Colors.white
);
// Later
OneContext().hideProgressIndicator();// Show a custom progress indicator
OneContext().showProgressIndicator(
builder: (_) => MyAwesomeProgressIndicator();
);
// Later
OneContext().hideProgressIndicator();// Show a custom widget in overlay stack
String myCustomAndAwesomeOverlayId = UniqueKey().toString();
OneContext().addOverlay(
overlayId: myCustomAndAwesomeOverlayId,
builder: (_) => MyCustomAndAwesomeOverlay()
);
// Later
OneContext().removeOverlay(myCustomAndAwesomeOverlayId);OneNotification<OneThemeChangerEvent>(
stopBubbling: true, // avoid bubbling to ancestors
builder: (_, __) {
return MaterialApp(
builder: OneContext().builder,
themeMode: OneThemeController.initThemeMode(ThemeMode.light),
theme: OneThemeController.initThemeData(ThemeData(brightness: Brightness.light)),
darkTheme: OneThemeController.initDarkThemeData(ThemeData(brightness: Brightness.dark)),
...
);
);
// Later...
OneContext().oneTheme.toggleMode();
// Or change only the dark theme
OneContext().oneTheme.changeDarkThemeData(
ThemeData(
primarySwatch: Colors.amber,
brightness: Brightness.dark
)
);First define the data type in type generics, after that, you can rebuild multiple ancestors widgets that listen the same data type. This is used for the package in this example, to change ThemeMode and Locale and even Restart the app entirely.
OneNotification<List<Locale>>(
onVisited: (context, localeList) {
print('widget visited!');
},
stopBubbling: true, // avoid the data bubbling to ancestors widgets
initialData: _localeEnglish, // [data] is null during boot of the application, but you can set initialData
rebuildOnNull: true, // Allow other entities reload this widget without messing up currenty data (Data is cached on first event)
builder: (context, localeList) {
return MaterialApp(
supportedLocales: localeList,
);
},
);// My Specialized Event
class MySpecializedEvent {
final String text;
MySpecializedEvent(this.text);
}
// Widget
OneNotification<MySpecializedEvent>(
builder: (context, event) {
return Text(event.text);
},
)
// Later, in children, call `OneNotifier.notify` to get ancestors notified
OneNotifier.notify(
context,
NotificationPayload(
data: MySpecializedEvent('Nice!');
)
);// Place that widget on most top
OneNotification(
builder: (_, __) => child
);
// Later... in children
// Dont lose state
OneNotification.softReloadRoot(context);
// Lose state
OneNotification.hardReloadRoot(context);// Set the main() function
void main() => OnePlatform.app = () => MyApp();
// Later... Call reboot without recreating root app
OnePlatform.reboot();
// Later... Call reboot recreating the entire application
OnePlatform.reboot(
builder: () => MyApp()
);
// You even can load an entire different app
OnePlatform.reboot(
builder: () => MyApp2()
);print('Platform: ' + OneContext().theme.platform); // TargetPlatform.iOS
print('Orientation: ' + OneContext().mediaQuery.orientation); // Orientation.portrait[IMPORTANT] If you need get widget rebuild on theme data changes using OneContext().oneTheme.toggleMode();, please consider to use the traditional way Theme.of(context) when getting theme data inside widget.
@override
Widget build(BuildContext context) {
return Container(
color: Theme.of(context).primaryColor, // Theme.of(context)
height: 100,
width: 100,
);
}
e.g.
@override
Widget build(BuildContext context) {
// Get changes by you currently context, and ensure the rebuild on theme data changes on
// OneContext().oneTheme.toggleMode(), OneContext().oneTheme.changeDarkThemeData() or OneContext().oneTheme.changeThemeData() events.
Theme.of(context);
return Container(
color: OneContext().theme.primaryColor, // OneContext().theme
height: 100,
width: 100,
);
}
@override
void initState() {
super.initState();
OneContext().showDialog(
builder: (_) => AlertDialog(
title: new Text("On Page Load"),
content: new Text("Hello World!"),
),
);* OneContext().theme and OneContext().mediaQuery are global instances of the root of the widget tree. Use it with care! It can reproduce unexpected behavior if you don't understand it.
* OneContext().context is like a root context, so, it should not be used directly, as it can reproduce unexpected behaviors, unless you have a understanding how it works. It shouldn't work well with InheritedWidget for example.
* This package only uses specialized implementation in Overlays, to make things easy and ensure a quick start.