react-avatar, react-avatar-editor, and react-gravatar are tools for handling user profile images in React, but they solve different parts of the problem. react-avatar is a general-purpose display component that handles initials, colors, and image fallbacks automatically. react-avatar-editor is a specialized tool for cropping, scaling, and rotating images before saving them. react-gravatar is a lightweight wrapper specifically for fetching images from the Gravatar service based on email addresses. Choosing the right one depends on whether you need simple display, image editing, or Gravatar integration.
When building user profiles or community features, handling avatars is a common requirement. The ecosystem offers three distinct approaches: react-avatar for flexible display, react-avatar-editor for image manipulation, and react-gravatar for email-based identity. Each serves a specific architectural need, and mixing them incorrectly can lead to technical debt. Let's compare how they handle core tasks.
react-avatar is designed for resilience. It attempts to load an image, and if that fails, it generates a colored circle with initials. This prevents broken image icons in your UI.
// react-avatar: Display with fallback
import Avatar from 'react-avatar';
<Avatar name="John Doe" size="50" round={true} />
// Shows image if src provided, otherwise initials "JD"
react-avatar-editor is not meant for simple display. It renders an interactive canvas. Using it just to show an image adds unnecessary overhead and interaction handles where none are needed.
// react-avatar-editor: Not recommended for static display
import AvatarEditor from 'react-avatar-editor';
<AvatarEditor
image="path/to/image.jpg"
width={200}
height={200}
scale={1}
/>
// Renders an editable canvas, not a simple img tag
react-gravatar fetches the image directly from Gravatar's CDN based on an email hash. If the email has no Gravatar, it relies on Gravatar's default image settings (like identicon or blank).
// react-gravatar: Email-based fetch
import Gravatar from 'react-gravatar';
<Gravatar email="john@example.com" size={50} />
// Renders an <img> tag pointing to gravatar.com
react-avatar offers extensive props for shape and color. You can force a specific background color or let it auto-generate one based on the name string.
// react-avatar: Styling props
<Avatar
name="Jane Smith"
color="#E0E0E0"
textSizeRatio={2}
round={true}
/>
// Controls background, text size, and border radius
react-avatar-editor focuses on the editing viewport. Customization is about the crop area (width/height) and the initial scale. It does not handle CSS border-radius for the final output unless you style the container.
// react-avatar-editor: Viewport config
<AvatarEditor
image={selectedImage}
width={250}
height={250}
border={50}
color={[255, 255, 255, 0.6]}
/>
// Configures the crop mask and overlay color
react-gravatar has limited styling options. It mostly passes standard image attributes like className or style. Visual changes like rounding must be done via CSS on the rendered <img> tag.
// react-gravatar: CSS-based styling
<Gravatar
email="jane@example.com"
className="rounded-img"
style={{ border: '1px solid #ccc' }}
/>
// Styling applied externally to the image element
react-avatar does not support editing. It is a read-only component. If you pass a src, it displays it. If you need cropping, you must implement a separate modal or tool.
// react-avatar: No editing support
<Avatar src="/user/uploaded.jpg" size={100} />
// Simply displays the provided source URL
react-avatar-editor excels here. It provides handlers to get the cropped canvas data. You can scale, rotate, and position the image before exporting it as a Data URL or Blob.
// react-avatar-editor: Exporting cropped image
const editorRef = useRef();
const onSave = () => {
const canvas = editorRef.current.getImageScaledToCanvas();
const dataUrl = canvas.toDataURL();
// Send dataUrl to server
};
<AvatarEditor ref={editorRef} onSave={onSave} />
react-gravatar has no manipulation capabilities. It strictly retrieves the remote resource. Any cropping or editing must happen on the Gravatar website itself before the request is made.
// react-gravatar: No manipulation
<Gravatar email="user@example.com" />
// Retrieves remote image as-is from Gravatar servers
react-avatar handles multiple sources gracefully. You can provide a src array, and it will try them in order. If all fail, it falls back to initials.
// react-avatar: Multi-source fallback
<Avatar
src={['/local/image.png', 'https://cdn.example.com/img.jpg']}
name="User Name"
/>
// Tries local, then CDN, then shows initials
react-avatar-editor requires a single image source to start the editing session. It does not handle fallback logic. If the image prop is invalid, the canvas will be empty or throw an error depending on version.
// react-avatar-editor: Single source input
<AvatarEditor image={userSelectedFile} />
// Expects a valid image object or URL to load
react-gravatar relies on the Gravatar service's fallback system. You can specify a default prop (e.g., "monsterid", "retro") which Gravatar serves if no account exists for that email.
// react-gravatar: Service-side fallback
<Gravatar
email="unknown@example.com"
default="identicon"
rating="pg"
/>
// Gravatar returns an identicon if email is not registered
You need to show 50 users in a table. Some have photos, some don't.
react-avatar// Directory implementation
users.map(user => (
<Avatar key={user.id} name={user.name} src={user.photoUrl} />
));
Users need to upload a new profile picture and crop it before saving.
react-avatar-editor// Settings implementation
<AvatarEditor
image={previewUrl}
onSave={handleUpload}
scale={scale}
/>
You have a list of author emails and want to show their global identity without managing image storage.
react-gravatar// Blog implementation
<Gravatar email={author.email} size={40} />
| Feature | react-avatar | react-avatar-editor | react-gravatar |
|---|---|---|---|
| Primary Use | Display with fallbacks | Image cropping/editing | Gravatar fetching |
| Fallback | Initials + Colors | None (Empty canvas) | Gravatar Defaults |
| Editing | ❌ No | ✅ Yes (Canvas) | ❌ No |
| Data Source | URL, Name, Email | Image File/Blob | Email Hash |
| Maintenance | Active | Active | Legacy/Minimal |
For modern applications, react-avatar should be your default choice for displaying identities. It abstracts away the pain of broken images and missing data. Use react-avatar-editor strictly within the upload flow where manipulation is required. Avoid react-gravatar for new projects unless you are certain your user base relies on Gravatar, as it ties your identity system to an external service and offers less flexibility than passing a Gravatar URL into react-avatar.
Choose react-avatar when you need a robust, drop-in component for displaying user identities with automatic fallbacks. It is ideal for user lists, comments, or profiles where you want initials to appear if no image exists. It handles caching and color generation out of the box, reducing boilerplate code for common UI patterns.
Choose react-avatar-editor when your application requires users to upload and crop their own profile pictures. It provides a canvas-based interface for scaling and rotating images before export. This is the standard choice for settings pages where image manipulation is a requirement before saving to a server.
Choose react-gravatar only if your project relies exclusively on the Gravatar service for identity and you need a minimal implementation. It is suitable for legacy projects or simple blogs where email-based identity is sufficient. For modern apps requiring local uploads or fallbacks, consider react-avatar with Gravatar URLs instead.
Universal avatar makes it possible to fetch/generate an avatar based on the information you have about that user. We use a fallback system that if for example an invalid Facebook ID is used it will try Google, and so on.
![]()
For the moment we support following types:
The fallbacks are in the same order as the list above were Facebook has the highest priority.
Install the component using NPM:
$ npm install react-avatar --save
# besides React, react-avatar also has prop-types as peer dependency,
# make sure to install it into your project
$ npm install prop-types --save
Or download as ZIP.
Users of Gatsby who are experiencing issues with the latest release should install react-avatar@corejs2 instead. This is an older version (v3.7.0) release of react-avatar that still used core-js@2.
If you'd like to use the latest version of react-avatar have a look at #187 for a workaround and #187, #181 and #198 for a description of the issue.
Import Custom Element:
import Avatar from 'react-avatar';
Start using it!
<Avatar name="Foo Bar" />
Some examples:
<Avatar googleId="118096717852922241760" size="100" round={true} />
<Avatar facebookId="100008343750912" size="150" />
<Avatar githubHandle="sitebase" size={150} round="20px" />
<Avatar vkontakteId="1" size="150" />
<Avatar skypeId="sitebase" size="200" />
<Avatar twitterHandle="sitebase" size="40" />
<Avatar name="Wim Mostmans" size="150" />
<Avatar name="Wim Mostmans" size="150" textSizeRatio={1.75} />
<Avatar value="86%" size="40" />
<Avatar size="100" facebook-id="invalidfacebookusername" src="http://www.gravatar.com/avatar/a16a38cdfe8b2cbd38e8a56ab93238d3" />
<Avatar name="Wim Mostmans" unstyled={true} />
Manually generating a color:
import Avatar from 'react-avatar';
<Avatar color={Avatar.getRandomColor('sitebase', ['red', 'green', 'blue'])} name="Wim Mostmans" />
Configuring React Avatar globally
import Avatar, { ConfigProvider } from 'react-avatar';
<ConfigProvider colors={['red', 'green', 'blue']}>
<YourApp>
...
<Avatar name="Wim Mostmans" />
...
</YourApp>
</ConfigProvider>
| Attribute | Options | Default | Description |
|---|---|---|---|
className | string | Name of the CSS class you want to add to this component alongside the default sb-avatar. | |
email | string | String of the email address of the user. | |
md5Email | string | String of the MD5 hash of email address of the user. | |
facebookId | string | ||
twitterHandle | string | ||
instagramId | string | ||
googleId | string | ||
githubHandle | string | String of the user's GitHub handle. | |
skypeId | string | ||
name | string | Will be used to generate avatar based on the initials of the person | |
maxInitials | number | Set max nr of characters used for the initials. If maxInitials=2 and the name is Foo Bar Var the initials will be FB | |
initials | string or function | defaultInitials | Set the initials to show or a function that derives them from the component props, the method should have the signature fn(name, props) |
value | string | Show a value as avatar | |
alt | string | name or value | The alt attribute used on the avatar img tag. If not set we will fallback to either name or value |
title | string | name or value | The title attribute used on the avatar img tag. If not set we will fallback to either name or value |
color | string | random | Used in combination with name and value. Give the background a fixed color with a hex like for example #FF0000 |
fgColor | string | #FFF | Used in combination with name and value. Give the text a fixed color with a hex like for example #FF0000 |
size | length | 50px | Size of the avatar |
textSizeRatio | number | 3 | For text based avatars the size of the text as a fragment of size (size / textSizeRatio) |
textMarginRatio | number | .15 | For text based avatars. The size of the minimum margin between the text and the avatar's edge, used to make sure the text will always fit inside the avatar. (calculated as size * textMarginRatio) |
round | bool or length | false | The amount of border-radius to apply to the avatar corners, true shows the avatar in a circle. |
src | string | Fallback image to use | |
style | object | Style that will be applied on the root element | |
unstyled | bool | false | Disable all styles |
onClick | function | Mouse click event |
| Attribute | Options | Default | Description |
|---|---|---|---|
colors | array(string) | default colors | A list of color values as strings from which the getRandomColor picks one at random. |
cache | cache | internal cache | Cache implementation used to track broken img URLs |
initials | function | defaultInitials | A function that derives the initials from the component props, the method should have the signature fn(name, props) |
avatarRedirectUrl | URL | undefined | Base URL to a Avatar Redirect instance |
Example
import Avatar, { ConfigProvider } from 'react-avatar';
<ConfigProvider colors={['red', 'green', 'blue']}>
<YourApp>
...
<Avatar name="Wim Mostmans" />
...
</YourApp>
</ConfigProvider>
This class represents the default implementation of the cache used by react-avatar.
Looking to implement more complex custom cache behaviour?
| Attribute | Options | Default | Description |
|---|---|---|---|
cachePrefix | string | react-avatar/ | The prefix for localStorage keys used by the cache. |
sourceTTL | number | 604800000 (7 days) | The amount of time a failed source is kept in cache. (in milliseconds) |
sourceSize | number | 20 | The maximum number of failed source entries to keep in cache at any time. |
usage
import Avatar, { Cache, ConfigProvider } from 'react-avatar';
const cache = new Cache({
// Keep cached source failures for up to 7 days
sourceTTL: 7 * 24 * 3600 * 1000,
// Keep a maximum of 20 entries in the source cache
sourceSize: 20
});
// Apply cache globally
<ConfigProvider cache={cache}>
<YourApp>
...
<Avatar name="Wim Mostmans" />
...
</YourApp>
</ConfigProvider>
// For specific instances
<Avatar name="Wim Mostmans" cache={cache} />
Avatar Redirect adds support for social networks which require a server-side service to find the correct avatar URL.
Examples of this are:
An open Avatar Redirect endpoint is provided at https://avatar-redirect.appspot.com. However this endpoint is provided for free and as such an explicit opt-in is required as no guarantees can be made about uptime of this endpoint.
Avatar Redirect is enabled by setting the avatarRedirectUrl property on the ConfigProvider context
In order to run it locally you'll need to fetch some dependencies and a basic server setup.
Install local dependencies:
$ npm install
To test your react-avatar and your changes, start the development server and open http://localhost:8000/index.html.
$ npm run dev
To create a local production build into the lib and es folders.
$ npm run build
cache as provided to the ConfigProvider should be an object implementing the methods below. The default cache implementation can be found here
| Method | Description |
|---|---|
set(key, value) | Save value at key, such that it can be retrieved using get(key). Returns undefined |
get(key) | Retrieve the value stored at key, if the cache does not contain a value for key return null |
sourceFailed(source) | Mark the image URL specified in source as failed. Returns undefined |
hasSourceFailedBefore(source) | Returns true if the source has been tagged as failed using sourceFailed(source), otherwise false. |
When using webpack 4 you can rely on tree shaking to drop unused sources when creating your Avatar component like the example below.
import { createAvatarComponent, TwitterSource } from 'react-avatar';
const Avatar = createAvatarComponent({
sources: [ TwitterSource ]
});
Exported sources:
If you are using a version of webpack that does not support tree shaking or are using a different bundler you'll need to import only those files you need.
import createAvatarComponent from 'react-avatar/es/avatar';
import TwitterSource from 'react-avatar/es/sources/Twitter';
const Avatar = createAvatarComponent({
sources: [ TwitterSource ]
});
const createAvatarComponent = require('react-avatar/lib/avatar').default;
const TwitterSource = require('react-avatar/lib/sources/Twitter').default;
const Avatar = createAvatarComponent({
sources: [ TwitterSource ]
});
git checkout -b my-new-featuregit commit -m 'Add some feature'git push origin my-new-featureFor detailed changelog, check Releases.