Search packages, repositories and app categories

GitHub repositorybrianegan/flutter_redux_dev_tools

flutter_redux_dev_tools

A Time Traveling Redux Debugger for Flutter

flutter_redux_dev_tools project cover
Stars
40
Forks
9
Last push (UTC)
Apr 28, 2022
Project status
Active

Original README

English project snapshot. Visit GitHub for the latest content.

flutter_redux_dev_tools

Build Status codecov

A Widget you can use to show a Redux Time Travel UI. Simply put it in a part of your UI that makes sense (Such as a Dev Tools Drawer), pass it a DevToolsStore and you'll be good to go!

Note: This Widget does not work with a normal Redux Store. It is meant to work with the redux_dev_tools package, which provides a DevToolsStore. The DevToolsStore is a drop-in replacement for your Store during Development!

Demo

A simple Flutter app that allows you to Increment and Decrement a counter.

A screenshot of the Dev Tools in Action

Usage
  1. Create a main_dev.dart file
  2. In this file, create a DevToolsStore in place of a normal redux Store
  3. Create a ReduxDevTools widget, passing through the Store. You can place this Widget wherever makes sense in your app! One good suggestion: In a "Dev Tools Drawer." This is generally the endDrawer in your Scaffold, and can contain different types of tools for a Dev Build of your app.
Example

This example paints only a broad outline of how to use the ReduxDevTools. For a complete example, see the example folder.

int addReducer(int state, action) => state + 1;

// Create a DevToolsStore instead of a normal Store during Development
final store = DevToolsStore<int>(
  addReducer,
  initialState: 0,
);

// Finally, create your app with a Redux Dev Tools
main() { 
  runApp(MaterialApp(
    home: Scaffold(
      endDrawer: ReduxDevTools<int>(store),
    ),
  ));
}

Credits

All of this is inspired by the original Redux Devtools.

Brian Egan GitHub avatar
GitHub author

Brian Egan ↗

Montana boy living in the UK.

Lake District, UKOfficial website ↗
LanguagesMakefileDartCMakeC++HTMLCSwiftKotlinObjective-C

Categories

Packages published by this repository

Dependencies used

Dependency list 6 items

  • flutter{"sdk":"flutter"}
  • flutter_redux>=0.8.2 <0.11.0
  • redux>=5.0.0 <6.0.0
  • redux_dev_tools>=0.7.0 <0.8.0
  • flutter_testDevelopment{"sdk":"flutter"}
  • pedanticDevelopment1.11.0

How do I choose a repository?

Start with your use case, compare repository activity, and check the original project before adopting it.

  1. Search by repository name, owner or description, then narrow the results by topic.
  2. Compare stars, forks and recent pushes. Stars show community interest, not a guarantee of quality.
  3. Read the README, license and issues on GitHub before using a project.

Sources and maintenance

“A repository is the most basic element of GitHub.”

GitHub Docs — About repositories ↗