npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

custom-avatar-generator

v1.2.0

Published

Angular Element (Web Component) that creates a random avatar svg image and lets the user customize it with endless possible combinations.

Downloads

52

Readme

custom-avatar-generator

npm

Angular Element (Web Component) that creates a random avatar svg image and lets the user customize it with endless possible combinations.

If you would like to use this generator as Angular Module inside your Angular Application, checkout this package: https://www.npmjs.com/package/ng-custom-avatar-generator

Demo

Use the generator and see how it will look like at your page or application in this ⚡ Demo

See the code and play with the attributes in this ⚡ JSFiddle

Screenshots & Images

User Interface

Generator UI

Resulting Avatars examples

Example Avatar Example Avatar Example Avatar Example Avatar

Usage

Integrate the package script:

<script type="module" src="https://unpkg.com/[email protected]"></script>

Add the Angular Element with optional attributes to adapt the avatar generator.

<custom-avatar-generator 
  shape="square" 
  enable-background="true" 
  display-download="true" 
  texts='{"everything":"EVERYTHING","allColors":"All colors","background":"Background","skin":"Skin","hair":"Hair","hairStyle":"Hair Style","accessory":"Accessory","clothes":"Clothes","clothing":"Clothing","print":"Print"}'>
<custom-avatar-generator 

On every change the component fires an event with the current svg url, so you can listen to it (and e.g. store it in a variable to save it to your database when the user clicks "save") - or whatever you want to do with the svg.

const el = document.querySelector('custom-avatar-generator');
el.addEventListener('svgUrl', (event) => {
    const mySvgUrl = event.detail;
    console.log(mySvgUrl);
    // do whatever you want here
});

Attributes

All input attributes are optional and have a default. Possible inputs are:

| name | possible values | default | description | | ------------- |------------- | ---- | ----- | | shape | 'sqaure' or 'round' | 'round' | shape of the avatar image | | enable-background| 'true' or 'false' | 'false' | Displays a colored background behind the avatar and lets the user customize the color | | enable-face | 'true' or 'false' | 'false' | Displays eyebrows, eyes, nose, mouth, facial hair and glasses and lets the user customize the color and type | | display-download | 'true' or 'false' | 'false' | Displays a download button below the controls so the user can save the svg file on their device | | texts | JSON with all displayed text string. Structure below| see JSON below | Modify the display texts of the controls |

{
    "everything": "EVERYTHING",
    "allColors": "All colors",
    "background": "Background", // optional
    "skin": "Skin",
    "hair": "Hair",
    "hairStyle": "Hair Style",
    "accessory": "Accessory",
    "clothes": "Clothes",
    "clothing": "Clothing",
    "print": "Print",
    "eyebrows": "Eyebrows", // optional
    "eyes": "Eyes", // optional
    "nose": "Nose", // optional
    "mouth": "Mouth", // optional
    "facialHair": "FacialHair", // optional
    "glasses": "Glasses" // optional
}

Keep attention that you integrate every property when using the texts attribute because it completely overwrites the default texts object.

Info

Based on https://avataaars.com/