NavMenu

A list of links that marks the current page.

IzzyBlazor.NavMenu in the IzzyBlazor.Core package, generated from the 0.1.0-alpha.17 assembly and its doc comments.

Properties (2)

OrientationOrientation = Orientation.Vertical

Vertical for sidebars (the default), horizontal for header bars.

ChildContentRenderFragment?

The items: NavItem, NavGroup, NavLabel, NavDivider.

Item props (from LayoutItemBase)

MarginResponsive<int>Responsive

Margin on all sides, in spacing steps (-16 to 16; one step = 4px).

MarginXResponsive<int>Responsive

Horizontal margin. When set, replaces Margin on this axis.

MarginYResponsive<int>Responsive

Vertical margin. When set, replaces Margin on this axis.

MarginTopResponsive<int>Responsive

Top margin. When set, replaces MarginY and Margin on this side.

MarginBottomResponsive<int>Responsive

Bottom margin. When set, replaces MarginY and Margin on this side.

MarginStartResponsive<int>Responsive

Margin at the start (left in left-to-right text, right in right-to-left). Replaces MarginX and Margin on this side.

MarginEndResponsive<int>Responsive

Margin at the end (right in left-to-right text, left in right-to-left). Replaces MarginX and Margin on this side.

WidthResponsive<Length>Responsive

Width.

MinWidthResponsive<Length>Responsive

Minimum width.

MaxWidthResponsive<Length>Responsive

Maximum width.

Growbool = false

Whether to grow into free space inside a Stack, Row or Column: <Box Grow>.

Shrinkbool = true

Whether to shrink when space is short inside a Stack, Row or Column. Defaults to true; Shrink="false" keeps the size.

BasisResponsive<Length>Responsive

Starting size inside a Stack, before growing or shrinking.

AlignSelfResponsive<Align>Responsive

Alignment across the parent's direction, overriding the parent's Align for this component only, such as a button lined up with the bottom of labeled fields in a Row.

ColSpanResponsive<int>Responsive

How many columns it spans in a Form or Fieldset with Columns, or a Grid; GridSpan.Full for the whole row. Never more than the columns shown, so a form that narrows to one column needs no breakpoints.

NewRowbool = false

Starts a new row in a Form or Fieldset with Columns, or a Grid, leaving the rest of the row before it empty.

Common props (from IzzyComponentBase)

Classstring?

Extra CSS classes, merged after the component's own classes.

Stylestring?

Inline style, appended after the component's generated custom properties.

HiddenFromBreakpoint?

Hides the component from this breakpoint up, such as a menu button only phones need.

VisibleFromBreakpoint?

Shows the component only from this breakpoint up, such as header links for wide screens.

Events (0)

No events.

Parts (4)

Components written inside NavMenu, documented here with it.

`NavItem`

One navigation link. The active state is worked out on the server from the current URL, so it is right on static pages and after enhanced navigation. In a list of links (NavMenu, SiteNav), of links to one page told apart by the query, only one is current (NavLinks).

Hrefstring required

The destination.

IconIconData?

An icon before the text.

MatchNavLinkMatch = NavLinkMatch.Prefix

How the current URL must match Href to be active. Prefix (the default) also matches pages below it; All matches only the exact page. A root link ("/") always needs an exact match, and so does a link with a query string, whose query must be the same too. A link without a query is current on its page whatever the query, unless another link in the same NavMenu or SiteNav with a query matches, so of links told apart by the query (?view=starred) only one is current.

Badgestring?

A small count or label after the text, such as "3" or "New".

BadgeStatusStatus = Status.Neutral

What the badge means. Defaults to neutral.

BadgeAccentAccent?

A badge color in place of the status's, such as Accent.Primary for an unread count.

BadgeVariantBadgeVariant = BadgeVariant.Soft

The badge's look. Defaults to BadgeVariant.Soft; BadgeVariant.Plain is a quiet count with no fill, as docs and mail sidebars show totals.

ChildContentRenderFragment?

The link text.

Plus 4 common props.

`NavGroup`

A collapsible group of nav items, built on <details>, so it opens and closes with no JavaScript. It starts open when Open is set or the current page is under ActivePrefix; with JavaScript, any group containing the current page also opens itself.

Labelstring required

The group's heading.

IconIconData?

An icon before the heading.

Openbool = false

Starts open.

ActivePrefixstring?

Starts open when the current path is at or below this path, such as /projects.

ChildContentRenderFragment?

The items in the group.

`NavLabel`

A small heading that labels the items below it in a NavMenu: a plain list item, since a list holds only items.

ChildContentRenderFragment?

The heading text.

Plus 4 common props.

`NavDivider`

A line between groups of items in a NavMenu. Hidden from screen readers: a list holds only items, so it can't be a separator, and an empty item would be read as one.

No parameters of its own.

Plus 4 common props.

Types (4)

`Accent`

class

The color of a control: buttons, badges, tags, banners, progress bars and menu items. Primary, Neutral and Danger are the roles; emphasis comes from the variant (solid, soft, outline, ghost, link), not from more colors. For one control in another color, use Of (any CSS color) or Token (a theme token); text on it is chosen for contrast.

Accent members
Member	Description
`Primary`	The brand color, for the main action.
`Neutral`	A quiet, gray action.
`Danger`	A destructive action, such as Delete.
`Of(string css)`	Any CSS color, such as `"#0d9488"`. Text on it is black or white, whichever reads better.
`Token(string name)`	A theme token, such as `"brand"` for `--ib-color-brand`; text on it uses `--ib-color-on-brand` when the theme defines it.
`From(Color color)`	A `Color` as an accent, such as `Color.Success`.

`BadgeVariant`

enum

A badge's visual weight.

BadgeVariant values
Value	Description
`Soft`	A light tint of the color (the default).
`Solid`	Filled with the color.
`Outline`	A colored border.
`Plain`	Just the text, in the color's text shade, with no fill or border: a quiet count, such as the totals beside sidebar links. Neutral is a muted gray.

`Orientation`

enum

Whether items run across or down.

Orientation values
Value	Description
`Vertical`	Top to bottom.
`Horizontal`	Side by side, wrapping when space runs out.

`Status`

enum

The meaning of a piece of feedback: badges, and later alerts and toasts. Status colors are for telling people what happened, not for actions; see Accent.

Status values
Value	Description
`Neutral`	No particular meaning (the default).
`Info`	Information, such as "New" or "Beta".
`Success`	Done or healthy, such as "Published".
`Warning`	Needs attention, such as "In review" or "Expiring".
`Danger`	Failed or blocked, such as "Error" or "Overdue".