okito

Description:

okito

okito #
Your best flutter coding friend. All in one; state management, navigation management(with dynamic routing), local storage, dependency injection, localization, cool extensions with best usages and with the support of best utilities! #






Click here to join our discord community channel! #

Features #

State Management

Create Controller
Use Controller
Update Controller
Rockitos
Watch Controller
State Methods
Streams (Including Firestore)


Utilities + Navigation

Routing Management 🚀
Theme Management


Local Storage
Localization
Extensions
Dependency Injection

Contents #

Tips

Cleaner Widgets
Update State
App Controller


Tutorials
Examples
How to contribute okito


State Management #
Create Controller
Q: What should I do to make it work?
A: Just create a regular class and extend OkitoController, if you want to change the state, call update() or setState()
Q: How does these methods notify the state?
A: They have a conversation between themselves, whenever you call these methods, the notifier checks all the builders, if they are watching, they will be re-built. So the scheme is;
Model -> Controller -> Model
View -> Controller -> View
The controller is the root of them.
class CounterController extends OkitoController {
int count = 0;

void increment() => setState(() => count++);

void decrement() {
count--;
update();
}
}

CounterController counterController = CounterController();
copied to clipboard
You can also use setStateAsync function to update data asynchronously.

Use Controller
// That simple!
OkitoBuilder(
controller: counterController,
builder: () => Text('${counterController.count}'),
);
copied to clipboard

Update Controller
main(){
// You can change state from anywhere without context!
counterController.increment();
}

// In Flutter
ElevatedButton(
onPressed: counterController.increment,
child: const Text('Increment'),
)
// Or
ElevatedButton(
onPressed: () => counterController
.setState(() => counterController.count--),
child: const Text('Decrement'),
)
copied to clipboard

Rockitos
Rockitos are our way to use state management with dependency injection!
If you don't know what is dependency injection, read Dependency Injection Guide first.
// Rockito - My favorite way to use Okito state.

Rockito<CounterController>(
(controller) => Text('${controller.count}')
);
// Isn't it simple ?
// To use _Rockito_, you should first inject the CounterController.

Okito.inject(CounterController);
copied to clipboard
// RockitoBuilder - Rockito but with more features and builder!
RockitoBuilder<CounterController>(
inject: CounterController(), // optionally, if you didn't inject it yet.
builder: (controller) => Text('${controller.count}'),
// You can use all of OkitoBuilder features here like otherControllers and etc.
);
copied to clipboard

Watch Controller
OkitoWatcher(
watch: counterController,
onChange: (CounterController controller) {
// You can also update the state there.
// onChange gives to you is the instance of controller.
print(controller.count);
},
);
counterController.increment();

// OkitoWatcher also returns a function that stops watching which
// reduces the memory usage, you can use it when your usage ends.

final stopWatching = OkitoWatcher(/* code here */);
// do what you want to do while watching, then:
stopWatching();
copied to clipboard
// You can also watch with Rockitos.
RockitoWatcher<CounterController>(
(controller) => print(controller.count))
// You have to inject the controller first.
copied to clipboard
State Methods
State methods are methods like the State class of Flutter.
class CounterController extends OkitoController{
int count = 0;

// This will be called whenever your [OkitoBuilder] is mounted
// to the widget tree.
@override
void initState() {
count++;
}
// This will be called whenever your [OkitoBuilder] is removed
// from the widget tree.
@override
void dispose() {
count = 0;
}

// This method will only be called when you use inject method of Okito.
@override
void onInject() {
count++;
}
}
copied to clipboard
I personally use State Methods when I use controllers as StatefulWidget replacers.
Example:
class EditProductController extends OkitoController {
// other nodes here
final priceFocusNode = FocusNode();

void submitForm(){
// I use my inputControllers here to get their values.
// then I use my Okito routing without context!
Okito.pushNamed('/productUpdatedSuccessfully/31')
}

@override
void dispose() {
// other nodes here to [dispose].
priceFocusNode.dispose();
}
}
copied to clipboard
Streams
You might have streams in your app and you might want to watch them, update state on changes etc.
This streams can also be Firestore streams, you can use it, too.
You might want to check examples folder for an example of it.
Firstly, we have to use OkitoStreamMixin
class YourController extends OkitoController with OkitoStreamMixin{
// your code, totally same.
}
copied to clipboard
// For regular streams.
class CounterController extends OkitoController with OkitoStreamMixin {
int count = 0;
@override
void onInject(){
initStream<int>(stream: yourIntStream, onData(data) {
count = data; // You don't need to do anything or update.
});
}
}
copied to clipboard
// For Firestore query stream
// To use, you have to get the snapshot as Stream of query.
class PeopleController extends OkitoController with OkitoStreamMixin {
List<Person> people = [];
@override // Alternatively, you can use the constructor.
void onInject(){
initFirestoreQueryStream(querySnapshot: querySnapshot, onData(data) {
// This data is a list of documents(it is a map) of your collection.
people = data;
});
}
}
copied to clipboard
// For Firestore query stream
// To use, you have to get the snapshot as Stream of query.
class PersonController extends OkitoController with OkitoStreamMixin{
Person person = Person();
@override // Alternatively, you can use the constructor.
void onInject(){
initFirestoreDocumentStream(
documentSnapshot: documentSnapshot,
onData(data) {
// This data is your document as map.
person = Person.fromMap(data);
});
}
}
copied to clipboard
Utilities #
Navigation and using widgets without context. #
Firstly, we should wrap our app with Okito or provide Okito #
// Basically, you should add *Okito* to the beginning of your app or provide key/observers manually.

