Skip to content
IzzyBlazor 0.1.0-alpha.20

Enter all results ↑ ↓ move Esc close

Actions

Since 0.1.0-alpha.13
Form posts, C# on click, toggle buttons and split buttons, from the bar or the menu.

The members for actions, and the types they use. Every member of IzzyBlazor.Toolbar is on the Toolbar API.

Parts (3)

Components written inside Toolbar, and the columns' members, which PropertyColumn and TemplateColumn share.

ToolbarButton

A Button in a Toolbar or a ToolbarButtonGroup. In the "…" menu it's a menu item with the same link, form post and OnClick; a toggle (Pressed) is a checkbox item there.

Submitbool = falseAdded in 0.1.0-alpha.13From Button

Submits the form it's in (or Form), like type="submit". Without Submit or Reset, a button does nothing by itself.

Namestring?Added in 0.1.0-alpha.13From Button

Posted with the form as Name=Value when this button submits it, so one handler can tell which of several submit buttons was pressed. 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?Added in 0.1.0-alpha.13From Button

The value posted with Name.

FormActionstring?Added in 0.1.0-alpha.13From Button

Submits to this URL instead of the form's own action (native formaction).

Formstring?Added in 0.1.0-alpha.13From Button

The id of a form elsewhere on the page that this button submits (native form).

@bind-Pressedbool?Added in 0.1.0-alpha.14 @bind: Interactive only

Makes it a toggle button, such as Bold in an editor: true shows it pressed, false not, and screen readers hear which (aria-pressed). With @bind-Pressed a click turns it on and off on interactive pages; on static pages the server decides, as with a submit button's Name and Value. Null (the default) is an ordinary button. Not for links.

OnClickEventCallback<MouseEventArgs>Added in 0.1.0-alpha.13From ButtonInteractive only

Runs on click on interactive pages (a link still navigates). Has no effect on static pages.

ToolbarIconButton

An IconButton in a Toolbar or a ToolbarButtonGroup. In the "…" menu it's a menu item with its icon, its Label as text, and the same link, form post and OnClick; a toggle (Pressed) is a checkbox item there.

Submitbool = falseAdded in 0.1.0-alpha.13From IconButton

Submits the form it's in (or Form), when it's a button (not a link), like type="submit".

Namestring?Added in 0.1.0-alpha.13From IconButton

Posted with the form as Name=Value when this button submits it, so one handler can tell which button was pressed, such as which row's Delete. 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?Added in 0.1.0-alpha.13From IconButton

The value posted with Name.

FormActionstring?Added in 0.1.0-alpha.13From IconButton

Submits to this URL instead of the form's own action (native formaction).

Formstring?Added in 0.1.0-alpha.13From IconButton

The id of a form elsewhere on the page that this button submits (native form).

@bind-Pressedbool?Added in 0.1.0-alpha.14 @bind: Interactive only

Makes it a toggle button, such as Bold in an editor: true shows it pressed, false not, and screen readers hear which (aria-pressed). With @bind-Pressed a click turns it on and off on interactive pages; on static pages the server decides, as with a submit button's Name and Value. Null (the default) is an ordinary button. Not for links.

OnClickEventCallback<MouseEventArgs>Added in 0.1.0-alpha.13From IconButtonInteractive only

Runs on click on interactive pages (a link still navigates).

ToolbarSplitButton

A SplitButton in a Toolbar. In the "…" menu it's a submenu named by its MenuLabel, with the main action as its first item, then the same items; with MenuDisabled it's just the main action.

PositionToolbarPosition = ToolbarPosition.StartAdded in 0.1.0-alpha.20

Where it sits. Defaults to ToolbarPosition.Start.

Priorityint = 0Added in 0.1.0-alpha.20

Which items stay longest when there's no room: higher stays longer. Defaults to 0. Items with the same priority move into the menu from the middle of the toolbar outward.

OverflowToolbarOverflow = ToolbarOverflow.AutoAdded in 0.1.0-alpha.20

When it moves into the "…" menu: ToolbarOverflow.Never for the main action, ToolbarOverflow.Always for what only the menu needs. Defaults to ToolbarOverflow.Auto.

Labelstring requiredAdded in 0.1.0-alpha.20From SplitButton

The main button's text, or with IconOnly its name for screen readers and its tooltip.

StartIconIconData?Added in 0.1.0-alpha.20From SplitButton

An icon before the main button's text.

