1.0.0 • Published 2 years ago

pinkpanda-bigheads v1.0.0

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

react-native-bigheads-web


A 1-to-1 lib that reproduces what we have in the react native version of the PinkPanda app.

This was needed because we have some other accessories that are not in the original Big Heads library on the web.

BigHeads avatars for React Native. Based on @bigheads/core

Getting Started

install dependencies

yarn add react-native-bigheads react-native-svg

or

npm install react-native-bigheads react-native-svg --save

This package requires react-native-svg to be installed

Aditional steps in iOS

cd ios && pod install

usage

import the BigHead component from react-native-bigheads

import { BigHead } from 'react-native-bigheads'

use the BigHead component like this:

<BigHead
  accessory="shades"
  bgColor="blue"
  bgShape="circle"
  body="chest"
  clothing="tankTop"
  clothingColor="black"
  eyebrows="angry"
  eyes="wink"
  facialHair="mediumBeard"
  graphic="vue"
  hair="short"
  hairColor="black"
  hat="none"
  hatColor="green"
  lashes={false}
  lipColor="purple"
  mouth="open"
  showBackground={true}
  size={300}
  skinTone="brown"
/>

Props

Reference

Props

accessory

Type of accessory

TypeRequiredDefault
enum('none', 'roundGlasses', 'tinyGlasses', 'shades', 'faceMask', 'hoopEarrings')NoRandom

bgColor

The color of the background

TypeRequiredDefault
enum('blue', 'green', 'red', 'orange', 'yellow', 'turqoise', 'pink', 'purple')NoRandom

bgShape

The shape of the background

TypeRequiredDefault
enum('circle', 'square', 'squircle')NoRandom

body

Type of body

TypeRequiredDefault
enum('chest', 'breasts')NoRandom

clothing

Type of cloth

TypeRequiredDefault
enum('naked', 'shirt', 'dressShirt', 'vneck', 'tankTop', 'dress', 'denimJacket', 'hoodie', 'chequeredShirt', 'chequeredShirtDark')NoRandom

clothingColor

The color of the clothes

TypeRequiredDefault
enum('white', 'blue', 'black', 'green', 'red')NoRandom

containerProps

Props to be passed to the container element (View)

TypeRequired
View.propsNo

containerStyles

Styles to be applied to the container element (View)

TypeRequired
StyleNo

eyebrows

Type of eyebrows

TypeRequiredDefault
enum('raised', 'leftLowered', 'serious', 'angry', 'concerned')NoRandom

eyes

Type of eyes

TypeRequiredDefault
enum('normal', 'leftTwitch', 'happy', 'content', 'squint', 'simple', 'dizzy', 'wink', 'hearts', 'crazy', 'cute', 'dollars', 'stars', 'cyborg', 'simplePatch', 'piratePatch')NoRandom

facialHair

Type of facial hair

TypeRequiredDefault
enum('none', 'stubble', 'mediumBeard', 'goatee')NoRandom

graphic

Type of graphic over the t-shirts

TypeRequiredDefault
enum('none', 'redwood', 'gatsby', 'vue', 'react', 'graphQL', 'donut', 'rainbow')NoRandom

hair

Type of hair

TypeRequiredDefault
enum('none', 'long', 'bun', 'short', 'pixie', 'balding', 'buzz', 'afro', 'bob', 'mohawk')NoRandom

hairColor

The color of the hair

TypeRequiredDefault
enum('blonde', 'orange', 'black', 'white', 'brown', 'blue', 'pink')NoRandom

hat

Type of hat

TypeRequiredDefault
enum('none', 'beanie', 'turban', 'party', 'hijab')NoRandom

hatColor

The color of the hat

TypeRequiredDefault
enum('white', 'blue', 'black', 'green', 'red')NoRandom

lashes

Show lashes

TypeRequiredDefault
booleanNoRandom

lipColor

The color of the lips

TypeRequiredDefault
enum('red', 'purple', 'pink', 'turqoise', 'green')NoRandom

mouth

Type of mouth

TypeRequiredDefault
enum('grin', 'sad', 'openSmile', 'lips', 'open', 'serious', 'tongue', 'piercedTongue', 'vomitingRainbow')NoRandom

showBackground

Whether or not to display the background color

When true it cuts off everything below the avatar otherwise it won't clip off any of the avatar

TypeRequiredDefault
booleanNotrue

size

Size of the avatar

TypeRequiredDefault
numberNo100

skinTone

The color of the skin

TypeRequiredDefault
enum('light', 'yellow', 'brown', 'dark', 'red', 'black')NoRandom

Authors

Changelog

Learn about the latest improvements

License

This project is licensed under the MIT License - see the LICENSE file for details

Contributing

Please see the Contributing Guidelines.