IAvatarProps
interface
Component Props
Full props contract for <OrigamAvatar> — renders an image, icon or text inside a circular (or rounded) container. Exposes the full design surface (color, border, elevation, spacing, density, size, rounded) plus interactive hover and active state props.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
Inheritance
Extends
Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- iconTIcon
- Renders an icon centered inside the avatar. Mutually exclusive with image and text: image wins, then icon, then text.
- imagestring | ISrcObject
- Avatar image — a URL string or an ISrcObject for srcset / lazy-src support. Takes precedence over icon and text.
- textstring
- Initials or short text rendered inside the avatar when no image or icon is provided.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Avatar with image and border