Skip to content

CSS: avatar

.instui-avatar · stable — A user avatar showing initials or an image, circular by default.

By default the palette colour tints the initials on a transparent surface; -has-inverse-color fills the surface with the colour and puts the initials on-colour. The -color-ai variant always fills with the violet→sea gradient. For a full display name, put it in the content (so it stays in the accessibility tree) and add data-initials="XX" for the compact visual — the real text is what a screen reader announces. Without data-initials, overflowing content just hard-clips (no ellipsis); wrap it in .name for a precise single-leading-letter clip instead, or split it into .first-name/.last-name for two clipped letters (either half can be omitted and the other stays centred).

Source: avatar.css

TIP

JS Enhancement — This component's CSS renders and works on its own; pair it with @pantoken/interactions to add the interactive behavior. See the modifier table below.

Accessibility

Give an image avatar a meaningful alt (the person's name), not a generic "avatar"; for initials-only avatars, prefer real name content (bare text, data-initials, .name, or .first-name/.last-name) over pre-abbreviated letters, so assistive tech announces the real name.

Usage

css
@import "@pantoken/components/components.css";
@import "@pantoken/components/avatar.css";

Examples

html
<span class="instui-avatar --me-sm">LH</span>
<span class="instui-avatar -color-ai --me-sm">AI</span>
<span class="instui-avatar --me-sm" data-initials="NV">Dr. Nguyen Van Thoc</span>
<span class="instui-avatar"><span class="name">Miguel Sanchez</span></span>
<span class="instui-avatar"><span class="first-name">Miguel</span> <span class="last-name">Sanchez</span></span>

Structure

The avatar shows one of: an , bare/data-initials text, a .name wrap, or a .first-name/.last-name pair.

text
.instui-avatar
  img (0..1)
  .name (0..1)
  .first-name (0..1)
  .last-name (0..1)
flowchart TD n0[".instui-avatar"]:::cssdoc-root n1("img"):::cssdoc-part n2(".name"):::cssdoc-part n3(".first-name"):::cssdoc-part n4(".last-name"):::cssdoc-part n0 -.->|0..1| n1 n0 -.->|0..1| n2 n0 -.->|0..1| n3 n0 -.->|0..1| n4 classDef cssdoc-root stroke-width:1px; classDef cssdoc-part stroke-width:1px; classDef cssdoc-slot stroke-width:1px; classDef cssdoc-component stroke-width:1px;

Modifiers

ModifierDescription
.-color-accent1Deprecated — use .-color-blue.
.-color-accent2Deprecated — use .-color-green.
.-color-accent3Deprecated — use .-color-red.
.-color-accent4Deprecated — use .-color-orange.
.-color-accent5Deprecated — use .-color-ash.
.-color-accent6Deprecated — use .-color-grey.
.-color-aiAI-accent palette colour.
.-color-ashAsh palette colour.
.-color-blueBlue palette colour.
.-color-greenGreen palette colour.
.-color-greyGrey palette colour.
.-color-orangeOrange palette colour.
.-color-redRed palette colour.
.-has-inverse-colorUse the inverse (on-dark) text colour.
.-shape-rectangleSquare (rectangular) shape instead of a circle.
.-show-borderAlias — maps to .-show-border-always.
.-show-border-alwaysForce the border ring on, even over an image or an inverse fill.
.-show-border-neverForce the border ring off.
.-size-2xlTwo sizes larger.
.-size-2xsTwo sizes smaller.
.-size-largeLarge. Long-form alias of -size-lg.
.-size-lgLarge.
.-size-mdMedium (the default).
.-size-mediumMedium (the default). Long-form alias of -size-md.
.-size-smSmall.
.-size-smallSmall. Long-form alias of -size-sm.
.-size-x-largeExtra large. Long-form alias of -size-xl.
.-size-x-smallExtra small. Long-form alias of -size-xs.
.-size-xlExtra large.
.-size-xsExtra small.
.-size-xx-largeTwo sizes larger. Long-form alias of -size-2xl.
.-size-xx-smallTwo sizes smaller. Long-form alias of -size-2xs.

Parts

PartDescription
.first-nameOptional (pairs with .last-name): wraps the given name, clipped to its leading letter.
.last-nameOptional (pairs with .first-name): wraps the family name, clipped to its leading letter.
.nameOptional: wrap the full name to clip it to a single leading letter without data-initials or JS.

Pseudo-elements

Pseudo-elementDescription
::before

Tokens consumed

TokenTypeValue
--instui-component-avatar-ai-bottom-gradient-color<color>#00828E
--instui-component-avatar-ai-top-gradient-color<color>#9E58BD
--instui-component-avatar-ash-background-color<color>LightDarklight-dark(#273540, #1C222B)
--instui-component-avatar-ash-text-color<color>LightDarklight-dark(#273540, #C7CACD)
--instui-component-avatar-background-color<color>LightDarklight-dark(#ffffff, #10141A)
--instui-component-avatar-blue-background-color<color>#2B7ABC
--instui-component-avatar-blue-text-color<color>LightDarklight-dark(#2871AF, #7FB4F1)
--instui-component-avatar-border-color<color>LightDarklight-dark(#8D959F, #6A7883)
--instui-component-avatar-border-width-md<length>0.125rem
--instui-component-avatar-border-width-sm<length>0.0625rem
--instui-component-avatar-font-family[ <font-family-name> | <generic-font-family> ]#Atkinson Hyperlegible Next, "Helvetica Neue", Helvetica, Arial, sans-serif
--instui-component-avatar-font-size-lg<length>1.25rem
--instui-component-avatar-font-size-md<length>1rem
--instui-component-avatar-font-size-sm<length>0.875rem
--instui-component-avatar-font-size-xl<length>1.75rem
--instui-component-avatar-font-size-xs<length>0.75rem
--instui-component-avatar-font-size2xl<length>2.5rem
--instui-component-avatar-font-size2xs<length>0.75rem
--instui-component-avatar-font-weight<integer>600
--instui-component-avatar-green-background-color<color>#03893D
--instui-component-avatar-green-text-color<color>LightDarklight-dark(#037D37, #61C378)
--instui-component-avatar-grey-background-color<color>LightDarklight-dark(#4A5B68, #576773)
--instui-component-avatar-grey-text-color<color>LightDarklight-dark(#4A5B68, #F2F4F5)
--instui-component-avatar-orange-background-color<color>#CF4A00
--instui-component-avatar-orange-text-color<color>LightDarklight-dark(#BB4200, #FF905A)
--instui-component-avatar-rectangle-radius<length>0.25rem
--instui-component-avatar-red-background-color<color>#E62429
--instui-component-avatar-red-text-color<color>LightDarklight-dark(#CF1F24, #FA917F)
--instui-component-avatar-size-lg<length>3.5rem
--instui-component-avatar-size-md<length>3rem
--instui-component-avatar-size-sm<length>2.5rem
--instui-component-avatar-size-xl<length>4rem
--instui-component-avatar-size-xs<length>2rem
--instui-component-avatar-size2xl<length>5rem
--instui-component-avatar-size2xs<length>1.5rem
--instui-component-avatar-text-on-color<color>#ffffff
  • byline — Can host an avatar as its leading hero figure.