app_state 0.6.9
app_state: ^0.6.9 copied to clipboard
A BLoC-based state management solution on top of Router API for larger apps.
0.6.9 #
- Preserves the state on browser refresh button press by using https://pub.flutter-io.cn/packages/flutter_issue_108697_workaround
- Renamed
PageStackBlocNavigatortoPageStackNavigator. A deprecatedtypedefwas added for backward compatibility.
0.6.8 #
- Added
PageStackRouterDelegate.observers,PageStackRouterDelegate.transitionDelegate.
0.6.7 #
- Added
PageStackBlocNavigator.observers,PageStackBlocNavigator.transitionDelegate.
0.6.6 #
- Updated example links.
0.6.5 #
- Added
PageStackBloc.popUntilBottom(), it uses the newPopCause.pageStackBloc. PageBlocPopEventis now always created with the correctRtype. Before it had beenconst PageBlocPopEvent<Null>for pops without data.- Improved test coverage.
- Fix formatting.
- Add comparison to auto_route and go_router to README.
0.6.4 #
- Added
PageStackBloc.replaceWithto declaratively navigate to a given path with two options:- Replacing the stack unconditionally with
mode: PageStackMatchMode.none. - Preserving the states of pages that exist in both the old and the new stack with
mode: PageStackMatchMode.keyOrNullPathNoGap.
- Replacing the stack unconditionally with
- Added
modeargument toPageStackBloc.setConfigurationto choose the match mode the same way as inreplaceWith. - Added
PageBlocCloseEvent.causeto tell between the back button close, the bloc's own intention to close, and a kick-out as a result of stack diff. BlocMaterialPageis now non-abstract.- Fixed issue when page stack was allowed to be emptied and stayed defunct afterwards Issue 3. The emptying operation is now reverted.
- Removed code duplication by handling all page removals in
PageStackBloc.handleRemoved(). - Expand tests.
0.6.3 #
- Renamed
PageBlocCloseEventtoPageBlocPopEventto align withdidPopNextmethod. - A deprecated
typedefwas created for backwards compatibility.
0.6.2 #
- Renamed
PageConfigurationtoPagePath. Atypedeffor backwards compatibility is added. Methods, getters, and arguments with pages' 'configuration' in its name were changed to use 'path', deprecated copies of the old ones were added for backwards compatibility. ThePageConfiguration's name was a permanent source of confusion. Each doc had to start with a note thatPageConfigurationcorresponds to a URL, and it was not easy to memorize. This change will simplify the learning of this package. It has also stripped 9-13 characters from identifiers.Pathis inspired by the original article announcing Router API (as well asapp_statename itself was).Configurationearlier was inspired byRouterdocs where it means the configuration of the whole app (earlier versions ofapp_statewere designed to allow storing only the top page's state, and so 'configuration' was extended to pages as well). 'Configuration' is still used inPageStackConfigurationandPageStacksConfigurationclass names that do represent the whole app's state, and that is correct. - Deprecated
PagePath.restoreRouteInformation. It used to allow overridingstateand was confusing because it was not used in serializing for browser history (super.stateis).
0.6.1 #
- Fix images in README.
0.6.0 #
- BREAKING: All classes that had a type parameter
<C extends PageConfiguration>no longer have it. The idea of this type parameter is to have a subclass that is a superclass to all of your configurations. An example is when you store a language slug there, and it must be automatically present in all your configurations. These cases are rare, and most of the time<PageConfiguration...only clutters the code when you must provide some other typed parameters likePageBloctype or the return value. All such classes were renamed in a pattern ofPageBloc<C, R> -> CPageBloc<C, R>. Thentypedefs were added liketypedef PageBloc<R> = CPageBloc<PageConfiguration, R>. If you need the common subclass ofPageConfiguration, just addCbefore all such typed parent classes to get it back. Otherwise just remove<PageConfiguration>from your code. - BREAKING: When
PageStackBloccompares pages tonullPageConfiguration, it ignores the page keys and never disposes such pages. This is to allow non-web apps without anyPageConfigurationclasses. Otherwise the pages were always kicked out when comparing tonullPageConfiguration. No practical use cases were affected. PageConfigurationclasses are now optional for all non-web apps and web apps that do not care for URLs.PageConfigurationis now non-abstract and has/as the defaultlocation.PageConfigurationobjects no longer need to parseRouteInformation.statein theirtryParse. To benefit from this, stop overridingparseRouteInformationin your parser and override one of the new methods instead:parsePageConfiguration,PageStackRouteInformationParser.parsePageStackConfiguration,PageStacksRouteInformationParser.parsePageStacksConfiguration. These methods are only called when failed to extract state fromRouteInformation, i.e. when the URL is typed in, and so no non-URL state information is present.PageStackConfiguration.getTopPageConfiguration()is now nullable and returns null if none of the pages in the stack havePageConfiguration.PageStackRouteInformationParserandPageStacksRouteInformationParsercan now be used without subclassing in all non-web apps and web apps that do not care for URLs. By return they parsenullPageConfigurationobjects.PageStackRouteInformationParserandPageStacksRouteInformationParserin theirrestoreRouteInformationnow return all their stack/stacks states to store in browser history and not only that of the topPageConfiguration.- Added
constconstructors toPageStackRouteInformationParserandPageStacksRouteInformationParser. PageStackRouteInformationParserandPageStacksRouteInformationParsernow haveparsePageConfigurationto only parse the singlePageConfiguration. This way the superclasses calldefaultStackConfigurationanddefaultStacksConfigurationso you don't have to. They are the recommended replacements to respectiveparseRouteInformationmethods. They are called only when failed to recover fromRouteInformation.state. To use them, stop overridingparseRouteInformation.PageStackRouteInformationParsernow hasparsePageStackConfiguration, andPageStacksRouteInformationParsernow hasparsePageStacksConfiguration. They are the alternative replacements to respectiveparseRouteInformationmethods in case you need additional logic to recover the stack state that cannot be derived from yourPageConfigurationalone. They are called only when failed to recoverRouteInformation.state. To use them, stop overridingparseRouteInformation.
0.5.1 #
- Added
PageConfiguration.location. - Added
PageConfiguration.defaultStackConfigurations.
0.5.0 #
- BREAKING: Pages, Blocs an
PageBlocCloseEventhave a newRtype parameter for the return result. The actual result is ofR?withnullif closing without data. - BREAKING:
PageBlocCloseEventhas a new requireddataproperty of typeR. It is encouraged to use it instead of subclassingPageBlocCloseEvent. - BREAKING: Page classes no longer have
constconstructors because they haveCompleters now. - Added
PageBloc.pop(data). - Added
PageBloc.didPopNext(page, event). PageStackBloc.pushreturns aFuturethat completes when the page is popped.- Deprecated
PageBloc.onForegroundClosedin favor ofdidPopNext. - Deprecated
PageBloc.closeScreenandPageBloc.closeScreenWithin favor ofpop.
0.4.0 #
- BREAKING: Require Flutter 3.
- Re-licensed under MIT No Attribution.
- Using
total_lints, fix linter issues.
0.3.5 #
- Fix duplicate page key handling.
0.3.4 #
- Call const constructors where possible.
- Applied
dart format. - Added features to
README.md
0.3.3 #
- Added
MaterialPageStacksRouterDelegate. - Added
StatefulBlocWidget.
0.3.2 #
- Const constructors for
PageBlocCloseEvent,PageBlocConfigurationChangedEvent,PageStackConfiguration. - Link to tutorials.
0.3.1 #
- Wrap
PageStackBlocEventasPageStacksBlocEvent.
0.3.0 #
- BREAKING: Remove
AppBloc. - Add
PageStacksBloc,PageStacksConfiguration,PageStacksRouteInformationParser,PageStacksRouterDelegate. - Add
PageConfiguration.defaultStackKey,defaultStacksConfiguration.
0.2.1 #
- An accidental debug print removed.
0.2.0 #
- BREAKING:
PageConfigurationis now abstract, addedrestoreRouteInformation(). - Added
PageConfiguration.defaultStackConfiguration. - Added
PageStackConfiguration.getTopPageConfiguration(). - Added
PageStackRouteInformationParser.
0.1.6 #
- Fix
onPopRouteinPageStackBlocNavigator.
0.1.5 #
- Added
PageStackRouterDelegate.
0.1.3 #
- Added
PageBloc.closeScreenWith,PageBloc.onForegroundClosed.
0.1.2 #
- BREAKING: Renamed
AppBlocNormalizedStatetoAppConfiguration. - BREAKING: Renamed
PageStackBlocNormalizedStatetoPageStackConfiguration. - BREAKING: Renamed
ScreenBlocNormalizedStatetoPageConfiguration. - BREAKING: Renamed
Screen...events toPage...events. - BREAKING: Extracted
PageBloc.statesto the newPageStatefulBlocsubclass. PageBlocis not abstract.- Allow to specify duplicate key behavior per push.
- Allow
nullfor page keys. - Added docs.
0.1.1 #
- BREAKING: Removed
ScreenBlocConfigurationChangedEvent.configuration. - Added
AppBloc. - Added
AppBlocNormalizedState,PageStackBlocNormalizedState,ScreenBlocNormalizedState. - Normalize and denormalize state.
- Create pages in
PageStackBloc.
0.1.0 #
- Initial release.