Files
directus/docs/reference/app/components/v-avatar.md
Nitwel c2e7c85bbd Update documentation of app (#4222)
* move component docs to documentation

* update app docs tables for components

* update docs

* Add components to docs sidebar

* fix generated tables

* fix tables

* rename transitions

* update tables

* update nested components

* update tables

* update tables

* update tables

* update v-table table

* add basic documentation to each component

* remove all stories of storybook

* add missing documentation

* undate tables

* update tables

* update docs sidebar

* update app docs

* remove unused references

* add general readme

* update docs

* make reference titiles smaller

* add reference tag

* improve docs

* update order of tabs in sidebar

* remove all readmes and stories from interfaces/displays

* Cleanup menu

* Remove storybook

Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
2021-02-24 17:48:19 -05:00

43 lines
1.1 KiB
Markdown

# Avatar
The avatar component can be used to display a person or something similar. It will generate a grey box in which either a
profile picture or an icon or text can be inserted.
```html
<v-avatar>RVZ</v-avatar>
<v-avatar>
<img src="..." />
</v-avatar>
<v-avatar>
<v-icon name="person" />
</v-avatar>
```
## Reference
#### Props
| Prop | Description | Default | Type |
| ------ | ------------------------- | ------- | --------- |
| `size` | Size in px | `null` | `Number` |
| `tile` | Render as a tile (square) | `false` | `Boolean` |
#### Slots
| Slot | Description | Data |
| --------- | ------------------------------------------------------- | ---- |
| _default_ | Default slot to display your elements inside the avatar | -- |
#### Events
n/a
###### CSS Variables
| Variable | Default |
| ------------------ | -------------------------- |
| `--v-avatar-color` | `var(--background-normal)` |
| `--v-avatar-size` | `48px` |