Avatar β

Avatars are graphical representations of users through a profile picture or initials.

Component checklist

Status

The status of the component

Ready for use!

Repository

A link to the repo where the component lives.

gux-avatar-beta

Properties

Property Attribute Description Type Default
accent accent Manually sets avatar accent "0" | "1" | "10" | "11" | "12" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "auto" | "default" | "inherit" 'default'
badge badge Shows a badge indicating current presence boolean false
label label Label to display for accessibility string undefined
name (required) name Name which is shown as initials. Should be formatted 'Lastname Firstname' for JA, zhCN and KO names. Names without blank space will show first 2 characters of string. string undefined
notifications notifications Show notifications indicator boolean false
presence presence Shows presence such as away or available. Must be combined with badge or ring props to take effect. "available" | "away" | "break" | "busy" | "idle" | "meal" | "meeting" | "none" | "offline" | "on-queue" | "out-of-office" | "training" 'none'
ring ring Shows a ring around the avatar indicating current presence boolean false
size size "large" | "medium" | "small" | "xsmall" 'large'
ucIntegration uc-integration Shows uc integration app logo on large avatar "8x8" | "none" | "teams" | "zoom" 'none'

Methods

hideTooltip() => Promise<void>

Returns

Type: Promise<void>

showTooltip() => Promise<void>

Returns

Type: Promise<void>

Slots

Slot Description
"image" Avatar photo.

Dependencies

Depends on

Graph


                                                
                                                graph TD;
                                                  gux-avatar-beta --> gux-icon
                                                  gux-avatar-beta --> gux-screen-reader-beta
                                                  gux-avatar-beta --> gux-tooltip-beta
                                                  gux-tooltip-beta --> gux-tooltip-base-beta
                                                  style gux-avatar-beta fill:#f9f,stroke:#333,stroke-width:4px

Built with StencilJS