app_state 0.6.0 app_state: ^0.6.0 copied to clipboard
A BLoC-based state management solution on top of Router API for larger apps.
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 likePageBloc
type or the return value. All such classes were renamed in a pattern ofPageBloc<C, R> -> CPageBloc<C, R>
. Thentypedef
s were added liketypedef PageBloc<R> = CPageBloc<PageConfiguration, R>
. If you need the common subclass ofPageConfiguration
, just addC
before all such typed parent classes to get it back. Otherwise just remove<PageConfiguration>
from your code. - BREAKING: When
PageStackBloc
compares pages tonull
PageConfiguration
, it ignores the page keys and never disposes such pages. This is to allow non-web apps without anyPageConfiguration
classes. Otherwise the pages were always kicked out when comparing tonull
PageConfiguration
. No practical use cases were affected. PageConfiguration
classes are now optional for all non-web apps and web apps that do not care for URLs.PageConfiguration
is now non-abstract and has/
as the defaultlocation
.PageConfiguration
objects no longer need to parseRouteInformation.state
in theirtryParse
. To benefit from this, stop overridingparseRouteInformation
in 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
.PageStackRouteInformationParser
andPageStacksRouteInformationParser
can now be used without subclassing in all non-web apps and web apps that do not care for URLs. By return they parsenull
PageConfiguration
objects.PageStackRouteInformationParser
andPageStacksRouteInformationParser
in theirrestoreRouteInformation
now return all their stack/stacks states to store in browser history and not only that of the topPageConfiguration
.- Added
const
constructors toPageStackRouteInformationParser
andPageStacksRouteInformationParser
. PageStackRouteInformationParser
andPageStacksRouteInformationParser
now haveparsePageConfiguration
to only parse the singlePageConfiguration
. This way the superclasses calldefaultStackConfiguration
anddefaultStacksConfiguration
so you don't have to. They are the recommended replacements to respectiveparseRouteInformation
methods. They are called only when failed to recover fromRouteInformation.state
. To use them, stop overridingparseRouteInformation
.PageStackRouteInformationParser
now hasparsePageStackConfiguration
, andPageStacksRouteInformationParser
now hasparsePageStacksConfiguration
. They are the alternative replacements to respectiveparseRouteInformation
methods in case you need additional logic to recover the stack state that cannot be derived from yourPageConfiguration
alone. 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
PageBlocCloseEvent
have a newR
type parameter for the return result. The actual result is ofR?
withnull
if closing without data. - BREAKING:
PageBlocCloseEvent
has a new requireddata
property of typeR
. It is encouraged to use it instead of subclassingPageBlocCloseEvent
. - BREAKING: Page classes no longer have
const
constructors because they haveCompleter
s now. - Added
PageBloc.pop(data)
. - Added
PageBloc.didPopNext(page, event)
. PageStackBloc.push
returns aFuture
that completes when the page is popped.- Deprecated
PageBloc.onForegroundClosed
in favor ofdidPopNext
. - Deprecated
PageBloc.closeScreen
andPageBloc.closeScreenWith
in 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
PageStackBlocEvent
asPageStacksBlocEvent
.
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:
PageConfiguration
is now abstract, addedrestoreRouteInformation()
. - Added
PageConfiguration.defaultStackConfiguration
. - Added
PageStackConfiguration.getTopPageConfiguration()
. - Added
PageStackRouteInformationParser
.
0.1.6 #
- Fix
onPopRoute
inPageStackBlocNavigator
.
0.1.5 #
- Added
PageStackRouterDelegate
.
0.1.3 #
- Added
PageBloc.closeScreenWith
,PageBloc.onForegroundClosed
.
0.1.2 #
- BREAKING: Renamed
AppBlocNormalizedState
toAppConfiguration
. - BREAKING: Renamed
PageStackBlocNormalizedState
toPageStackConfiguration
. - BREAKING: Renamed
ScreenBlocNormalizedState
toPageConfiguration
. - BREAKING: Renamed
Screen...
events toPage...
events. - BREAKING: Extracted
PageBloc.states
to the newPageStatefulBloc
subclass. PageBloc
is not abstract.- Allow to specify duplicate key behavior per push.
- Allow
null
for 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.