vagabondms / flutter-mvi-template

This template is built on top GetX library

Template for MVI pattern in Flutter

This template written on top Get library.

Why this template

Standard pattern for flutter let you code everything in the widget. This approach is easy to learn, but the more you learn you will notice "Separation of Concern (S.o.C)" is not the top priority of the standard pattern. There are a lot of popular pattern in community such as BLoC, MVP, MVVM and MVI. Personally i think MVI is the better way, so i wrote this template.

In this template setState((){...}) is replaced to render() and only available on Action class. So, just like before, every state change is triggering whole widget re-build, but it can only be accessed from action. The view can't trigger self re-build because it doesn't direct reference to action nor state.

How to code

1. To use this pattern, your StatefulWidget is should be separated into State, Action, and View.

// previously
class HomeScreen extends StatefulWidget {
  @override
  State<StatefulWidget> createState() => HomeState();
}

class HomeState extends State<HomeScreen> {
  int age = 0;

  void increaseAge() {
    setState(() {
      age += 1;
    });
  }

  void navigateToSetting() {
    Navigator.of(context).push(
      MaterialPageRoute(builder: (ctx) => SettingScreen()),
    );
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        leading: IconButton(
          icon: Icon(FeatherIcons.chevronLeft),
          onPressed: () => Navigator.pop(context),
        ),
        title: Text(AppString.TITLE_SETTING),
      ),
      body: ListView(
        children: [
          FlatButton(
            child: Text('Nambah Umur'),
            onPressed: () => increaseAge(),
          ),
          FlatButton(
            child: Text('Navigate to setting'),
            onPressed: () => navigateToSetting(),
          ),
        ],
      ),
    );
  }
}

// after


class HomeState {
  int age = 0;
}

class HomeAction extends BaseAction<HomeScreen, HomeAction, HomeState> {
  @override
  Future<HomeState> initState() async => HomeState();

  void increaseAge() {
    state.age += 1;
    render();
  }

  void navigateToSetting() {
    Get.to(SettingScreen());
  }
}

class HomeScreen extends BaseView<HomeScreen, HomeAction, HomeState> {
  @override
  HomeAction initAction() => HomeAction();

  @override
  Widget loadingViewBuilder(BuildContext context) => Container();

  @override
  Widget render(
    BuildContext context,
    HomeAction action,
    HomeState state
  ) {
    return Scaffold(
      appBar: AppBar(
        leading: IconButton(
          icon: Icon(FeatherIcons.chevronLeft),
          onPressed: () => action.cancelAndClose(),
        ),
        title: Text(AppString.TITLE_SETTING),
      ),
      body: ListView(
        children: [
          FlatButton(
            child: Text('Add Age'),
            onPressed: () => action.increaseAge(),
          ),
          FlatButton(
            child: Text('Navigate to setting'),
            onPressed: () => action.navigateToSetting(),
          ),
          FlatButton(
            child: Text('Reload screen'),
            onPressed: () => action.reloadScreen(),
          ),
        ],
      ),
    );
  }
}

see more example

2. Every screen is a loadable ready screen. As you can see on above action example, initState is a future function which you can use to retrive data from a source. So, in the meantime the screen will load view from loadingViewBuilder. You can load a spinner or shimmer on it.

3. action.reloadScreen() will retrigger onReady future and reset isBusy flag.

How to run

• Just run

$ flutter run

• Build json serializable before run

$ ./asBuildAndRun.sh

• (optional) watch json serializable change while run

$ ./asWatchJson.sh

• (Tips) Just run on specific port (3600)

$ flutter run --web-port 3600

Other interesting things

• This template has set app icon and app splash screen both on android and ios. So all you need to do is replace exisitng images.
• Material Icon is disabled by default, because its more beautiful to use custom icon Icon8 LineAwesome.

Unfinished template

• Internationalization template
• Image sourcing template
• Usecase - Repository pattern
• Unit test example

Library usage

See complete list pubspec