CodeExample

A live example with its source under it.

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

Properties (13)

ChildContentRenderFragment?

The live example.

Codestring?

The example's source. For several files, write CodeExampleFiles instead (or as well: this is then the first tab).

Languagestring = "razor"

The language of the source, for colors. Defaults to "razor".

Titlestring?

A file name for the source, such as "SignIn.razor", in a header row (or on its tab).

HighlightLinesstring?

Lines of the source to highlight, such as "3-5,9".

LineNumbersbool = false

Numbers the source's lines.

MaxHeightLength?

The tallest the source gets before it scrolls, such as Length.Rem(20).

Collapsiblebool = false

Hides the source behind a "Show code" toggle, which works with JavaScript off.

SourceOpenbool = false

With Collapsible, starts with the source shown.

Centerbool = false

Centers the preview's content both ways.

ShowCodeTextstring? = "Show code"

The toggle's text while the source is hidden. Defaults to "Show code".

HideCodeTextstring? = "Hide code"

The toggle's text while the source is shown. Defaults to "Hide code".

FilesLabelstring? = "Source files"

The source tabs' name for screen readers. Defaults to "Source files".

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

`CodeExampleFile`

One source file of a CodeExample, shown as a tab over its source. Write it among the example's content; it renders nothing where it's written.

Titlestring required

The file name, shown on its tab.

Codestring required

The source.

Languagestring? (computed)

The language, for colors. Defaults to the example's Language.

HighlightLinesstring?

Lines to highlight, such as "3-5,9" (see HighlightLines).

Types (1)

`Length`

struct

A width, height or flex basis: a size token, a keyword, or a CSS length built with a factory such as Rem.

Length members
Member	Description
`Sm`	640px (matches the `sm` breakpoint).
`Md`	768px (matches the `md` breakpoint).
`Lg`	1024px (matches the `lg` breakpoint).
`Xl`	1280px (matches the `xl` breakpoint).
`Prose`	A comfortable reading width, 68 characters.
`Full`	100% of the containing block.
`Auto`	`auto`.
`FitContent`	`fit-content`: as wide as the content, up to the available space.
`MinContent`	`min-content`.
`MaxContent`	`max-content`.
`Px(double value)`	Pixels.
`Rem(double value)`	Root ems (16px each by default).
`Percent(double value)`	Percent of the containing block.
`Ch(double value)`	Character widths, for text measures.
`Vw(double value)`	Percent of the viewport width.
`Dvh(double value)`	Percent of the dynamic viewport height (accounts for mobile browser bars).
`Of(string css)`	Any CSS length, such as `calc(100% - 2rem)`. Checked for unsafe characters.
`Css string`	The CSS value this length renders as.