Heading
IzzyBlazor.Heading in the IzzyBlazor.Core package, generated from the 0.1.0-alpha.17 assembly
and its doc comments.
Properties (18)
Levelint = 2The heading level, 1 to 6, which sets the element (h1 to h6). Defaults to 2.
Outlinebool = trueLists the heading in the page's OnThisPage (when its level is one it lists). Defaults to true; false leaves it out and gives it no anchor link.
Anchorbool?Makes the heading a link to itself, with a "#" on hover, so a section can be linked. By default, headings listed in an OnThisPage are; true adds the link to any heading with an id, false removes it. A heading whose content holds a link or button of its own (an a, button, Anchor or button component) never gets one, since links can't nest. A heading holding a component that isn't one of IzzyBlazor's plain ones (Icon, Badge, Kbd, TextBlock) gets one only with true, since it might render a link. Set it as Anchor="true": the attribute needs a value.
Font size. Responsive.
WeightFontWeight?Font weight.
FamilyFontFamily?Font family.
Horizontal alignment. Responsive.
LineHeightLineHeight?Line height.
LetterSpacingLetterSpacing?Letter spacing.
TransformTextTransform?Letter case.
DecorationTextDecoration?Underline or strike-through.
Italicbool = falseItalic.
WrapTextWrap?How lines break: normal, never, balanced or pretty.
Truncatebool = falseKeep to one line and end with an ellipsis when it does not fit.
LineClampint?Show at most this many lines, ending with an ellipsis.
TabularNumsbool = falseEqual-width digits, so numbers line up in columns and do not jitter when they change.
MinSizeTextSize?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.
Types (9)
FontFamily
enumFont family tokens.
| Value | Description |
|---|---|
Body | The body font (the default), |
Heading | The heading font, |
Mono | The monospace font, for code and figures, |
FontWeight
enumFont weights.
| Value | Description |
|---|---|
Light | 300. |
Normal | 400. |
Medium | 500. |
Semibold | 600. |
Bold | 700. |
Extrabold | 800. |
LetterSpacing
enumLetter spacing tokens.
| Value | Description |
|---|---|
Tighter | -0.05em. |
Tight | -0.025em, for large headings. |
Normal | 0. |
Wide | 0.025em. |
Wider | 0.05em, for small uppercase labels. |
Widest | 0.1em. |
LineHeight
enumLine height tokens.
| Value | Description |
|---|---|
None | 1. |
Tight | 1.25, for headings. |
Snug | 1.375. |
Normal | 1.5, for body text. |
Relaxed | 1.625. |
Loose | 2. |
TextAlign
enumHorizontal text alignment. Start and End follow the reading direction.
| Value | Description |
|---|---|
Start | Left in left-to-right languages. |
Center | Centered. |
End | Right in left-to-right languages. |
Justify | Justified to both edges. |
TextDecoration
enumText decoration lines.
| Value | Description |
|---|---|
None | No line. |
Underline | Underlined. |
LineThrough | Struck through. |
TextSize
enumFont size tokens, from TextSize.Xs (12px) to TextSize.Xl6 (60px).
| Value | Description |
|---|---|
Xs | 12px. |
Sm | 14px. |
Md | 16px, the body size. |
Lg | 18px. |
Xl | 20px. |
Xl2 | 24px. |
Xl3 | 30px. |
Xl4 | 36px. |
Xl5 | 48px. |
Xl6 | 60px. |
TextTransform
enumLetter case changes.
| Value | Description |
|---|---|
None | As written. |
Uppercase | ALL CAPS. |
Lowercase | all lowercase. |
Capitalize | Each Word Capitalized. |
TextWrap
enumHow lines break.
| Value | Description |
|---|---|
Wrap | Normal wrapping. |
NoWrap | Never wrap. |
Balance | Even line lengths; best for headings and short text. |
Pretty | Avoids a lone word on the last line; good for paragraphs. |