I have a couple of questions that I can't find answers to in the documentation alone:
What is replaceRouteInformation, when is it used, and what does it do?
What is the difference between replaceRouteInformation and updateRouteInformation? Does this apply only to web or to any platform?
What does takePriority mean in the update function? This is the only thing I could find, but I still don't quite understand:
/// Takes priority over all other siblings,
/// i.e. sets itself as active and all other siblings as inactive.
Suggestion:
I would rename buildBeamStack. The documentation currently states:
/// [buildBeamStack] determines whether a [BeamStack] should be created
/// from [configuration], using the [stackBuilder]. For example, when using
/// [beamTo] and passing an already created [BeamStack], this can be false.
I suggest renaming this or updating the documentation to provide a clearer explanation of when and why this parameter should be used.
Consider renaming the rebuild parameter because it directly relates to calling notifyListeners. I believe this means notifying the UI state of a BeamLocation/BeamStack.
I have a couple of questions that I can't find answers to in the documentation alone:
replaceRouteInformation, when is it used, and what does it do?replaceRouteInformationandupdateRouteInformation? Does this apply only to web or to any platform?takePrioritymean in the update function? This is the only thing I could find, but I still don't quite understand:Suggestion:
buildBeamStack. The documentation currently states:I suggest renaming this or updating the documentation to provide a clearer explanation of when and why this parameter should be used.
rebuildparameter because it directly relates to callingnotifyListeners. I believe this means notifying the UI state of aBeamLocation/BeamStack.