Skip to content
Flutter wrapper widget for Avataaars API.
Dart
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example Implement core functionality May 5, 2019
lib Expose AvataaarsApi May 11, 2019
.gitignore Add pubspec.lock to gitignore May 11, 2019
.metadata Implement core functionality May 5, 2019
CHANGELOG.md Bump cached_network_image to 1.1.1 Aug 26, 2019
LICENSE Initial commit May 5, 2019
README.md Expose AvataaarsApi May 11, 2019
pubspec.yaml Bump cached_network_image to 1.1.1 Aug 26, 2019

README.md

avataaar_image

pub package

Flutter wrapper widget for Avataaars API - a free online avatar generator for anyone to make their beautiful personal avatar easily.

AvataaarImage example

Avataaars

Credits to Pablo Stanley and Fang-Pen Lin for creating and making Avataaars available to use. 👏

Getting Started

  1. Create Avataaar object:
// Create avatar with default constructor
Avataaar(
  skin: Skin.pale,
  style: Style.circle,
  top: Top.longHairCurly(
    accessoriesType: AccessoriesType.Round,
    facialHair: FacialHair.beardMagestic(
      facialHairColor: FacialHairColor.BlondeGolden,
    ),
  ),
);

// Randomize all properties
Avataaar.random();

// Or mix both
Avataaar.random(
  skin: Skin.pale,
  style: Style.circle,
  top: Top.longHairCurly(
    accessoriesType: AccessoriesType.Round,
    facialHair: FacialHair.random,
  ),
);
  1. Create AvataaarImage widget and pass it the avatar:
AvataaarImage(
  avatar: avatar,
  errorImage: Icon(Icons.error),
  placeholder: CircularProgressIndicator(),
  width: 128.0,
);

// By default package will use CachedNetworkImage to render the image. If it doesn't fit your 
// needs it's possible to use [builder] constructor and create widget for given image url:
AvataaarImage.builder(
  avatar: avatar,
  builder: (context, url) {
    // ...
  },
)

Persisting avatars

Use Avataaar.toJson() and Avataaar.fromJson(String) methods to serialize/deserialize avatars.

Getting image bytes

Instantiate AvataaarsApi object and use its getImage method or getUrl if you prefer to handle fetching the data on your own.

You can’t perform that action at this time.