habitica-avatar
A module for constructing the Habitica Avatar.
Usage
npm
npm install --save habitica-avatar
var habiticaAvatar =
In the browser
Download the most recent script on the releases page. The function is exposed as window.habiticaAvatar
.
window
Advanced options
Looking up user avatar by user id
The fromUserId
method on habiticaAvatar
takes a user id and any additional options you would normally pass into habiticaAvatar
and returns a Promise that resolves with the avatar.
habiticaAvatar // or habiticaAvatar// The avatar will be inserted into `#my-div` when the user look up is complete
If the user id does not resolve with a user, the Promise will reject.
habiticaAvatar
Dom Node
The container
property is optional. The return value of habiticaAvatar
is a DOM node that you can append anywhere in the DOM.
var avatar = avatarid = 'custom-id'avatar documentbody
If you pass in a container
property, it can either be a DOM node to append the avatar to, or a css selector for a DOM node. If the selector does not reference a DOM node, nothing will happen.
var node = document
Ignore
You can ignore properties, causing them to not render by passing an ignore object.
Force Costume
By default, the costume will render if the user has the costume feature turned on. You can force the costume to be shown with the forceCostume
option.
Force Equipment
By default, the equipment will render if the user has the costume feature turned off. You can force the equipment to be shown with the forceEquipment
option.
Testing
npm test
Demo App
A demo app is available at https://crookedneighbor.github.io/habitica-avatar/