@zendeskgarden/react-avatars

@zendeskgarden/react-avatars

This package includes components relating to avatars in the Garden Design System.

Installation

npm install @zendeskgarden/react-avatars

# Peer Dependencies - Also Required
npm install react react-dom prop-types styled-components @zendeskgarden/react-theming

Usage

/**
 * Include avatar styling at the root of your application
 */
import '@zendeskgarden/react-avatars/dist/styles.css';

import { ThemeProvider } from '@zendeskgarden/react-theming';
import { Avatar } from '@zendeskgarden/react-avatars';

/**
 * Place a `ThemeProvider` at the root of your React application
 */
<ThemeProvider>
  <Avatar>
    <img src="images/amir.png" alt="Example Avatar" />
  </Avatar>
</ThemeProvider>;