INavigable<'View> (Navs)

INavigable<'View> Type

Namespace: Navs
Assembly: Navs.dll
Base Type: obj
All Interfaces: INavigable<'View>

Instance members

Instance member	Description
`this.Navigate` Full Usage: `this.Navigate` Parameters: url : `string` - The URL to navigate to ?cancellationToken : `CancellationToken` - A token that can be used to cancel the navigation Returns: `Task<Result<unit, NavigationError<'View>>>` A task that will complete when the navigation is successful or when it fails. Modifiers: abstract	Performs a navigation to the route that matches the URL. url : `string` The URL to navigate to ?cancellationToken : `CancellationToken` A token that can be used to cancel the navigation Returns: `Task<Result<unit, NavigationError<'View>>>` A task that will complete when the navigation is successful or when it fails.
`this.NavigateByName` Full Usage: `this.NavigateByName` Parameters: routeName : `string` - The name of the route to navigate to ?routeParams : `IReadOnlyDictionary<string, obj>` - The parameters that will be used to match the route ?cancellationToken : `CancellationToken` - A token that can be used to cancel the navigation Returns: `Task<Result<unit, NavigationError<'View>>>` A task that will complete when the navigation is successful or when it fails. Modifiers: abstract	Performs a navigation by the name of the route. The route name is the name that was used to define the route in the route definition. Please note that any required parameters not supplied in the routeParams will make the navigation fail. routeName : `string` The name of the route to navigate to ?routeParams : `IReadOnlyDictionary<string, obj>` The parameters that will be used to match the route ?cancellationToken : `CancellationToken` A token that can be used to cancel the navigation Returns: `Task<Result<unit, NavigationError<'View>>>` A task that will complete when the navigation is successful or when it fails.
`this.State` Full Usage: `this.State` Returns: `aval<NavigationState>` Modifiers: abstract	The state of the router. This adaptive value will emit the current state of the router. It will emit Navigating when the router is in the process of navigating to a route. It will emit Idle when the router is not navigating to a route. Returns: `aval<NavigationState>`
`this.StateSnapshot` Full Usage: `this.StateSnapshot` Returns: `NavigationState` Modifiers: abstract	The current state of the router. This property will return the current state of the router. It will return Navigating when the router is in the process of navigating to a route. It will return Idle when the router is not navigating to a route. Returns: `NavigationState`