List
IzzyBlazor.List in the IzzyBlazor.Core package, generated from the 0.1.0-alpha.17 assembly
and its doc comments.
Properties (7)
Orderedbool = falseA numbered list (ol).
Plainbool = falseNo bullets or numbers, and no indent.
IconIconData?An icon in place of each bullet, such as Lucide.Check. An item's own icon wins.
IconColorColor? (computed)The icons' color. Defaults to the text color.
Space between items, on the spacing scale. Defaults to 2 (8px).
Asstring = "ul"The element to render: div on a Box; components built on it set their own (List a ul, Section a section).
ChildContentRenderFragment?The content.
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.
Surface props (from StyledComponentBase)
ColorSchemeColorScheme = ColorScheme.AutoPadding on all sides, in spacing steps (0 to 16; one step = 4px).
Background color.
Text color. When not set and Bg is a theme color, the matching contrast color is used automatically (Bg="Color.Primary" gets Color.OnPrimary text).
Corner radius.
Elevation.
Minimum height.
Height.
Maximum height; pair it with Overflow to scroll what doesn't fit.
What happens to content that doesn't fit: Overflow.Auto to scroll it.
A border on every side, in whole pixels (0 to 16), in BorderColor (the border token by default) and BorderStyle (solid by default). Like padding: BorderX and BorderY override an axis, the single sides override that. Sides you don't set keep the component's own border.
Borders at the top and bottom, such as a band with lines above and below. Replaces Border on this axis.
The border color, for borders set here or the component's own. Defaults to Border.
How borders set here are drawn (BorderStyle.Dashed, BorderStyle.Dotted), and the own border of a Card or a bordered EmptyState. Solid by default (dashed on an EmptyState).
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 List, documented here with it.
ListItem
An item in a List: a li, with the list's icon or its own.
ChildContentRenderFragment?The content.
IconIconData?An icon for this item, in place of the list's.
IconColorColor?This item's icon color, in place of the list's.
Plus 4 common props.
Types (1)
Color
structA color: one of the theme's tokens (so it follows light and dark mode), a custom token from your own theme, or a raw CSS color.
| Member | Description |
|---|---|
Primary | Brand color. |
OnPrimary | Text and icons on |
Success | Success. |
OnSuccess | Text and icons on |
Warning | Warning. |
OnWarning | Text and icons on |
Danger | Danger. |
OnDanger | Text and icons on |
Info | Informational. |
OnInfo | Text and icons on |
Neutral | Neutral accent. |
OnNeutral | Text and icons on |
Background | The page, behind the surfaces: a near-white in the default theme. |
Surface | Cards, tables, fields and bars: white in light mode. |
FillSubtle | The quietest fill inside a surface, for large areas: a filled card, a panel, a band. |
Fill | A fill inside a surface that must show at small sizes: table heads, code, wells. |
FillStrong | The strongest fill: selected and pressed states, chips, tracks, skeletons. |
SurfaceOverlay | Overlays that float above the page: menus, popovers, dialogs, toasts. White like |
OnSurface | Text on any surface. |
Muted | Secondary text on any surface: descriptions, metadata. |
Subtle | Tertiary text: captions, hints, placeholders. Still at least 4.5:1 on Surface and Fill. |
Disabled | Text of disabled controls. Deliberately low contrast. |
PrimaryText |
|
SuccessText |
|
WarningText |
|
DangerText |
|
InfoText |
|
PrimarySoft | The accent's soft tint: soft buttons, the current page, chips. Text on it: |
SuccessSoft |
|
WarningSoft |
|
DangerSoft |
|
InfoSoft | |
Focus | The focus ring and field halo color: |
Border | Borders and dividers. Decorative: too light to be the only edge of a control. |
Outline | |
Transparent | Fully transparent. |
CurrentColor | The current text color. |
Token(string name) | A theme token by name, rendered as |
Of(string css) | A raw CSS color such as |
Css string | The CSS value this color renders as. |
TokenName string? | The theme token name, such as |
ContrastText Color? | The text color that pairs with this color used as a background: |