1.1.6 • Published 5 years ago

react-native-image-avatars v1.1.6

Weekly downloads
2
License
MIT
Repository
github
Last release
5 years ago

react-native-image-avatars

A simple and fully customizable React Native component that displays avatars for images & text.

FeaturesVisual Effects
Rounded & Square shaped avatars Avatars with border colors* Avatars for textual datanpm.io

Installation

If using yarn:

yarn add react-native-image-avatars

If using npm:

npm i react-native-image-avatars

Usage

import { Avatar } from 'react-native-image-avatars';

Text Avatar:

<Avatar
  imageUrl = 'https://images.pexels.com/photos/220453/pexels-photo-220453.jpeg?auto=compress&cs=tinysrgb&dpr=1&w=500'
  size="small"
  borderColor = "#f2f2f2"
  shadow
/>

Text Avatar:

<Avatar
  type = 'text'
  text='Davis Benton'
  size="x-small"
  borderColor = "#f2f2f2"
  textBackgroundFill = '#fff'
  shadow
/>

Documentation

Component Props Reference

NameDescriptionDefaultType
type'image' or 'text'imageString
imageUrlURL of the imagenoneString
shadowShadow effect: elevation {15} for android & equivalent for IOStrueBoolean
sizeValues: 'x-small', 'small', 'medium', 'large' or 'x-large'smallString
shapeValues: 'circle' or 'square'circleString
textExtracts initials of each word (upto 2 slices max). Example: text='David Benton Woods' would eventually display 'DB'noneString
borderColorBorder to the shape with color specifiednoneString
textBackgroundFillBackground color for text avatar#C0C0C0String

Contributing

Pull requests are always welcome! Feel free to open a new GitHub issue for any changes that can be made.

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Author

Saurabh Kataria | Freelance Developer

Looking for a full-time or part-time remote-based developer. Checkout my UpWork Profile: https://www.upwork.com/fl/saurabhkataria6

License

MIT