Banner API · IzzyBlazor

A full-width message about the whole app.

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

Properties (17)

StatusStatus = Status.Info

What the message means; sets the color and icon. Defaults to Status.Info.

AccentAccent?

A color in place of the status's own, such as Accent.Primary for a product announcement, or Accent.Of("#0d9488"). The status still sets the icon and what screen readers hear.

VariantAlertVariant = AlertVariant.Soft

How it's drawn. Defaults to AlertVariant.Soft.

PositionBarPosition = BarPosition.Static

Whether it stays at the top of the window while the page scrolls (BarPosition.Sticky) or scrolls away with it. Defaults to BarPosition.Static.

Titlestring?

A short bold lead-in before the message, on the same line.

ChildContentRenderFragment?

The message. Keep it to a line or two.

IconIconData?

An icon in place of the status's own.

HideIconbool = false

Leaves out the icon.

Dismissiblebool = false

Adds a close button. Works with JavaScript off.

RememberDismissMemory = DismissMemory.Session

How long a dismissal lasts, with Dismissible: DismissMemory.Session (the default) until the browser closes, DismissMemory.Persistent for a year, DismissMemory.None only on the page (it shows again on the next one).

RememberKeystring?

Names the cookie that remembers a dismissal: ib-banner-{key}. Change the key ("maintenance-2026-11") to show a new message to everyone again. Unset, the key comes from the Title, text and links, so changing the message shows it again; a banner whose text comes from a component of the app's own (a localizer) is remembered only with a key, since its text can't be read. Letters, digits, -, _ and . only.

@bind-Dismissedbool = false @bind: Interactive only

Whether it has been dismissed. Use @bind-Dismissed on interactive pages.

Announcebool = false

Whether screen readers announce the message when it appears (role="alert" for danger and warning, role="status" otherwise). Off by default: a banner is usually there when the page loads, and screen readers find it as a labeled region. Turn it on for a banner you show in response to something, such as a lost connection.

StatusLabelstring? (computed)

What kind of message it is, read to screen readers before it. Defaults to "Info", "Success", "Warning" or "Error" by Status (from IzzyText), and nothing for Neutral. Set it to "" to leave it out.

Labelstring? = "Announcement"

The region's accessible name. Defaults to "Announcement".

DismissLabelstring? = "Dismiss"

The close button's accessible name. Defaults to "Dismiss".

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

Components written inside Banner, documented here with it.

`BannerActions`

Links or buttons after a Banner's message, such as "Details". Write it directly in the banner; the banner draws it after the message.

ChildContentRenderFragment?

The part's content.

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

`AlertVariant`

enum

How an Alert or toast is drawn.

AlertVariant values
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.

`BarPosition`

enum

Whether an AppShell header or footer scrolls with the page.

BarPosition values
Value	Description
`Static`	Scrolls away with the page.
`Sticky`	Stays in view: the header at the top, the footer at the bottom.

`DismissMemory`

enum

How long a dismissed Banner stays dismissed.

DismissMemory values
Value	Description
`Session`	Until the browser closes (a session cookie). The default.
`Persistent`	For a year, across visits.
`None`	Not remembered: it shows again on the next page.

`Status`

enum

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

Status values
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".