Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

avatar-initials-generator

david.mart263Apache-2.00.0.2TypeScript support: included

Circle avatar generator for Node.js

readme

initials-avatar-generator

Circle avatar generator for Node.js

Examples

David Mart Leela Turanga Pavel Durov Nick Minard

TSDoc

defaultPalette (variable: string[])

Color Palette

getBgColor (function)

getFontColor (function)

IAGConfig (interface)

Members:

  • palette (string[])
  • width (number)
  • fontProportion (number)
  • maxLetters (number)

draw (function)

getInitials (function)

generate (function)

Generate avatar

Parameters:

  • name (string) - Full name to be split into initials
  • config (IAGConfig) - Configuration
generate('Pavel Durov', {
  width: 300,
  palette: ['#d97706', '#4f46e5', '#9333ea'],
  maxLetters: 2,
  fontProportion: 0.6
});