NavigationItem

Definition

Assembly: CloudNimble.BlazorEssentials.dll Namespace: CloudNimble.BlazorEssentials.Navigation Inheritance: CloudNimble.BlazorEssentials.InterfaceElement

Syntax

CloudNimble.BlazorEssentials.Navigation.NavigationItem

Summary

Defines an app navigation structure suitable for binding to navigation menus.

Constructors

.ctor

Syntax

public NavigationItem()

.ctor

Creates a new instance with the minimum-required items to render a Blazor NavLink.

Syntax

public NavigationItem(string text, string icon, string url)

Parameters

Name	Type	Description
`text`	`string`	A string representing the text that will be displayed in the NavBar.
`icon`	`string`	A string representing the CSS class(es) for the icon that can be displayed next to the InterfaceElement.DisplayText.
`url`	`string`	A string corresponding to the route for this NavigationItem.

.ctor

Syntax

public NavigationItem(string text, string icon, string url, string category)

Parameters

Name	Type	Description
`text`	`string`	A string representing the text that will be displayed in the NavBar.
`icon`	`string`	A string representing the CSS class(es) for the icon that can be displayed next to the InterfaceElement.DisplayText.
`url`	`string`	A string corresponding to the route for this NavigationItem.
`category`	`string`	A string representing the parent category for this NavigationItem. Can be useful for grouping
NavigationItemNavigationItems</see> into caregories for display.

.ctor

Syntax

public NavigationItem(string text, string icon, string url, string category, bool isVisible)

Parameters

Name	Type	Description
`text`	`string`	A string representing the text that will be displayed in the NavBar.
`icon`	`string`	A string representing the CSS class(es) for the icon that can be displayed next to the InterfaceElement.DisplayText.
`url`	`string`	A string corresponding to the route for this NavigationItem.
`category`	`string`	A string representing the parent category for this NavigationItem. Can be useful for grouping
NavigationItemNavigationItems</see> into caregories for display.
`isVisible`	`bool`	Specifies whether or not this NavigationItem is visible on the NavBar.

.ctor

Syntax

public NavigationItem(string text, string icon, string category, bool isVisible, System.Collections.Generic.List<CloudNimble.BlazorEssentials.Navigation.NavigationItem> children)

Parameters

Name	Type	Description
`text`	`string`	A string representing the text that will be displayed in the NavBar.
`icon`	`string`	A string representing the CSS class(es) for the icon that can be displayed next to the InterfaceElement.DisplayText.
`category`	`string`	A string representing the parent category for this NavigationItem. Can be useful for grouping
NavigationItemNavigationItems</see> into caregories for display.
`isVisible`	`bool`	Specifies whether or not this NavigationItem is visible on the NavBar.
`children`	`System.Collections.Generic.List<CloudNimble.BlazorEssentials.Navigation.NavigationItem>`	A List`1 containing nodes to render underneath this one.

.ctor

Syntax

public NavigationItem(string text, string icon, string url, string category, bool isVisible, string pageTitle, string pageIcon)

Parameters

Name	Type	Description
`text`	`string`	A string representing the text that will be displayed in the NavBar.
`icon`	`string`	A string representing the CSS class(es) for the icon that can be displayed next to the InterfaceElement.DisplayText.
`url`	`string`	A string corresponding to the route for this NavigationItem.
`category`	`string`	A string representing the parent category for this NavigationItem. Can be useful for grouping
NavigationItemNavigationItems</see> into caregories for display.
`isVisible`	`bool`	Specifies whether or not this NavigationItem is visible on the NavBar.
`pageTitle`	`string`	A string representing the text that can be displayed as a page header.
`pageIcon`	`string`	A string representing the CSS class(es) for the icon that can be displayed next to the NavigationItem.PageTitle in a page header.

.ctor

Syntax

public NavigationItem(string text, string icon, string url, string category, bool isVisible, string pageTitle, string pageIcon, string roles, bool allowAnonymous = false)

Parameters

Name	Type	Description
`text`	`string`	A string representing the text that will be displayed in the NavBar.
`icon`	`string`	A string representing the CSS class(es) for the icon that can be displayed next to the InterfaceElement.DisplayText.
`url`	`string`	A string corresponding to the route for this NavigationItem.
`category`	`string`	A string representing the parent category for this NavigationItem. Can be useful for grouping
NavigationItemNavigationItems</see> into caregories for display.
`isVisible`	`bool`	Specifies whether or not this NavigationItem is visible on the NavBar.
`pageTitle`	`string`	A string representing the text that can be displayed as a page header.
`pageIcon`	`string`	A string representing the CSS class(es) for the icon that can be displayed next to the NavigationItem.PageTitle in a page header.
`roles`	`string`	-
`allowAnonymous`	`bool`	-

.ctor Inherited

Inherited from CloudNimble.BlazorEssentials.InterfaceElement

Syntax

public InterfaceElement()

.ctor Inherited

Inherited from CloudNimble.BlazorEssentials.InterfaceElement

Syntax

public InterfaceElement(string displayText, string iconClass, string cssClass = null)

Parameters

Name	Type	Description
`displayText`	`string`	-
`iconClass`	`string`	-
`cssClass`	`string`	-

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

AccessibilityText

Test to be used for screen readers when this item is rendered.

Syntax

public string AccessibilityText { get; set; }

Property Value

Type: string

AllowAnonymous

A Boolean specifying whether or not this NavigationItem is visible when a user is not logged in.

Syntax

public bool AllowAnonymous { get; }

Property Value

Type: bool

Children

Syntax

public System.Collections.Generic.List<CloudNimble.BlazorEssentials.Navigation.NavigationItem> Children { get; set; }

Property Value

Type: System.Collections.Generic.List<CloudNimble.BlazorEssentials.Navigation.NavigationItem>

CssClass Inherited

Inherited from CloudNimble.BlazorEssentials.InterfaceElement

A string representing the CSS classes that will be applied to the element.

Syntax

public string CssClass { get; set; }

Property Value

Type: string

DisplayText Inherited

Inherited from CloudNimble.BlazorEssentials.InterfaceElement

A string representing the text that will be displayed inside the element.

Syntax

public string DisplayText { get; set; }

Property Value

Type: string

IconClass Inherited

Inherited from CloudNimble.BlazorEssentials.InterfaceElement

A string representing the CSS class for the icon that will be rendered immediately before the InterfaceElement.DisplayText.

Syntax

public string IconClass { get; set; }

Property Value

Type: string

IsVisible

Specifies whether or not this NavigationItem is visible on the NavBar. Defaults to True.

Syntax

public bool IsVisible { get; set; }

Property Value

Type: bool

PageIcon

A string representing the CSS class(es) for the icon that can be displayed next to the NavigationItem.PageTitle in a page header.

Syntax

public string PageIcon { get; set; }

Property Value

Type: string

PageTitle

A string representing the text that can be displayed as a page header.

Syntax

public string PageTitle { get; set; }

Property Value

Type: string

Parameters

Allows you to set parameters specific to the page that you do NOT want to pass through the Routing system.

Syntax

public dynamic Parameters { get; set; }

Property Value

Type: dynamic

Remarks

Accessible through AppStateBase.CurrentNavItem.

Roles

A HashSet`1 of roles that this NavigationItem is visible to.

