DescriptionList

Terms and their details.

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

Properties (5)

ChildContentRenderFragment?

The DescriptionItems.

OrientationOrientation = Orientation.Horizontal

Orientation.Horizontal (the default) puts each term beside its detail on screens 640px and wider; Orientation.Vertical puts the term above.

Dividedbool = false

Lines between the items.

Columnsint = 1

For a vertical list, how many columns the items flow into on screens 640px and wider (1 to 4; defaults to 1). Phones always get one.

SizeControlSize = ControlSize.Md

Text size and spacing. Defaults to ControlSize.Md.

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.

Surface props (from StyledComponentBase)

ColorSchemeColorScheme = ColorScheme.Auto

The color scheme inside: ColorScheme.Dark for a dark band on a light page, ColorScheme.Inverse for the opposite of the page. It also sets the surface background and text color, which Bg and Color override.

PaddingResponsive<int>Responsive

Padding on all sides, in spacing steps (0 to 16; one step = 4px).

PaddingXResponsive<int>Responsive

Horizontal padding. When set, replaces Padding on this axis.

PaddingYResponsive<int>Responsive

Vertical padding. When set, replaces Padding on this axis.

PaddingTopResponsive<int>Responsive

Top padding. When set, replaces PaddingY and Padding on this side.

PaddingBottomResponsive<int>Responsive

Bottom padding. When set, replaces PaddingY and Padding on this side.

PaddingStartResponsive<int>Responsive

Padding at the start (left in left-to-right text, right in right-to-left). Replaces PaddingX and Padding on this side.

PaddingEndResponsive<int>Responsive

Padding at the end (right in left-to-right text, left in right-to-left). Replaces PaddingX and Padding on this side.

BgResponsive<Color>Responsive

Background color.

ColorResponsive<Color>Responsive

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

RadiusResponsive<Radius>Responsive

Corner radius.

ShadowResponsive<Shadow>Responsive

Elevation.

MinHeightResponsive<Length>Responsive

Minimum height.

HeightResponsive<Length>Responsive

Height.

MaxHeightResponsive<Length>Responsive

Maximum height; pair it with Overflow to scroll what doesn't fit.

OverflowResponsive<Overflow>Responsive

What happens to content that doesn't fit: Overflow.Auto to scroll it.

BorderResponsive<int>Responsive

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.

BorderXResponsive<int>Responsive

Borders at the start and end. Replaces Border on this axis.

BorderYResponsive<int>Responsive

Borders at the top and bottom, such as a band with lines above and below. Replaces Border on this axis.

BorderTopResponsive<int>Responsive

The top border. Replaces BorderY and Border on this side.

BorderBottomResponsive<int>Responsive

The bottom border. Replaces BorderY and Border on this side.

BorderStartResponsive<int>Responsive

The border at the start (left in left-to-right text). Replaces BorderX and Border on this side.

BorderEndResponsive<int>Responsive

The border at the end (right in left-to-right text). Replaces BorderX and Border on this side.

BorderColorResponsive<Color> (computed)Responsive

The border color, for borders set here or the component's own. Defaults to Border.

BorderStyleResponsive<BorderStyle>Responsive

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.

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 DescriptionList, documented here with it.

`DescriptionItem`

One term and its detail in a DescriptionList: <div><dt/><dd/></div>.

Termstring?

The term, such as "Status".

TermContentRenderFragment?

Custom term content, such as text with an icon or a tooltip. Replaces Term.

ChildContentRenderFragment?

The detail.

Plus 4 common props.

Types (2)

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

`Orientation`

enum

Whether items run across or down.

Orientation values
Value	Description
`Vertical`	Top to bottom.
`Horizontal`	Side by side, wrapping when space runs out.