Skip to content

cosmini/ui-avatar-svg

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Version License

UI Avatar SVG

Generate SVG avatars with user initials in pure JS.

Usage

Generate avatars using a flexible API:

const UIAvatarSvg = require('ui-avatar-svg');

const svg = (new UIAvatarSvg())
    .text('AB')
    .size(64)
    .bgColor('#ff0000')
    .textColor('#ffffff')
    .generate();

The generate() function returns a string <svg...> that can be embedded in your app.

API

  • text(string) - User initials (default AB)
  • round(boolean) - Is the avatar round instead of square (default true)
  • size(integer) - Avatar size in px (default 64)
  • bgColor(string) - Background color (default #ff0000)
  • textColor(string) - Text color (default #ffffff)
  • fontSize(float) - Font size on a scale from 0.1 - 1.0 (default 0.4)
  • fontWeight(string|integer) - Font weight (default normal)
  • fontFamily(string) - Font family (default -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 'Ubuntu', Sans', 'Droid Sans', 'Helvetica Neue', sans-serif)

Credits

UI Avatar SVG was created by Gilbert Pellegrom from Dev7studios. Released under the MIT license.

About

Generate SVG avatars with user initials in pure JS

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%