<Avatar>

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:

• Facebook
• GitHub
• Google (using Avatar Redirect)
• Twitter (using Avatar Redirect)
• Instagram (using Avatar Redirect)
• Vkontakte (using Avatar Redirect)
• Skype
• Gravatar
• Custom image
• Name initials

The fallbacks are in the same order as the list above were Facebook has the highest priority.

Demo

Check it live!

Install

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.

Note on usage in Gatsby projects

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.

Usage

1. Import Custom Element:

   import Avatar from 'react-avatar';
   

2. Start using it!

Some examples:

Manually generating a color:

import Avatar from 'react-avatar';

Configuring React Avatar globally

import Avatar, { ConfigProvider } from 'react-avatar';


    
        ...
        
        ...
    

Options

Avatar

ConfigProvider

Example

import Avatar, { ConfigProvider } from 'react-avatar';


    
        ...
        
        ...
    

Cache

This class represents the default implementation of the cache used by react-avatar.

Looking to implement more complex custom cache behaviour?

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

    
        ...
        
        ...
    


// For specific instances

Avatar Redirect

Avatar Redirect adds support for social networks which require a server-side service to find the correct avatar URL.

Examples of this are:

• Twitter
• Instagram

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

Development

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 https://localhost:8000/index.html.

  $ npm run dev
  

• To create a local production build into the lib and es folders.

  $ npm run build
  

Implementing a custom cache

cache as provided to the ConfigProvider should be an object implementing the methods below. The default cache implementation can be found here

Reducing bundle size

Webpack 4

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:

• GravatarSource
• FacebookSource
• GithubSource
• SkypeSource
• ValueSource
• SrcSource
• IconSource
• VKontakteSource
• InstagramSource
• TwitterSource
• GoogleSource
• RedirectSource

Without Webpack >= 4

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.

ES6 modules

import createAvatarComponent from 'react-avatar/es/avatar';
import TwitterSource from 'react-avatar/es/sources/Twitter';

const Avatar = createAvatarComponent({
    sources: [ TwitterSource ]
});

Transpiled ES5 javascript / commonjs

const createAvatarComponent = require('react-avatar/lib/avatar').default;
const TwitterSource = require('react-avatar/lib/sources/Twitter').default;

const Avatar = createAvatarComponent({
    sources: [ TwitterSource ]
});

Products using React Avatar

• Ambassify

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -m 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request 😄

History

For detailed changelog, check Releases.

Maintainers

• @Sitebase (Creator)
• @JorgenEvens

License

MIT License