Syntax

public System.Collections.Generic.HashSet<string> Roles { get; private set; }

Property Value

Type: System.Collections.Generic.HashSet<string>

Url

A string corresponding to the route for this NavigationItem.

Syntax

public string Url { get; set; }

Property Value

Type: string

Methods

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

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

IsVisibleToUser

Returns a boolean indicating whether or not the NavItem is available to any of the Roles the claimsPrincipal is in.

Syntax

public bool IsVisibleToUser(System.Security.Claims.ClaimsPrincipal claimsPrincipal)

Parameters

Name	Type	Description
`claimsPrincipal`	`System.Security.Claims.ClaimsPrincipal`	-

Returns

Type: bool

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

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

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?

Getting Started

Guides

API Reference

​Definition

​Syntax

​Summary

​Constructors

​ .ctor

​Syntax

​ .ctor

​Syntax

​Parameters

​ .ctor

​Syntax

​Parameters

​ .ctor

​Syntax

​Parameters

​ .ctor

​Syntax

​Parameters

​ .ctor

​Syntax

​Parameters

​ .ctor

​Syntax

​Parameters

​ .ctor Inherited

​Syntax

​ .ctor Inherited

​Syntax

​Parameters

​ .ctor Inherited

​Syntax

​Properties

​ AccessibilityText

​Syntax

​Property Value

​ AllowAnonymous

​Syntax

​Property Value

​ Category

​Syntax

​Property Value

​ Children

​Syntax

​Property Value

​ CssClass Inherited

​Syntax

​Property Value

​ DisplayText Inherited

​Syntax

​Property Value

​ IconClass Inherited

​Syntax

​Property Value

​ IsVisible

​Syntax

​Property Value

​ PageIcon

​Syntax

​Property Value

​ PageTitle

​Syntax

​Property Value

​ Parameters

​Syntax

​Property Value

​Remarks

​ Roles

​Syntax

​Property Value

​ Url

​Syntax

​Property Value

​Methods

​ Equals Inherited Virtual

​Syntax

​Parameters

​Returns

Definition

Syntax

Summary

Constructors

.ctor

Syntax

.ctor

Syntax

Parameters

.ctor

Syntax

Parameters

.ctor

Syntax

Parameters

.ctor

Syntax

Parameters

.ctor

Syntax

Parameters

.ctor

Syntax

Parameters

.ctor Inherited

Syntax

.ctor Inherited

Syntax

Parameters

.ctor Inherited

Syntax

Properties

AccessibilityText

Syntax

Property Value

AllowAnonymous

Syntax

Property Value

Category

Syntax

Property Value

Children

Syntax

Property Value

CssClass Inherited

Syntax

Property Value

DisplayText Inherited

Syntax

Property Value

IconClass Inherited

Syntax

Property Value

IsVisible

Syntax

Property Value

PageIcon

Syntax

Property Value

PageTitle

Syntax

Property Value

Parameters

Syntax

Property Value

Remarks

Roles

Syntax

Property Value

Url

Syntax

Property Value

Methods

Equals Inherited Virtual

Syntax

Parameters

Returns

Equals Inherited

Syntax

Parameters