OkitoMaterialApp(/* Everything is same with [MaterialApp] */);

// Or
OkitoCupertinoApp(/* Everything is same with [CupertinoApp] */);

// Or
Material/CupertinoApp(
navigatorKey: Okito.navigatorKey,
navigatorObservers: [OkitoObserver()]);
copied to clipboard
Then you can use all of Okito Benefits! #
All of the properities has same usages with its long usage
For example: Okito.pushNamed('/secondPage') = Navigator.of(context).pushNamed('secondPage')
Okito.width;
Okito.height;
Okito.aspectRatio;
Okito.devicePixelRatio;
Okito.isLandscape;
Okito.isPortrait;
Okito.theme;

Okito.showSnackBar();
Okito.showToast(); // Snackbar without widget, usefull for simple usage.
Okito.showModal();
Okito.showDialog();

Okito.push();
Okito.pushReplacement();
Okito.pushNamed();
Okito.pushReplacementNamed();
Okito.pop();
Okito.arguments;
Okito.routeName;
copied to clipboard
Routing Management #
Lets say that you want dynamic urls like #
/posts/:id
/posts/23
copied to clipboard
And this id is a dynamic variable, right?
With Okito, you can do that easily!
// You don't need to add something like OkitoPage or etc.
// Okito lets you do your job without code changes.
OkitoMaterialApp(
routes: {
'/': (ctx) => FirstPage(),
'/second/:id': (ctx) => SecondPage(),
}
);
copied to clipboard
Now, whenever you try this:
ElevatedButton(
onPressed: () => Okito.pushNamed(
// You can add any kind of arguments
'/second/33?name=Rago&postId=123&isMaterial=true',
arguments: 'This is an extra argument'),
child: const Text('Go to second page'),
)
copied to clipboard
It will push to second page with the argument [id] : [33]
Moreover, you will see your arguments like this:
print(Okito.arguments);
// result
{'id' : '33', 'name' : 'Rago', 'postId' : 123, 'isMaterial' : true, 'arguments': 'This is an extra argument'};
// Yes, you can even get extra arguments manually.
copied to clipboard
Check example/flutter_dynamic_routing/lib/main.dart for a live example.
Would you like to have more benefits? Of course! #
Theme Management #
// Firstly, the bottom method gives you the app controller, you can update anything manually.
Okito.app; /* or */ Okito.use<AppController>();

// Then you have all of its usages.

Okito.app.setThemeData();
Okito.app.setThemeMode();
Okito.app.setCupertinoThemeData();

Okito.app.locale;
Okito.app.setLocale();
copied to clipboard
Local Storage #
OkitoStorage is a way to save variables to the local storage. #
It works like SharedPereferences but it is synchronous like GetStorage. #
OkitoStorage is blazingly fast because in read operations it uses memory to get data instead of reading from disk everytime!
// To use, you should init the storage, it is not required for web but required for all other platforms.

void main() async{
// Only init is asynchronous, you can also call without await but it is not recommended.
await OkitoStorage.init();


// Usage
final box = OkitoStorage; // For easier reference.

box.write('count', 0);

final int count = box.read<int>('count');
// Simple as this!

print('Count is $count');
// Rest of your code will be here.
}
copied to clipboard
Other Usages
box.watchKey('count', () =>
print('This function will be called whenever the count changes.');
);

box.watchAll(() =>
print('This function will be called whenever the storage changes.');
);

box.removeKey('count'); // Removes the key

box.readAllKeys(); // returns all keys in storage

box.readAllValues(); // returns all values in storage

box.readAll(); // returns all of the storage

box.clearStorage(); // removes everything from the storage but storage will still exists.

box.deleteStorage(); // removes the storage from file system completely, after this operation, OkitoStorage won't be able to write or read.
copied to clipboard
Watch OkitoStorage With OkitoBuilder #
// Check the example/flutter_okito_storage/lib/main.dart for more examples!

