WidgetsVRouterState class
- Inheritance
-
- Implemented types
-
Properties
-
context
→ BuildContext
-
The location in the tree where this widget builds.
no setterinherited
-
hash
→ String?
-
The hash of the url (a.k.a fragment)
no setterinherited
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
historyState
→ Map<String, String>
-
This state is saved in the browser history. This means that if the user presses
the back or forward button on the navigator, this historyState will be the same
as the last one you saved.
no setterinherited
-
mounted
→ bool
-
Whether this State object is currently in a tree.
no setterinherited
-
names
→ List<String>
-
A list of every names corresponding to the VRouteElements in
the current stack
no setterinherited
-
path
→ String?
-
Path of url
no setterinherited
-
pathParameters
→ Map<String, String>
-
Maps all route parameters (i.e. parameters of the path
mentioned as ":someId")
no setterinherited
-
previousPath
→ String?
-
Path of previousUrl
no setterinherited
-
previousUrl
→ String?
-
Previous url that was synced with the state
no setterinherited
-
queryParameters
→ Map<String, String>
-
Contains all query parameters (i.e. parameters after
the "?" in the url) of the current url
no setterinherited
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
url
→ String?
-
Url currently synced with the state
This url can differ from the once of the browser if
the state has been yet been updated
no setterinherited
-
vRouterDelegate
↔ VRouterDelegate
-
getter/setter pairinherited
-
widget
→ WidgetsVRouter
-
The current configuration.
no setterinherited
Methods
-
activate()
→ void
-
Called when this object is reinserted into the tree after having been
removed via deactivate.
inherited
-
build(BuildContext context)
→ Widget
-
Describes the part of the user interface represented by this widget.
override
-
deactivate()
→ void
-
Called when this object is removed from the tree.
inherited
-
debugFillProperties(DiagnosticPropertiesBuilder properties)
→ void
-
Add additional properties associated with the node.
inherited
-
didChangeDependencies()
→ void
-
Called when a dependency of this State object changes.
inherited
-
didUpdateWidget(covariant WidgetsVRouter oldWidget)
→ void
-
Called whenever the widget configuration changes.
inherited
-
dispose()
→ void
-
Called when this object is removed from the tree permanently.
inherited
-
historyBack()
→ void
-
Goes back 1 in the url history
inherited
-
historyCanBack()
→ bool
-
Check whether going back 1 in the history url is possible
inherited
-
historyCanForward()
→ bool
-
Check whether going forward 1 in the history url is possible
inherited
-
historyCanGo(int delta)
→ bool
-
Check whether jumping of
delta in the history url is possible
inherited
-
historyForward()
→ void
-
Goes forward 1 in the url history
inherited
-
historyGo(int delta)
→ void
-
Goes jumps of
delta in the url history
inherited
-
initState()
→ void
-
Called when this object is inserted into the tree.
inherited
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
pop({Map<String, String> pathParameters = const {}, Map<String, String> queryParameters = const {}, String? hash, Map<String, String> newHistoryState = const {}})
→ Future<void>
-
Starts a pop cycle
inherited
-
push(String newUrl, {Map<String, String> queryParameters = const {}, Map<String, String> historyState = const {}})
→ void
-
inherited
-
pushExternal(String newUrl, {bool openNewTab = false})
→ void
-
inherited
-
pushNamed(String name, {Map<String, String> pathParameters = const {}, Map<String, String> queryParameters = const {}, String? hash, Map<String, String> historyState = const {}})
→ void
-
inherited
-
pushReplacement(String newUrl, {Map<String, String> queryParameters = const {}, String? hash, Map<String, String> historyState = const {}})
→ void
-
inherited
-
pushReplacementNamed(String name, {Map<String, String> pathParameters = const {}, Map<String, String> queryParameters = const {}, String? hash, Map<String, String> historyState = const {}})
→ void
-
inherited
-
pushSegments(List<String> segments, {Map<String, String> queryParameters = const {}, String? hash, Map<String, String> historyState = const {}})
→ void
-
Pushes a new url based on url segments
inherited
-
reassemble()
→ void
-
Called whenever the application is reassembled during debugging, for
example during hot reload.
inherited
-
replaceHistoryState(Map<String, String> historyState)
→ void
-
This replaces the current history state of VRouter with given one
inherited
-
setState(VoidCallback fn)
→ void
-
Notify the framework that the internal state of this object has changed.
inherited
-
systemPop({Map<String, String> pathParameters = const {}, Map<String, String> queryParameters = const {}, String? hash, Map<String, String> newHistoryState = const {}})
→ Future<void>
-
Starts a systemPop cycle
inherited
-
to(String path, {Map<String, String> queryParameters = const {}, String? hash, Map<String, String> historyState = const {}, bool isReplacement = false})
→ void
-
The main method to navigate to a new path
inherited
-
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style})
→ DiagnosticsNode
-
Returns a debug representation of the object that is used by debugging
tools and by DiagnosticsNode.toStringDeep.
inherited
-
toExternal(String newUrl, {bool openNewTab = false})
→ void
-
Goes to an url which is not in the app
inherited
-
toNamed(String name, {Map<String, String> pathParameters = const {}, Map<String, String> queryParameters = const {}, String? hash, Map<String, String> historyState = const {}, bool isReplacement = false})
→ void
-
pathParameters needs to specify every path parameters
contained in the path corresponding to name
inherited
-
toSegments(List<String> segments, {Map<String, String> queryParameters = const {}, String? hash, Map<String, String> historyState = const {}, dynamic isReplacement = false})
→ void
-
Navigates to a new url based on path segments
inherited
-
toString({DiagnosticLevel minLevel = DiagnosticLevel.info})
→ String
-
A string representation of this object.
inherited
-
toStringShort()
→ String
-
A brief description of this object, usually just the runtimeType and the
hashCode.
inherited
