Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emanuel-braz/one_context
pub: https://pub.dev/packages/one_context - OneContext provides a simple way to deal with Dialogs, Overlays and Navigations with no need of BuildContext.
https://github.com/emanuel-braz/one_context
context dart dialogs flutter flutter-package without-context
Last synced: 8 days ago
JSON representation
pub: https://pub.dev/packages/one_context - OneContext provides a simple way to deal with Dialogs, Overlays and Navigations with no need of BuildContext.
- Host: GitHub
- URL: https://github.com/emanuel-braz/one_context
- Owner: emanuel-braz
- License: bsd-3-clause
- Created: 2020-05-03T00:33:40.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-02-27T23:12:37.000Z (8 months ago)
- Last Synced: 2024-06-19T01:48:49.220Z (5 months ago)
- Topics: context, dart, dialogs, flutter, flutter-package, without-context
- Language: Dart
- Homepage:
- Size: 184 KB
- Stars: 74
- Watchers: 3
- Forks: 22
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/emanuel-braz/one_context/fork) [](https://github.com/emanuel-braz/one_context/stargazers) [](https://github.com/emanuel-braz/one_context/)
[](https://pub.dev/packages/one_context) 
> #### **One Context to rule them all**
## 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. 🎯
## 🎮 Let's start
## ⚠ Important: Configure MaterialApp. e.g.
```dart
/// 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,
...
);
```
#### There are 2 ways to get OneContext singleton instance, OneContext() or OnceContext.intance. e.g.
```dart
OneContext().pushNamed('/detail_page');
```
```dart
OneContext.instance.pushNamed('/detail_page');
```
#### There are controllers to use navigation, overlays and dialogs. e.g.
```dart
OneContext().navigator.pushNamed(...);
OneContext().dialog.showDialog(...);
OneContext().overlay.addOverlay(...);
```
#### Or, you can use the shortcuts ;)
```dart
OneContext().pushNamed(...);
OneContext().showDialog(...);
OneContext().addOverlay(...);
// and can access info from:
// OneContext().mediaQuery ...
// OneContext().textTheme ...
// OneContext().theme ...
```
#### OneContext is:
* Fast (O(1))
* Easy to learn/use
* It use same native function names from Flutter, to keep it simple and intuitive ;)
## 💬 How to show Dialogs with no need of the BuildContext?
```dart
// example snackBar
OneContext().showSnackBar(
builder: (_) => SnackBar(content: Text('My awesome snackBar!'))
);
```
```dart
// example dialog
OneContext().showDialog(
// barrierDismissible: false,
builder: (_) => AlertDialog(
title: new Text("The Title"),
content: new Text("The Body"),
)
);
```
```dart
// 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');
),
);
```
```dart
// example modalBottomSheet
OneContext().showModalBottomSheet(
builder: (context) => Container(
child: Column(
mainAxisSize: MainAxisSize.min,
children: [
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)
],
),
)
);
```
## ⛵ How to navigate? (All methods from Navigator Class are available)
```dart
// go to second page using named route
OneContext().pushNamed('/second');
```
```dart
// go to second page using MaterialPageRoute
OneContext().push(MaterialPageRoute(builder: (_) => SecondPage()));
```
```dart
// go back from second page
OneContext().pop();
```
```dart
// Pop dialogs
OneContext().popDialog();
```
```dart
// Retrieve data from route when it's pops
String result = await OneContext().push(MaterialPageRoute(builder: (_) => SecondPage()));
print(result);
```
## 🍰 How to show Overlays?
```dart
// show the default progress indicator
OneContext().showProgressIndicator();
```
```dart
// hide the default progress indicator
OneContext().hideProgressIndicator();
```
```dart
// show the default progress indicator with some colors
OneContext().showProgressIndicator(
backgroundColor: Colors.blue.withOpacity(.3),
circularProgressIndicatorColor: Colors.white
);
// Later
OneContext().hideProgressIndicator();
```
```dart
// Show a custom progress indicator
OneContext().showProgressIndicator(
builder: (_) => MyAwesomeProgressIndicator();
);
// Later
OneContext().hideProgressIndicator();
```
```dart
// Show a custom widget in overlay stack
String myCustomAndAwesomeOverlayId = UniqueKey().toString();
OneContext().addOverlay(
overlayId: myCustomAndAwesomeOverlayId,
builder: (_) => MyCustomAndAwesomeOverlay()
);
// Later
OneContext().removeOverlay(myCustomAndAwesomeOverlayId);
```
## 🎨 Changing Dark and Light theme mode
#### Breaking change: OneHotReload becomes OneNotification
#### ⚠ Please check consideration on Theme and MediaQuery topic
```dart
OneNotification(
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
)
);
```
## 🚧 Reload, Restart and Reboot the app (Need bubbling events or data?)
#### 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.
```dart
OneNotification>(
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,
);
},
);
```
#### Need to dispatch more specialized data/event?
```dart
// My Specialized Event
class MySpecializedEvent {
final String text;
MySpecializedEvent(this.text);
}
// Widget
OneNotification(
builder: (context, event) {
return Text(event.text);
},
)
// Later, in children, call `OneNotifier.notify` to get ancestors notified
OneNotifier.notify(
context,
NotificationPayload(
data: MySpecializedEvent('Nice!');
)
);
```
#### Reload and Restart the app
```dart
// Place that widget on most top
OneNotification(
builder: (_, __) => child
);
// Later... in children
// Dont lose state
OneNotification.softReloadRoot(context);
// Lose state
OneNotification.hardReloadRoot(context);
```
#### Reboot and load different apps
```dart
// 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()
);
```
## ⚙ Theme and MediaQuery
```dart
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.
```dart
@override
Widget build(BuildContext context) {
return Container(
color: Theme.of(context).primaryColor, // Theme.of(context)
height: 100,
width: 100,
);
}
```
#### Or you can call `Theme.of(context);` in the begining of `build` method instead;
e.g.
```dart
@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,
);
}
```
### In initState or inside class constructor (now it's possible)
```dart
@override
void initState() {
super.initState();
OneContext().showDialog(
builder: (_) => AlertDialog(
title: new Text("On Page Load"),
content: new Text("Hello World!"),
),
);
```
## 🚦 Warnings
\* 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.
## 👨💻👨💻 Contributing
#### Contributions of any kind are welcome! I'll be glad to analyse and accept them! 👾
### Sponsor
