Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

@dicebear/avatars-gridy-sprites

4.2.5 • Public • Published

DiceBear Avatars - Gridy Sprite Collection

license npm

Designed by Jan Forst.

## Usage

HTTP-API (recommended)

Our free HTTP-API is the easiest way to use this sprite collection. Just use the following URL as image source.

https://avatars.dicebear.com/api/gridy/:seed.svg

The value of :seed can be anything you like - but don't use any sensitive or personal data here! The GET parameter options can be used to pass options.

Examples

preview url
https://avatars.dicebear.com/api/gridy/custom-seed.svg
https://avatars.dicebear.com/api/gridy/custom-seed.svg?options[colorful]=1

NPM

Install the Avatars and this sprite collection with the following command.

npm install --save @dicebear/avatars @dicebear/avatars-gridy-sprites

Now you are ready to create your first Avatar.

import Avatars from '@dicebear/avatars';
import sprites from '@dicebear/avatars-gridy-sprites';
 
let options = {};
let avatars = new Avatars(sprites, options);
let svg = avatars.create('custom-seed');

Options

name alias type default description
radius r number 0 Avatar border radius
base64 bool false Return avatar as base64 data uri instead of XML
Not supported by the HTTP API
width w number null Fixed width
height h number null Fixed height
margin m number 0 Avatar margin in percent
HTTP-API limitation Max value 25
background b string null Any valid color identifier
HTTP-API limitation Only hex (3-digit, 6-digit and 8-digit) values are allowed. Use url encoded hash: %23.
userAgent string window.navigator.userAgent User-Agent for legacy browser fallback
Automatically detected by the HTTP API
colorful boolean false Use different colors for eyes and mouth
deterministic boolean false Force deterministic output (see #64)

Further information

You can find the DiceBear Avatars documentation at avatars.dicebear.com

Install

npm i @dicebear/avatars-gridy-sprites

DownloadsWeekly Downloads

67

Version

4.2.5

License

MIT

Unpacked Size

10.6 kB

Total Files

6

Last publish

Collaborators

  • avatar