NavigationHistory

Definition

Assembly: CloudNimble.BlazorEssentials.dll Namespace: CloudNimble.BlazorEssentials.Navigation Inheritance: System.Object

Syntax

CloudNimble.BlazorEssentials.Navigation.NavigationHistory

Constructors

.ctor

Syntax

public NavigationHistory(Microsoft.JSInterop.IJSRuntime jsRuntime)

Parameters

Name	Type	Description
`jsRuntime`	`Microsoft.JSInterop.IJSRuntime`	-

.ctor Inherited

Inherited from object

Syntax

public Object()

Methods

Back

This asynchronous method goes to the previous page in session history.

Syntax

public System.Threading.Tasks.ValueTask Back()

Returns

Type: System.Threading.Tasks.ValueTask

Count

Returns an Integer representing the number of elements in the session history, including the currently loaded page.

Syntax

public System.Threading.Tasks.ValueTask<int> Count()

Returns

Type: System.Threading.Tasks.ValueTask<int>

CurrentState

Returns an T type representing the state at the top of the history stack.

Syntax

public System.Threading.Tasks.ValueTask<T> CurrentState<T>()

Returns

Type: System.Threading.Tasks.ValueTask<T>

Type Parameters

T - The type of the state data

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

Name	Type	Description
`obj`	`object?`	-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

Forward

This asynchronous method goes to the next page in session history.

Syntax

public System.Threading.Tasks.ValueTask Forward()

Returns

Type: System.Threading.Tasks.ValueTask

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetScrollRestoration

Allows web applications to explicitly get default scroll restoration behavior on history navigation.

Syntax

public System.Threading.Tasks.ValueTask<CloudNimble.BlazorEssentials.Navigation.ScrollRestorationType> GetScrollRestoration()

Returns

Type: System.Threading.Tasks.ValueTask<CloudNimble.BlazorEssentials.Navigation.ScrollRestorationType>

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

Go

Asynchronously loads a page from the session history, identified by its relative location to the current page.

Syntax

public System.Threading.Tasks.ValueTask Go(int index)

Parameters

Name	Type	Description
`index`	`int`	The index to move back or forward

Returns

Type: System.Threading.Tasks.ValueTask

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

PushState

Pushes the given data onto the session history stack.

Syntax

public System.Threading.Tasks.ValueTask PushState<T>(T state, string url)

Parameters

Name	Type	Description
`state`	`T`	The state of the data
`url`	`string`	The url to navigate

Returns

Type: System.Threading.Tasks.ValueTask

Type Parameters

T - The type of the state data

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

ReplaceState

Updates the most recent entry on the history stack.

Syntax

public System.Threading.Tasks.ValueTask ReplaceState<T>(T state, string url)

Parameters

Name	Type	Description
`state`	`T`	The state of the data
`url`	`string`	The url to navigate

Returns

Type: System.Threading.Tasks.ValueTask

Type Parameters

T - The type of the state data

SetScrollRestoration

Allows web applications to explicitly set default scroll restoration behavior on history navigation. This property can be either auto or manual.

Syntax

public System.Threading.Tasks.ValueTask SetScrollRestoration(CloudNimble.BlazorEssentials.Navigation.ScrollRestorationType scrollRestorationType)

Parameters

Name	Type	Description
`scrollRestorationType`	`CloudNimble.BlazorEssentials.Navigation.ScrollRestorationType`	-

Returns

Type: System.Threading.Tasks.ValueTask

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?

Getting Started

Guides

API Reference

​Definition

​Syntax

​Constructors

​ .ctor

​Syntax

​Parameters

​ .ctor Inherited

​Syntax

​Methods

​ Back

​Syntax

​Returns

​ Count

​Syntax

​Returns

​ CurrentState

​Syntax

​Returns

​Type Parameters

​ Equals Inherited Virtual

​Syntax

​Parameters

​Returns

​ Equals Inherited

​Syntax

​Parameters

​Returns

​ Forward

​Syntax

​Returns

​ GetHashCode Inherited Virtual

​Syntax

​Returns

​ GetScrollRestoration

​Syntax

​Returns

​ GetType Inherited

​Syntax

​Returns

​ Go

​Syntax

​Parameters

​Returns

​ MemberwiseClone Inherited

​Syntax

​Returns

​ PushState

​Syntax

​Parameters

​Returns

​Type Parameters

​ ReferenceEquals Inherited

​Syntax

​Parameters

​Returns

​ ReplaceState

​Syntax

​Parameters

​Returns

​Type Parameters

​ SetScrollRestoration

​Syntax

​Parameters

​Returns

​ ToString Inherited Virtual

​Syntax

​Returns

Definition

Syntax

Constructors

.ctor

Syntax

Parameters

.ctor Inherited

Syntax

Methods

Back

Syntax

Returns

Count

Syntax

Returns

CurrentState

Syntax

Returns

Type Parameters

Equals Inherited Virtual

Syntax

Parameters

Returns

Equals Inherited

Syntax

Parameters

Returns

Forward

Syntax

Returns

GetHashCode Inherited Virtual

Syntax

Returns

GetScrollRestoration

Syntax

Returns

GetType Inherited

Syntax

Returns

Go

Syntax

Parameters

Returns

MemberwiseClone Inherited

Syntax

Returns

PushState

Syntax

Parameters

Returns

Type Parameters

ReferenceEquals Inherited

Syntax

Parameters

Returns

ReplaceState

Syntax

Parameters

Returns

Type Parameters

SetScrollRestoration

Syntax

Parameters

Returns

ToString Inherited Virtual

Syntax

Returns