Avatar
IzzyBlazor.Avatar in the IzzyBlazor.Core package, generated from the 0.1.0-alpha.17 assembly
and its doc comments.
Properties (11)
Namestring?The person's or thing's name: the accessible name, and the source of the initials and of their color.
Srcstring?The image URL. Without one, or if it fails to load, the initials show.
IconIconData? (computed)The icon when there's no name. Defaults to a person.
SizeAvatarSize? (computed)Size. Defaults to AvatarSize.Md, or the group's size inside an AvatarGroup.
Squarebool = falseRounded corners in place of a circle, for teams, companies and projects.
AccentAccent?VariantAvatarVariant = AvatarVariant.SoftAvatarVariant.Soft (the default) tints the background and colors the initials; AvatarVariant.Solid fills it, with initials picked for contrast. A photo covers both.
StatusStatus?A dot in the corner, such as Status.Success for online. Give it a StatusLabel.
StatusLabelstring?What the status dot means, for screen readers, such as "Online".
Decorativebool = falseHides the avatar from screen readers, for when the name is already written beside it.
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.
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 (4)
Accent
classThe 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.
| 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 |
Token(string name) | A theme token, such as |
From(Color color) | A |
AvatarSize
enumAvatar sizes.
| Value | Description |
|---|---|
Xs | 1.5rem, for dense lists and inline mentions. |
Sm | 2rem, beside a line of text. |
Md | 2.5rem (the default). |
Lg | 3rem. |
Xl | 4rem. |
Xl2 | 6rem, for a profile header. |
AvatarVariant
enum| Value | Description |
|---|---|
Soft | A light tint with the color as text (the default). |
Solid | Filled with the color, with text picked for contrast. |
Status
enumThe 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.
| 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". |