An avatar component is used as a representation of a user identity typically in a user profile.
- Element
-
igc-avatar
- Slots
-
default— Renders an icon inside the default slot.
- CSS Parts
-
base— The base wrapper of the avatar. -
initials— The initials wrapper of the avatar. -
image— The image wrapper of the avatar. -
icon— The icon wrapper of the avatar.
Constructors
Section titled "Constructors"IgcAvatarComponent
new IgcAvatarComponent(): IgcAvatarComponent Defined in src/components/avatar/avatar.ts:72
Returns IgcAvatarComponent
Properties
Section titled "Properties"Optional alt
Section titled "alt"Alternative text for the image.
alt: string Defined in src/components/avatar/avatar.ts:56
Optional initials
Section titled "initials"Initials to use as a fallback when no image is available.
initials: string Defined in src/components/avatar/avatar.ts:63
shape
Section titled "shape"The shape of the avatar.
shape: AvatarShape = 'square' Defined in src/components/avatar/avatar.ts:70
Optional src
Section titled "src"The image source to use.
src: string Defined in src/components/avatar/avatar.ts:49
styles
Section titled "styles"Array of styles to apply to the element. The styles should be defined using the css tag function, via constructible stylesheets, or imported from native CSS module scripts.
Note on Content Security Policy:
Element styles are implemented with <style> tags when the browser doesn't
support adopted StyleSheets. To use such <style> tags with the style-src
CSP directive, the style-src value must either include 'unsafe-inline' or
nonce-<base64-value> with <base64-value> replaced be a server-generated
nonce.
To provide a nonce to use on generated <style> elements, set
window.litNonce to a server-generated nonce in your page's HTML, before
loading application code:
``
styles: CSSResult[] Defined in src/components/avatar/avatar.ts:27
tagName
Section titled "tagName"tagName: "igc-avatar" = 'igc-avatar' Defined in src/components/avatar/avatar.ts:26
Methods
Section titled "Methods"register
Section titled "register"register(): void Defined in src/components/avatar/avatar.ts:30