Code Monkey home page Code Monkey logo

sapataaars's Introduction

SAPataaars: Avataaars with an SAP Twist

Licence: MIT

React component derived from the Avataaars package. Built on TypeScript, bundled with Webpack, and published on NPM.

This modification of Avataaars 1.2.1 includes new SAP-branded clothing and hat options.

Install this package from NPM here.


SAP Clothing and Hats

The available clothes are:

  • SapBestRunHoodie
  • SapCrewneckShirt
  • SapIxpBlazer

The available tops (hats) are:

  • SapBaseballCap
  • SapCowboyHat
  • SapToque

All other avatar customizations from Avataaars 1.2.1 are also available. To explore non-SAPataaar options, see Avataaars Generator.

Credits

The original Avataaars Generator is developed by Fang-Pen Lin, and was based on the Sketch library Avataaars designed by Pablo Stanley.

Usage

A working React project is required as a base.

Install the package:

yarn add sapataaars

// or

npm install sapataaars --save

In the React project, import the SAPataaar component with the preferred character customization:

import * as React from 'react'
import Avatar from 'sapataaars'

export default class MyComponent extends React.Component {
  render () {
    return
      <div>
        Your avatar:
        <Avatar
          style={{width: '100px', height: '100px'}}
          avatarStyle='Circle'
          topType='SapBaseballCap'
          accessoriesType='Prescription02'
          hairColor='BrownDark'
          facialHairType='Blank'
          clotheType='SapBestRunHoodie'
          clotheColor='PastelBlue'
          eyeType='Happy'
          eyebrowType='Default'
          mouthType='Smile'
          skinColor='Light'
        />
      </div>
  }
}

Building the Component for NPM Release

TypeScript and Webpack are both required to build the component.

Install all dependencies:

npm install

Update package.json with the version number to publish, and optionally create a Git tag for tracking.

Create the package to publish:

npm run build

Finally, publish the package to NPM:

npm publish

sapataaars's People

Contributors

fangpenlin avatar jleung51 avatar nguyenkhooi avatar scrumptiousdev avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.