// It will run whenever key 'count' changes.
OkitoBuilder(
controller: yourController,
watchStorageKeys: ['count'],
builder: () => Text('${box.read('count')}'),
);
copied to clipboard
Benefits Of OkitoStorage

Really fast
You can watch the changes from anywhere, even in your builders.
It is synchronous, so you don't have to use 'await' keyword.
You can storage Strings, ints, Maps and even Lists.
Works on any device that flutter supports!

OkitoStorage is reliable but be careful when using it as database, because it is not created to be database. For complex works, you can try Hive!
Localization #
For global apps, it might be hard to find a new library for localization or creating your own, then you will probably have another problems
like updating the whole app after language change and etc. Why would you do that?
Okito provides localization solutions for your app.
// It is also so simple to have!
// Firstly create your translations like this:
const translations = {
'en': {
'hello': 'Hello from Okito!',
},
'tr': {
'hello': "Okito'dan selamlar!",
},
};
// You can have unlimited amount of locales and translations
// You can make it dynamic, seperate files and etc. It is just a dart map!
copied to clipboard
// After creating it, give it to the app.
OkitoMaterialApp /* or OkitoCupertinoApp */(
translations: translations,
/* Your code here without any change */);
copied to clipboard
// Using it? It is the simplest! Lets use it in a text widget.
Text('hello'.loc); // It will show 'Hello from Okito!'

// Lets change the language and see it again.
Okito.app.setLocale(Locale('tr','TR'));
// Now it says: 'Okito'dan selamlar!' as it is declared in translations.
copied to clipboard
// You can also set it like this;
Okito.localize('hello'); // returns the translation as String.
copied to clipboard
For better examples check example/flutter_localization/lib/main.dart
Extensions #
// Context Extensions
context.width;
context.height;
context.aspectRatio;
context.devicePixelRatio;
context.isLandscape;
context.isPortrait;
context.theme;
context.arguments;
context.routeName;
copied to clipboard
Dependency Injection #
Dependency injection is your way to inject variables to the Okito and use it anywhere in your app. With Okito, it is as simple as it can be! #
// Example Variable
class Counter(){
count = 0;
}

// Inject it
Okito.inject(Counter());


// Use it anywhere!
Okito.use<Counter>();

// Asign it with type support!
final counter = Okito.use<Counter>();

// Update however you want
counter.count++;
// or
Okito.use<Counter>().count++;
copied to clipboard
Soo, lets say that your job is done with that class, why would we let it to use memory?
// Counter will be gone forever!
Okito.eject<Counter>();
copied to clipboard
For more details, check the tests or examples about it!
Injection With Keys #
It is useful when you want to storage with a String key instead of type which gives you advantage of multiple injects with same type.
// Example Variable
class Counter(){
count = 0;
}

// Inject it
Okito.injectWithKey('firstCounter',Counter());
Okito.injectWithKey('secondCounter',Counter());


// Use it anywhere with type support!
final firstCounter = Okito.useWithKey<Counter>('firstCounter');
final secondCounter = Okito.useWithKey<Counter>('secondCounter');

// Update however you want
firstCounter.count++;
secondCounter.count++;
copied to clipboard
Soo, lets say that your job is done with that class, why would we let it to use memory?
// Second counter will be gone forever!
Okito.ejectWithKey('secondCounter');
copied to clipboard
Tips #
Cleaner Widgets
// In your widgets folder or any other folder, declare builder.
OkitoBuilder CounterBuilder({
required Widget Function() builder,
}) =>
OkitoBuilder(
controller: counterController,
builder: () => builder(),
);

// Usage
CounterBuilder(builder: () => Text('${counterController.count}'));
copied to clipboard
My Favorite Way
OkitoBuilder CounterBuilder({
required Widget Function(CounterController state) builder,
}) =>
OkitoBuilder(
controller: counterController,
builder: () => builder(counterController),
);

// Usage
CounterBuilder(builder: (state) => Text('${state.count}'));
copied to clipboard

Update State
class CounterController extends OkitoController {
int _count = 0;

int get count => _count;

set count(int count) {
_count = count;
// Now, whenever you change count like 'count++', it will update state.
update();
}
}
copied to clipboard
App Controller
It is the controller of app, you can wrap your widgets that you want to change on big updates like theme changes if the data
you wrote is not coming from a controller.
Rockito<AppController>(
(app) => // yourWidget
)

copied to clipboard
Tutorials #

To Do App by Randall Morgan
Written To Do App by Randall Morgan

Examples #

Examples by Gokuldas V R
Counter Example
To Do Example

How to contribute okito #

okito needs tests.
okito needs more examples.
okito needs a better readme file :D
okito needs reputition, likes and users!
okito needs test with Apple products, I tested on linux, android, web and Windows