react-string-avatar

React String Avatar is an ES6 module/component for React that generates a letter's avatar like Microsoft or Google do in their web apps. First letter of each word in a string or a group of initials will be used to generate the avatar. The image of the avatar will be rendered in an html img tag as a real png or jpeg. The image data can be retrieved using javascript to be stored in back-end giving you an initial profile picture in your web or mobile apps when the user does not upload one. Several React props are available to configure the output: size, shape, resolution, colors, etc.

Live example here: https://www.subidote.com/react-string-avatar/?path=/story/avatar--my-avatar-1

Quick start

1 Download and Install react-string-avatar

From npm

npm install react-string-avatar --save

or yarn

yarn add react-string-avatar --save

Source in github: https://github.com/ajsoriar/react-string-avatar

2 Import Custom Element

import Avatar from 'react-string-avatar';

3 Use it this way

<Avatar initials="A"></Avatar>

You will get this:

3.1 More usage examples ready to copy and paste

<Avatar initials="A" />
<Avatar initials="AS" bgColor="#00FF00" />
<Avatar initials="AJS" bgColor="cyan" textColor="blue" roundShape="true" ></Avatar>
<Avatar initials="AJ" bgColor="red" textColor="yellow" pictureResolution={512} width={64} />
<Avatar initials="AJ" bgColor="yellow" textColor="green" pictureResolution={1024} width={32} />
<Avatar initials="AS" bgColor="lightgreen" textColor="red" pictureResolution={16} width={128} pixelated={false} />
<Avatar initials="AS" bgColor="#99f499" textColor="red" pictureResolution={16} width={128} pixelated />
<Avatar initials="AS" roundShape bgColor="#a8ff2c" textColor="black" pictureResolution={512} width={42} pixelated={false} class="adres-css" wrapperStyle={{ border: '4px solid red' }} wrapper />
<Avatar initials="123" roundShape string="  andres     jose   soria " bgColor="orange" textColor="#FFF" pictureResolution={256} width={64} pixelated={false} class="adres-css" wrapperStyle={{ border: '4px solid red' }} />
<Avatar roundShape bgColor="#36adf2" textColor="white" pictureResolution={256} width={56} pixelated={false} class="adres-css" wrapperStyle={{ border: '2px solid blue' }} />
<Avatar initials="CM" cornerRadius={7} bgColor="#3875d7" />
<Avatar initials="jpg" pictureFormat="jpeg" bgColor="red" textColor="yellow" width={64} cornerRadius={5} />
<Avatar initials="png" pictureFormat="png" bgColor="purple" textColor="yellow" width={64} cornerRadius={5} />

You will get this:

3.2 Auto-color feature

<Avatar string="Foo Bar" autoColor={true} />

4 Development

Clone this repository, install dependencies and launch storybook.

git clone https://github.com/ajsoriar/react-string-avatar.git

yarn install

yarn storybook

yarn build

5 License

react-string-avatar is MIT licensed.

Free Software, Yeah!