Button
IzzyBlazor.Button in the IzzyBlazor.Core package, generated from the 0.1.0-alpha.17 assembly
and its doc comments.
Properties (21)
Hrefstring?Externalbool = falseFor a link: opens in a new tab with rel="noopener noreferrer" and shows an external-link icon.
HideExternalIconbool = falseLeaves out an external link's icon, for repeated links where it would be noise. Screen readers still hear NewTabLabel.
NewTabLabelstring? = "(opens in a new tab)"Read to screen readers after an external link's text. Defaults to "(opens in a new tab)".
Submitbool = falseNamestring?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.
FormActionstring?Submits to this URL instead of the form's own action (native formaction).
Formstring?The id of a form elsewhere on the page that this button submits (native form).
AccentAccent = Accent.PrimaryPrimary (the default) for the main action, Neutral for everything else, Danger for destructive actions, or a custom color (Accent.Of("#0d9488"), Accent.Token("brand")); text on a custom color is chosen for contrast. Emphasis comes from Variant.
VariantButtonVariant = ButtonVariant.SolidVisual weight. Defaults to ButtonVariant.Solid.
SizeControlSize = ControlSize.MdHeight. Defaults to ControlSize.Md.
StartIconIconData?An icon before the text.
EndIconIconData?An icon after the text.
FullWidthbool = falseStretches to the full width of its container.
Loadingbool = falseShows a spinner in place of the start icon and blocks further clicks.
LoadingLabelstring? = "Loading"Read to screen readers while Loading. Defaults to "Loading".
Disabledbool = falseDisables the button.
@bind-Pressedbool?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.
ChildContentRenderFragment?The label.
Item props (from LayoutItemBase)
Margin on all sides, in spacing steps (-16 to 16; one step = 4px).
Width.
Minimum width.
Maximum width.
Growbool = falseWhether to grow into free space inside a Stack, Row or Column: <Box Grow>.
Shrinkbool = trueWhether to shrink when space is short inside a Stack, Row or Column. Defaults to true; Shrink="false" keeps the size.
Starting size inside a Stack, before growing or shrinking.
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.
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.
VisibleFromBreakpoint?Shows the component only from this breakpoint up, such as header links for wide screens.
Events (1)
OnClickEventCallback<MouseEventArgs>Runs on click on interactive pages (a link still navigates). Has no effect on static pages.
Types (3)
Accent
classThe 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.
| 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 |
Token(string name) | A theme token, such as |
From(Color color) | A |
ButtonVariant
enumA button's visual weight, from strongest to quietest.
| 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
enumThe 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.
| Value | Description |
|---|---|
Sm | 32px tall, small text. |
Md | 36px tall (the default). |
Lg | 44px tall, large text. For touch-first and marketing pages. |