# @chakra-xui/avatar

> A React component used to show users avatar or initials

Latest version **1.0.2** (published 2020-12-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install @chakra-xui/avatar
pnpm add @chakra-xui/avatar
yarn add @chakra-xui/avatar
bun add @chakra-xui/avatar
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2020-12-24 |
| First published | 2020-12-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 67.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Segun Adebayo |
| Maintainers | meabed |
| Keywords | component, react, chakra-xui, react-component, avatar, profile-image, photo, initials |

## Links

- npm: https://www.npmjs.com/package/@chakra-xui/avatar
- Repository: https://github.com/chakra-xui/chakra-xui
- Homepage: https://github.com/chakra-xui/chakra-xui#readme
- Issues: https://github.com/chakra-xui/chakra-xui/issues
- npm.io page: https://npm.io/package/@chakra-xui/avatar

## Dependencies (2)

- [@chakra-xui/image](https://npm.io/package/@chakra-xui/image.md) 1.0.2
- [@chakra-xui/utils](https://npm.io/package/@chakra-xui/utils.md) 1.0.2

## Alternatives

- [@progress/kendo-ooxml](https://npm.io/package/@progress/kendo-ooxml.md) — 152.1K weekly downloads
- [@progress/kendo-react-ripple](https://npm.io/package/@progress/kendo-react-ripple.md) — 8.0K weekly downloads
- [@progress/kendo-react-orgchart](https://npm.io/package/@progress/kendo-react-orgchart.md) — 4.3K weekly downloads
- [@praxisui/dynamic-fields](https://npm.io/package/@praxisui/dynamic-fields.md) — 2.4K weekly downloads
- [@progress/kendo-vue-listbox](https://npm.io/package/@progress/kendo-vue-listbox.md) — 932 weekly downloads

## Recent versions

- 1.0.2 (latest) — 2020-12-24

## README

# @chakra-xui/avatar

The Avatar component is used to represent user, and displays the profile
picture, initials or fallback icon.

## Installation

```sh
yarn add @chakra-xui/avatar

# or

npm i @chakra-xui/avatar
```

## Import components

```jsx
import { Avatar, AvatarGroup } from "@chakra-xui/avatar"
```

## Basic Usage

Simply import the `Avatar` component and pass it the image `src` and name of the
user in the avatar.

```jsx
<Avatar src="john-doe.png" name="John doe" />
```

Stack Avatars in a group by using the `AvatarGroup` component

```jsx
<AvatarGroup size="md" max={2}>
  <Avatar name="Ryan Florence" src="https://bit.ly/ryan-florence" />
  <Avatar name="Segun Adebayo" src="https://bit.ly/sage-adebayo" />
  <Avatar name="Kent Dodds" src="https://bit.ly/kent-c-dodds" />
  <Avatar name="Prosper Otemuyiwa" src="https://bit.ly/prosper-baba" />
  <Avatar name="Christian Nwamba" src="https://bit.ly/code-beast" />
</AvatarGroup>
```

---
_Source: https://npm.io/package/@chakra-xui/avatar · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
