SplitButton

Since 0.1.0-alpha.20

A main action with a menu of related ones beside it.

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

Properties (24)

Labelstring requiredAdded in 0.1.0-alpha.20

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

StartIconIconData?Added in 0.1.0-alpha.20

An icon before the main button's text.

IconOnlybool = falseAdded in 0.1.0-alpha.20

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

Hrefstring?Added in 0.1.0-alpha.20

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

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

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

Namestring?Added in 0.1.0-alpha.20

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

The value posted with Name.

FormActionstring?Added in 0.1.0-alpha.20

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

Formstring?Added in 0.1.0-alpha.20

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

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

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

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

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

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

Disables both parts.

Loadingbool = falseAdded in 0.1.0-alpha.20

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

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

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

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

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

FullWidthbool = falseAdded in 0.1.0-alpha.20

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

MainDisabledbool = falseAdded in 0.1.0-alpha.20

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

MenuDisabledbool = falseAdded in 0.1.0-alpha.20

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

PlacementPlacement = Placement.BottomStartAdded in 0.1.0-alpha.20

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

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

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

The MenuItems, MenuGroups and MenuDividers.

Plus 16 item props and 4 common props.

Show them here

Events (1)

OnClickEventCallback<MouseEventArgs>Added in 0.1.0-alpha.20Interactive only

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

Parts (1)

Components written inside SplitButton, documented here with it.

`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

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

The MenuItems, MenuGroups and MenuDividers.

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.

Plus 16 item props and 4 common props.

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

`ToolbarOverflow`

enum

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

ToolbarOverflow values
Value	Description
`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
Value	Description
`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.