# Input Avatar

The InputAvatar component is used to allow users to change their Avatar. This is
an **experimental** component and should be used with careful consideration.

## Design & usage guidelines

InputAvatar requires a `getUploadParams` telling it where and how to upload the
avatar. You can read more about `getUploadParams` in the
[InputFile](../InputFile/InputFile.md) component.


## Props

### Web

| Prop | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `getUploadParams` | `(file: File) => UploadParams | Promise<UploadParams>` | Yes | — | A callback that receives a file object and returns a `UploadParams` needed to upload the file.  More info is availabl... |
| `color` | `string` | No | — | The background and border color that represents the user. This should be represented as a value that can be read by CSS |
| `imageUrl` | `string` | No | — | A url for the image that will be displayed |
| `initials` | `string` | No | — | The initials that will be displayed if no image is set.\ |
| `name` | `string` | No | — | A users name to be used for assistive technology |
| `onChange` | `(file?: FileUpload) => void` | No | — | Triggered when an image is changed. |
| `onUploadComplete` | `(file?: FileUpload) => void` | No | — | Triggered when an image upload has completed. |
