@umbraco-ui/uui-avatar/README.md

An avatar web component for displaying user avatars.

# uui-avatar

[![npm](https://img.shields.io/npm/v/@umbraco-ui/uui-avatar?logoColor=%231B264F)](https://www.npmjs.com/package/@umbraco-ui/uui-avatar)

### See it in action

Preview the component on [Storybook](https://uui.umbraco.com/?path=/docs/uui-avatar--docs)

## Installation

### ES imports

```zsh
npm i @umbraco-ui/uui-avatar
```

Import the registration of `<uui-avatar>` via:

```javascript
import '@umbraco-ui/uui-avatar';
```

When looking to leverage the `UUIAvatarElement` base class as a type and/or for extension purposes, do so via:

```javascript
import { UUIAvatarElement } from '@umbraco-ui/uui-avatar';
```

## Usage

```html
<uui-avatar title="First Last"></uui-avatar>
<uui-avatar img-src="..."></uui-avatar>
```