Avatar API
API reference docs for the Stash Avatar component. Learn about the props, CSS, and other APIs of this exported module.
Import
ts
import Avatar from '@leaflink/stash/Avatar.vue';Props
| Name | Type | Default | Description |
|---|---|---|---|
| alt | string | undefined | The alternative text to be displayed in case the image is unavailable |
| bgColor | StashCommonColor | undefined | The background color of the chip. Needs to be one of our design system colors. |
| colorScheme | StashPrimaryColorGroup | ice | The color for the chip that determines both the text and bg color. Needs to be one of the brand colors in our design system (not a shade). |
| name | string | '' | The name of the user will be parsed and have its initial displayed in case the src prop is empty |
| shade | "light" | "main" | light | The shade of the provided color to use for the background color. This effects the inferred text color unless a specific text color is provided. Currently only `light` and `main` shades are supported. `dark` may be added in the future. |
| src | string | undefined | The image that will be displayed within the avatar |
| textColor | StashCommonColor | undefined | The color of the chip text. Needs to be one of our design system colors. |
Slots
None
Events
None