react-native-user-avatar-component
TypeScript icon, indicating that this package has built-in type declarations

0.0.4 • Public • Published

React Native User Avatar

npm version npm downloads

A bare-bones user avatar display with support for falling back to using the user's initials on a colored background as the avatar. Based on the great library for React: https://github.com/wbinnssmith/react-user-avatar, and ported to React Native.

This is a fork of original library https://github.com/avishayil/react-native-user-avatar by Avishay Bar made to retain custom component support.

Installation

npm install --save react-native-user-avatar-component or yarn add react-native-user-avatar-component

Usage

import UserAvatar from 'react-native-user-avatar-component';
 
 
<UserAvatar size="100" name="Avishay Bar" />
<UserAvatar size="100" name="Avishay Bar" src="https://dummyimage.com/100x100/000/fff" />
<UserAvatar size="50" name="John Doe" colors={['#ccc', '#fafafa', '#ccaabb']}/>
<UserAvatar size="50" name="John Doe" />
<UserAvatar size="50" name="Jane Doe" color="#000" />

User-defined Image-Component

It is also possible to use another Image-Component than the built-in <Image>.

<UserAvatar size="50" name="John Doe" component={CachedImage} />

The fallback avatar's color may be set by passing in the color prop, or you can customize the range of colors used by passing in an array of colors. The component uses a simple calculation to consistently use the same color for the same user's name every time.

Credits

@wbinnssmith for creating https://github.com/wbinnssmith/react-user-avatar

License

MIT

Dependencies (2)

Dev Dependencies (3)

Package Sidebar

Install

npm i react-native-user-avatar-component

Weekly Downloads

56

Version

0.0.4

License

MIT

Unpacked Size

7.65 kB

Total Files

5

Last publish

Collaborators

  • leoz