Skip to content
@avatar-generator Docs

Installation

Quick Start

Install the core package and at least one style:

Terminal window
npm install @avatar-generator/core @avatar-generator/style-initials

Framework Packages

React

Terminal window
npm install @avatar-generator/react @avatar-generator/style-initials

Angular

Terminal window
npm install @avatar-generator/angular @avatar-generator/style-initials

Available Styles

Each style is a separate tree-shakeable package:

PackageDescription
@avatar-generator/style-initialsLetter initials on colored backgrounds
@avatar-generator/style-geometricGitHub-style symmetrical identicon patterns
@avatar-generator/style-pixels8-bit retro pixel faces
@avatar-generator/style-ringsConcentric rings with segmented/dashed variants
@avatar-generator/style-facesMinimal flat geometric faces
@avatar-generator/style-illustratedDetailed cartoon faces with accessories
@avatar-generator/style-animeAnime/manga-inspired faces with expressive eyes

Install any styles you want to use:

Terminal window
npm install @avatar-generator/style-geometric @avatar-generator/style-pixels @avatar-generator/style-rings @avatar-generator/style-faces @avatar-generator/style-illustrated @avatar-generator/style-anime

Next Steps