IconOnlybool = falseAdded in 0.1.0-alpha.20From SplitButton

Shows only StartIcon on the main button, which it needs. Label still names it.

Hrefstring?Added in 0.1.0-alpha.20From SplitButton

Makes the main button a link to this URL (an a). A link can't take Submit, Name, Value, FormAction or Form.

Externalbool = falseAdded in 0.1.0-alpha.20From SplitButton

For a link: opens in a new tab with rel="noopener noreferrer" and shows an external-link icon.

Submitbool = falseAdded in 0.1.0-alpha.20From SplitButton

Makes the main button submit the form it's in (or Form), like type="submit".

Namestring?Added in 0.1.0-alpha.20From SplitButton

Posted with the form as Name=Value when the main button submits it, so one handler can tell it from the menu's items. Not action, method or target: a control with one of those names hides the form's own property.

Valuestring?Added in 0.1.0-alpha.20From SplitButton

The value posted with Name.

FormActionstring?Added in 0.1.0-alpha.20From SplitButton

Submits to this URL instead of the form's own action (native formaction).

Formstring?Added in 0.1.0-alpha.20From SplitButton

The id of a form elsewhere on the page that the main button submits (native form).

MenuLabelstring? (computed)Added in 0.1.0-alpha.20From SplitButton

The name of the arrow that opens the menu, for screen readers and its tooltip, and of the submenu in a Toolbar's "…" menu. Defaults to "{Label}: more options" (SplitButtonMenu).

AccentAccent? (computed)Added in 0.1.0-alpha.20From SplitButton

The color of both parts. Defaults to a ButtonGroup's or Toolbar's around it, else Primary.

VariantButtonVariant? (computed)Added in 0.1.0-alpha.20From SplitButton

The weight of both parts. Defaults to a ButtonGroup's or Toolbar's around it, else ButtonVariant.Solid.

SizeControlSize? (computed)Added in 0.1.0-alpha.20From SplitButton

The height of both parts. Defaults to a ButtonGroup's or Toolbar's around it, else ControlSize.Md.

Disabledbool = falseAdded in 0.1.0-alpha.20From SplitButton

Disables both parts.

Loadingbool = falseAdded in 0.1.0-alpha.20From SplitButton

Shows a spinner on the main button and blocks both parts, which keep focus.

LoadingLabelstring? = "Loading"Added in 0.1.0-alpha.20From SplitButton

Read to screen readers while Loading. Defaults to "Loading".

NewTabLabelstring? = "(opens in a new tab)"Added in 0.1.0-alpha.20From SplitButton

Read to screen readers after an external link's text. Defaults to "(opens in a new tab)".

FullWidthbool = falseAdded in 0.1.0-alpha.20From SplitButton

Stretches to the full width of its container; the main button takes the extra width.

MainDisabledbool = falseAdded in 0.1.0-alpha.20From SplitButton

Disables only the main button, such as when no default is available but the items still are.

MenuDisabledbool = falseAdded in 0.1.0-alpha.20From SplitButton

Disables only the arrow, such as when there's nothing else to choose.

PlacementPlacement = Placement.BottomStartAdded in 0.1.0-alpha.20From SplitButton

Where the menu opens, against the whole button. Defaults to Placement.BottomStart.

PanelWidthLength? (computed)Added in 0.1.0-alpha.20From SplitButton

The width of the menu panel, as on Menu. Defaults to the content's width, at least 10rem, up to 24rem.

ChildContentRenderFragment?Added in 0.1.0-alpha.20From SplitButton
OnClickEventCallback<MouseEventArgs>Added in 0.1.0-alpha.20From SplitButtonInteractive only

Runs when the main button is clicked on interactive pages (a link still navigates). Has no effect on static pages.

Types (7)

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
MemberDescription
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
ValueDescription
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
ValueDescription
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
MemberDescription
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
ValueDescription
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).

ToolbarOverflow

enum

When an item of a Toolbar moves into its "…" menu.

ToolbarOverflow values
ValueDescription
Auto

When there's no room for it, in order of Priority (the default).

Never

Never: it stays in the bar, such as the main action.

Always

Always: it's only in the menu, such as Print or Version history.

ToolbarPosition

enum

Where an item of a Toolbar sits.

ToolbarPosition values
ValueDescription
Start

At the start (the left in left-to-right text), the default.

Center

In the middle, kept centered between the start and the end.

End

At the end, before the "…" menu.

Connection lost

Rejoining the server…