Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jahezacademy/flutter_rocket
🚀 Flutter Rocket 🚀 Fly high with Flutter Rocket - the ultimate package for Flutter developers
https://github.com/jahezacademy/flutter_rocket
flutter http model-view-controller mvc requests state-management
Last synced: 12 days ago
JSON representation
🚀 Flutter Rocket 🚀 Fly high with Flutter Rocket - the ultimate package for Flutter developers
- Host: GitHub
- URL: https://github.com/jahezacademy/flutter_rocket
- Owner: JahezAcademy
- Created: 2021-02-08T23:31:21.000Z (almost 4 years ago)
- Default Branch: dev
- Last Pushed: 2024-07-07T23:01:05.000Z (6 months ago)
- Last Synced: 2024-12-16T01:35:18.504Z (18 days ago)
- Topics: flutter, http, model-view-controller, mvc, requests, state-management
- Language: Dart
- Homepage: https://pub.dev/packages/flutter_rocket
- Size: 1.81 MB
- Stars: 13
- Watchers: 1
- Forks: 2
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 
Flutter Rocket
## Fly high with Flutter Rocket - the ultimate package for Flutter developers
# Author: [Jahez team](https://github.com/JahezAcademy)
[](https://pub.dartlang.org/packages/flutter_rocket)
[](https://opensource.org/licenses/MIT)
[](https://github.com/JahezAcademy/flutter_rocket/actions/workflows/flutter-ci.yml)
## Graphic tutorial
[Open with miro](https://miro.com/app/board/uXjVPndHj2s=/?share_link_id=307293362528)
---
| Package | Pub |
| ------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------- |
| [flutter_rocket](https://github.com/JahezAcademy/flutter_rocket/tree/master/packages/flutter_rocket) | [](https://pub.dev/packages/flutter_rocket) |
| [rocket_model](https://github.com/JahezAcademy/flutter_rocket/tree/master/packages/rocket_model) | [](https://pub.dev/packages/rocket_model) |
| [rocket_client](https://github.com/JahezAcademy/flutter_rocket/tree/master/packages/rocket_client) | [](https://pub.dev/packages/rocket_client) |
| [rocket_listenable](https://github.com/JahezAcademy/flutter_rocket/tree/master/packages/rocket_listenable) | [](https://pub.dev/packages/rocket_listenable) |
| [rocket_view](https://github.com/JahezAcademy/flutter_rocket/tree/master/packages/rocket_view) | [](https://pub.dev/packages/rocket_view) |
| [rocket_singleton](https://github.com/JahezAcademy/flutter_rocket/tree/master/packages/rocket_singleton) | [](https://pub.dev/packages/rocket_singleton) |
| [rocket_mini_view](https://github.com/JahezAcademy/flutter_rocket/tree/master/packages/rocket_mini_view) | [](https://pub.dev/packages/rocket_mini_view) |
---
# Usage
## Simple case usage RocketMiniView & RocketValue
its very simple
```dart
class MiniViewRocket extends StatelessWidget {
final RocketValue myStringValue = "My Value".mini;
final RocketValue myIntValue = 2021.mini;
MiniViewRocket({Key? key}) : super(key: key);
@override
Widget build(BuildContext context) {
return Scaffold(
body: Column(
mainAxisAlignment: MainAxisAlignment.center,
children: [
// use RocketValue for every widget
RocketMiniView(
value: myStringValue,
builder: () => Text(myStringValue.v),
),
RocketMiniView(
value: myStringValue,
builder: () => Text(myIntValue.v.toString()),
),
const SizedBox(
height: 25.0,
),
// merge multi RocketValue in one widget
RocketMiniView(
value: RocketValue.merge([myStringValue, myIntValue]),
builder: () {
return Row(
mainAxisAlignment: MainAxisAlignment.spaceEvenly,
children: [
Text(myStringValue.v),
Text(myIntValue.v.toString())
],
);
})
],
),
floatingActionButton: FloatingActionButton(
backgroundColor: Theme.of(context).primaryColor,
onPressed: () {
// change value
myStringValue.v = "Value Changed";
myIntValue.v = 2022;
},
tooltip: 'change Value',
child: const Icon(Icons.change_circle),
),
);
}
}
```
## State management & request
firstly you need to create your model by your json data from this [Link](https://json2dart.web.app/)
you get something like this:
```dart
import 'package:flutter_rocket/flutter_rocket.dart';
String postUserIdField = "userId";
String postIdField = "id";
String postTitleField = "title";
String postBodyField = "body";
class Post extends RocketModel {
int? userId;
int? id;
String? title;
String? body;
// disable logs debugging
@override
bool get enableDebug => false;
Post({
this.userId,
this.id,
this.title,
this.body,
});
@override
void fromJson(covariant Map json, {bool isSub = false}) {
userId = json[postUserIdField] ?? userId;
id = json[postIdField] ?? id;
title = json[postTitleField] ?? title;
body = json[postBodyField] ?? body;
super.fromJson(json, isSub: isSub);
}
void updateFields({
int? userIdField,
int? idField,
String? titleField,
String? bodyField,
}) {
userId = userIdField ?? userId;
id = idField ?? id;
title = titleField ?? title;
body = bodyField ?? body;
rebuildWidget();
}
@override
Map toJson() {
final Map data = {};
data[postUserIdField] = userId;
data[postIdField] = id;
data[postTitleField] = title;
data[postBodyField] = body;
return data;
}
@override
get instance => Post();
}
```
Now second step create your RocketRequest in constructor or initState of first widget and pass url & headers
```dart
class MyApp extends StatelessWidget {
MyApp() {
const String baseUrl = 'https://jsonplaceholder.typicode.com';
// create request object
RocketRequest request = RocketRequest(url: baseUrl);
// save it, for use it from any screen by key
Rocket.add(rocketRequestKey, request);
}
@override
Widget build(BuildContext context) {
return MaterialApp(
...
);
}
}...
```
Now create request method for post
```dart
import 'package:example/models/post_model.dart';
import 'package:flutter_rocket/flutter_rocket.dart';
const String postsEndpoint = "posts";
class GetPosts {
static Future getPosts(Post postModel) =>
Rocket.get(rocketRequestKey).request(
// endpoint
postsEndpoint,
// your model
model: postModel,
// parameters for send it with request
// params:{"key":"value"},
// inspect method for determine exact json use for generate your model in first step
// if your api send data directly without any supplement values you not should define it
// inspect:(data)=>data["response"]
// or
// target: ['response']
);
}
```
Next step its build [RocketView] Widget & pass your [RocketModel] in [model] & [RocketRequest] method in [call] parameter
```dart
class PostExample extends StatelessWidget {
// Save your model to use on another screen
// readOnly means if you close and open this screen you will use same data without update it from Api
// [rocket] is instance of Mccontroller injected in Object by extension for use it easily anywhere
final Post post = Rocket.add(postsEndpoint, Post(), readOnly: true);
PostExample({Key? key, required this.title}) : super(key: key);
final String title;
@override
Widget build(BuildContext context) {
return Scaffold(
appBar: AppBar(
title: const Text(
"Refresh Posts with swip to down or from here =>",
style: TextStyle(fontSize: 11.0),
),
actions: [
IconButton(
icon: const Icon(Icons.data_usage),
// Refresh Data from Api
onPressed: () => GetPosts.getPosts(post))
],
),
body: SizedBox(
height: MediaQuery.of(context).size.height,
width: MediaQuery.of(context).size.width,
child: RefreshIndicator(
onRefresh: () {
return GetPosts.getPosts(post);
},
child: RocketView(
// call api method
call: () => GetPosts.getPosts(post),
// your model generated
model: post,
// call call Voidcallback if model empty
callType: CallType.callIfModelEmpty,
// or
// callType: CallType.callAsStream,
// secondsOfStream: 1,
// customized your loading (default widget is CircularProgressIndicator)
// loader:CustomLoading(),
// handle errors
onError: (RocketException exception, Function() reload) {
return Center(
child: Column(
mainAxisAlignment: MainAxisAlignment.center,
children: [
Text(exception.exception),
if (exception.statusCode != HttpStatus.ok) ...[
Text(exception.response),
Text(Rocket.get(rocketRequestKey)
.msgByStatusCode(exception.statusCode))
],
TextButton(
onPressed: reload, child: const Text("retry"))
],
),
);
},
builder: (context,state) {
return SizedBox(
height: MediaQuery.of(context).size.height * 0.852,
child: ListView.builder(
itemCount: post.all!.length,
itemBuilder: (BuildContext context, int index) {
// your data saved in multi list as Post model
Post currentPost = post.all![index];
return ListTile(
leading: Text(currentPost.id.toString()),
title: Text(currentPost.title!),
trailing: IconButton(
color: Colors.brown,
icon: const Icon(Icons.update),
onPressed: () {
List titles = post.all!
.toJson(
include: ["title"], onlyValues: true)
.map((e) => e[0])
.toList();
log("$titles");
// update post data
currentPost.updateFields(
titleField: "This Title changed");
},
),
onTap: () => Navigator.of(context).push(
MaterialPageRoute(
builder: (BuildContext context) {
return Details(index);
}),
));
},
),
);
},
)),
));
}
}
class Details extends StatelessWidget {
final int index;
// get your model by key or type
final Post post = Rocket.get();
Details(this.index, {Key? key}) : super(key: key);
@override
Widget build(BuildContext context) {
Post currentPost = post.all![index];
return Scaffold(
appBar: AppBar(title: Text(currentPost.title!)),
body: Center(
child: ListTile(
leading: Text(currentPost.id.toString()),
title: Text(currentPost.title!),
subtitle: Text(currentPost.body!),
),
),
);
}
}
```
& last item its Rocket for save your model or any value and get it anywhere by key
[Rocket object details](https://github.com/JahezAcademy/flutter_rocket/tree/dev/packages/rocket_singleton)
## [More examples](https://github.com/JahezAcademy/flutter_rocket/tree/main/example)
If you have any questions or issues, feel free to check out the [Flutter Rocket GitHub repository](https://github.com/JahezAcademy/flutter_rocket) or ask for help on the [flutter_rocket package Discussions](https://github.com/JahezAcademy/flutter_rocket/discussions).