Alert
IzzyBlazor.Alert in the IzzyBlazor.Core package, generated from the 0.1.0-alpha.17 assembly
and its doc comments.
Properties (12)
StatusStatus = Status.InfoWhat the message means; sets the color and icon. Defaults to Status.Info.
VariantAlertVariant = AlertVariant.SoftHow it's drawn. Defaults to AlertVariant.Soft.
Titlestring?A short bold line above the message.
ChildContentRenderFragment?The message, and any AlertActions written last.
IconIconData?An icon in place of the status's own.
HideIconbool = falseLeaves out the icon.
Dismissiblebool = falseAdds a close button. Works with JavaScript off.
@bind-Dismissedbool = falseWhether it has been dismissed. Use @bind-Dismissed on interactive pages.
Announcebool = trueWhether screen readers announce it when it appears (role="alert" for danger and warning, role="status" otherwise). Defaults to true; toasts turn it off because their region announces them.
StatusLabelstring? (computed)What kind of message it is, read to screen readers before it (the icon and color carry it visually). Defaults to "Info", "Success", "Warning" or "Error" by Status (from IzzyText), and nothing for Neutral. Set it to "" to leave it out.
DismissLabelstring? = "Dismiss"The close button's accessible name. Defaults to "Dismiss".
Idstring?The element id. Generated when not set.
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 (0)
No events.
Parts (1)
Components written inside Alert, documented here with it.
AlertActions
Buttons or links below an Alert's message, such as "Retry" or "Details". Write it last in the alert; it's drawn where it is. A row like Row, with Gap, Align, Justify and Wrap (it wraps by default).
Space between children, in spacing steps (0 to 16).
Cross-axis alignment. Defaults to stretch.
Main-axis distribution. Defaults to start.
Wrapbool = falseWhether children wrap onto new lines: <Row Wrap>.
Inlinebool = falseRenders as inline-flex so the container sits in a line of text.
Asstring = "div"The element to render: div on a Box; components built on it set their own (List a ul, Section a section).
ChildContentRenderFragment?The content.
Plus 25 surface props, 16 item props and 4 common props.
Types (4)
AlertVariant
enumHow an Alert or toast is drawn.
| Value | Description |
|---|---|
Soft | A tinted background with a matching border (the default). |
Outline | A border in the status color on the page surface. |
Solid | A solid status-colored background. |
Align
enumCross-axis alignment of a Stack's children.
| Value | Description |
|---|---|
Stretch | Children stretch to fill the cross axis. |
Start | Aligned to the start. |
Center | Centered. |
End | Aligned to the end. |
Baseline | Aligned on their text baselines. |
Justify
enumMain-axis distribution of a Stack's children.
| Value | Description |
|---|---|
Start | Packed at the start. |
Center | Packed in the center. |
End | Packed at the end. |
Between | First and last at the edges, equal space between. |
Around | Equal space around each child. |
Evenly | Equal space between and at the edges. |
Status
enumThe 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.
| 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". |