Skip to content

Latest commit

 

History

History
54 lines (38 loc) · 1.89 KB

README.md

File metadata and controls

54 lines (38 loc) · 1.89 KB
Raw

react-native-boring-avatars

React Native implementation of boring avatars

Forked from https://github.com/luhart/react-native-boring-avatars.

Then forked again to fix the error

""RNSVGRect" was not found in the UIManager

Why Fork?

In the original library, there is heavy use of magic strings and hardcoded values. This caused heavy pixellation when trying to make avatars larger than their default values.

For an understanding of how this all works please see this blog post: https://mealection.com/blog/forking-react-native-boring-avatars

Couldn't we have made a Pull Request? Yes, but the original library seems to have stagnated a bit with no recent changes and serveral hanging Issues. We also wanted to impose our own code style and TypeScipt preferences.

Installation

yarn add @mealection/react-native-boring-avatars

Usage

// ...
import Avatar from 'react-native-boring-avatars';

<Avatar
  size={40}
  name="Sacagawea"
  variant="pixel"
  colors={['#92A1C6', '#146A7C', '#F0AB3D', '#C271B4', '#C20D90']}
/>;

Props

Prop Type
size number or string, 40px (default)
square boolean: false (default)
title boolean: false (default)
name string
variant oneOf: marble (default), beam, pixel,sunset, ring, bauhaus
colors array of colors

License

MIT