VRouterSailor class abstract

Describes a class which contains all the useful data of VRouter

Implemented types

• VRouterNavigator
• VRouterData

Implementers

• CupertinoVRouterState
• InitializedVRouterSailor
• VRouterState
• WidgetsVRouterState

Constructors

VRouterSailor()

Properties

hash → String?

The hash of the url (a.k.a fragment)

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

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 setter, inherited

names → List<String>

A list of every names corresponding to the VRouteElements in the current stack

no setter, inherited

path → String?

Path of url

no setter, inherited

pathParameters → Map<String, String>

Maps all route parameters (i.e. parameters of the path mentioned as ":someId")

no setter, inherited

previousPath → String?

Path of previousUrl

no setter, inherited

previousUrl → String?

Previous url that was synced with the state

no setter, inherited

queryParameters → Map<String, String>

Contains all query parameters (i.e. parameters after the "?" in the url) of the current url

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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 setter, inherited

Methods

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

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 {}}) → 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

replaceHistoryState(Map<String, String> historyState) → void

This replaces the current history state of VRouter with given one

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

toExternal(String url, {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() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited