Menu API · IzzyBlazor

Links, form posts and actions in a popover menu.

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

Properties (11)

Labelstring?

The default trigger's text.

AccentAccent = Accent.Neutral

The default trigger's color. Defaults to Neutral.

VariantButtonVariant = ButtonVariant.Outline

The default trigger's weight. Defaults to ButtonVariant.Outline.

SizeControlSize = ControlSize.Md

The default trigger's size.

StartIconIconData?

An icon before the default trigger's text.

TriggerRenderFragment<IReadOnlyDictionary<string, object>>?

A custom trigger in place of the default button. Its context holds the attributes that wire it to the menu; pass them on with @attributes="context". It must be a button.

PlacementPlacement = Placement.BottomStart

Where the menu opens. Defaults to Placement.BottomStart.

PanelWidthLength? (computed)

The width of the menu panel, such as Length.Rem(16) for a column of long labels. Defaults to the content's width, at least 10rem and the trigger's width, up to 24rem. Never wider than the screen.

ChildContentRenderFragment?

The MenuItems, MenuGroups and MenuDividers.

@bind-Openbool = false @bind: Interactive only

Whether it is open. Use @bind-Open to follow changes on interactive pages.

Idstring?

The element id. Generated when not set.

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 (5)

Components written inside Menu, documented here with it.

`MenuItem`

One entry in a Menu. Three kinds, so items act on static pages too:

Href: a link.
Submit: posts the surrounding form (or Form="id"), optionally to FormAction.
OnClick: runs C# on interactive pages; the item closes the menu natively.

Checkable: @bind-Checked makes it a checkbox item (menuitemcheckbox). Inside a MenuRadioGroup it's one of a set (menuitemradio), identified by Value. On static pages the action still comes from Href or a form post, and the server decides what's checked.

Menu roles promise arrow keys, which need the script. So static pages render them as data-ib-* attributes, and <ib-popover> turns them into roles when it adds the keys; with JavaScript off, items are plain links and buttons, a checked one marked aria-pressed (buttons) or aria-current (links). Interactive pages always have the script, so they render the roles directly.

Hrefstring?

Makes the item a link to this URL.

Submitbool = false

For button items: posts the surrounding form (or Form), optionally to FormAction.

@bind-Checkedbool? @bind: Interactive only

Makes this a checkbox item that shows a check when true, with @bind-Checked on interactive pages. Null (the default) is an ordinary item.

Namestring?

Posted as Name=Value when a submit item is chosen. Not action, method or target: a control with one of those names hides the form's own property, and Blazor's enhanced form handling then posts to the wrong address.

Valuestring?

The value posted with Name; in a MenuRadioGroup, the option this item picks.

FormActionstring?

Submits to this URL instead of the form's own action.

Formstring?

The id of the form to submit, when the menu is not inside it.

IconIconData?

An icon before the text.

Shortcutstring?

A keyboard hint shown at the end in a key cap, such as "Ctrl+C" or "⌘+C". Display only. The Mac modifier symbols ⌘ ⌥ ⇧ ⌃ are drawn as icons, so they look the same on every system.

AccentAccent = Accent.Neutral

The text color. Neutral (the default) is plain; use Danger for destructive items. A custom color is used as text, mixed toward the text color so it stays readable.

KeepOpenbool = false

Leaves the menu open when the item is chosen, so several checkbox items can be ticked in a row. A link item still navigates (with JavaScript off the page reloads and the menu closes).

Disabledbool = false

Shows the item but stops it from being chosen.

ChildContentRenderFragment?

The item text.

OnClickEventCallback<MouseEventArgs>Interactive only

Runs on click on interactive pages.

Plus 4 common props.

`MenuGroup`

A labeled section of a Menu.

Labelstring required

The section heading.

ChildContentRenderFragment?

The section's MenuItems.

Plus 4 common props.

`MenuDivider`

A line between groups of items in a Menu.

No parameters of its own.

`MenuRadioGroup`

A set of menu options where one is chosen (menuitemradio), each a MenuItem with a Value. How choosing works, so it works on static pages too:

QueryKey: each option is a link that sets ?key=value, and the chosen one comes from the URL.
Name: each option is a submit button posting Name=Value with the form it's in.
@bind-Value: on interactive pages, choosing updates C#.

Labelstring?

The section heading, which also names the group for screen readers.

@bind-Valuestring? @bind: Interactive only

The chosen option's value. With QueryKey and no value set, it's read from the URL.

QueryKeystring?

Makes each option a link that sets this query-string key, keeping the rest of the URL: ?sort=name. The page reads it with [SupplyParameterFromQuery].

Namestring?

Makes each option a submit button that posts Name=Value with its form.

ChildContentRenderFragment?

The MenuItems, each with a Value.

Plus 4 common props.

`MenuSub`

A submenu: an item that opens a second menu beside it. It's a nested popover, so clicking the item opens it with no script. With script it also opens on hover and with the arrow key toward it (Right in left-to-right pages), and Left or Escape closes it. Choosing an item in it closes the whole menu.

Labelstring required

The item's text.

IconIconData?

An icon before the text.

Disabledbool = false

Shows the item but stops the submenu from opening.

ChildContentRenderFragment?

The submenu's MenuItems, groups and dividers.

Plus 4 common props.

Types (5)

`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`.

`ButtonVariant`

enum

A button's visual weight, from strongest to quietest.

ButtonVariant values
Value	Description
`Solid`	Filled with the accent color. For the main action.
`Soft`	A light tint of the accent color.
`Outline`	An accent-colored border on a transparent background.
`Ghost`	Transparent until hovered. For toolbars and dense layouts.
`Link`	Looks like a link.

`ControlSize`

enum

The height of interactive controls. Shared by buttons and form fields, so a button and an input of the same size line up in a row.

ControlSize values
Value	Description
`Sm`	32px tall, small text.
`Md`	36px tall (the default).
`Lg`	44px tall, large text. For touch-first and marketing pages.

`Length`

struct

A width, height or flex basis: a size token, a keyword, or a CSS length built with a factory such as Rem.

Length members
Member	Description
`Sm`	640px (matches the `sm` breakpoint).
`Md`	768px (matches the `md` breakpoint).
`Lg`	1024px (matches the `lg` breakpoint).
`Xl`	1280px (matches the `xl` breakpoint).
`Prose`	A comfortable reading width, 68 characters.
`Full`	100% of the containing block.
`Auto`	`auto`.
`FitContent`	`fit-content`: as wide as the content, up to the available space.
`MinContent`	`min-content`.
`MaxContent`	`max-content`.
`Px(double value)`	Pixels.
`Rem(double value)`	Root ems (16px each by default).
`Percent(double value)`	Percent of the containing block.
`Ch(double value)`	Character widths, for text measures.
`Vw(double value)`	Percent of the viewport width.
`Dvh(double value)`	Percent of the dynamic viewport height (accounts for mobile browser bars).
`Of(string css)`	Any CSS length, such as `calc(100% - 2rem)`. Checked for unsafe characters.
`Css string`	The CSS value this length renders as.

`Placement`

enum

Where a floating element sits next to the thing that opened it. Start and End follow the reading direction, so they flip in right-to-left languages.

Placement values
Value	Description
`BottomStart`	Below, lined up with the start edge (the default for menus).
`Bottom`	Below, centered.
`BottomEnd`	Below, lined up with the end edge.
`TopStart`	Above, lined up with the start edge.
`Top`	Above, centered (the default for tooltips).
`TopEnd`	Above, lined up with the end edge.
`Start`	Beside, on the start side (the left in left-to-right languages).
`End`	Beside, on the end side (the right in left-to-right languages).