give-me-an-avatar
v1.0.0
Published
Gets a random avatar URL from a collection of different avatar generation services.
Downloads
17
Maintainers
Keywords
Readme
Give Me an Avatar
Gets a random avatar URL from a collection of different avatar generation services.
Usage
Install the package from npm using the following command.
npm i give-me-an-avatar
After installing, simply import Give Me an Avatar in your file.
const avatars = require("give-me-an-avatar");
Consume the giveMeAnAvatar()
API to get an avatar URL that you can use directly as an image. You can either call the method without any parameters or supply the settings object to customize your avatar a bit. All settings are pretty self-explanatory and are not mandatory. For example:
let image = avatars.giveMeAnAvatar({
Name: "John Smith",
Size: 128
});
The image variable will have the avatar image URL.
If you'd like to consume this package via a CDN, please see this demo.
Supported avatar services
| Service | Avatar example | |--------------------------------------------|------------------------------------------------------| | placeholder.com | | | placeimg.com | | | placekitten.com | | | dummyimage.com | | | loremflickr.com | | | baconmockup.com | | | placebeard.it | | | fakeimg.pl | | | thispersondoesnotexist.com | | | picsum.photos | | | fillmurray.com | | | placecage.com | | | stevensegallery.com | | | gravatar.com | | | ui-avatars.com | | | generative-placeholders.glitch.me | | | robohash.org | | | avatars.dicebear.com | | | avatar.uimaterial.com | |
Notes
- I'm not using avataaars separately since avatars.dicebear.com includes avataaars.
- Placekitten image might appear broken at times in the table above, however, the image service itself runs fine.
Credits
- All the avatar services used in this npm package are outlined in the table above.
- Package logo created using AutoDraw.
- This NPM package is developed by Clyde D'Souza.