Initials
Initials by DiceBear, licensed under CC0 1.0 .
LICENSE
While our code is MIT licensed, the design of this avatar style is licensed under CC0 1.0. See details for more information.
Usage
Use this URL to request this avatar style via our HTTP API.
https://api.dicebear.com/9.x/initials/svg
You can use the URL directly as image source.
See HTTP-API docs for more information.
First install the required packages via npm:
npm install @dicebear/core @dicebear/collection --save
Then you can create this avatar as follows:
import { createAvatar } from '@dicebear/core';
import { initials } from '@dicebear/collection';
const avatar = createAvatar(initials, {
// ... options
});
const svg = avatar.toString();
See JS-Library docs for more information.
First install the CLI package via npm:
npm install --global dicebear
Then you can create this avatar as follows:
dicebear initials
See CLI docs for more information.
Options
seed
TypestringThe seed determines the initial value for the built-in PRNG. With the PRNG you can create the same avatar over and over again based.
FelixAnekahttps://api.dicebear.com/9.x/initials/svg?seed=Felix
createAvatar(initials, {
seed: "Felix"
});dicebear initials --seed "Felix"
flip
Typebooleanfalsetruefalsehttps://api.dicebear.com/9.x/initials/svg?flip=false
createAvatar(initials, {
flip: false
});dicebear initials --flip false
rotate
TypeintegerMinimum 0Maximum 3600901802700https://api.dicebear.com/9.x/initials/svg?rotate=0
createAvatar(initials, {
rotate: 0
});dicebear initials --rotate 0
scale
TypeintegerMinimum 0Maximum 20050100200100https://api.dicebear.com/9.x/initials/svg?scale=50
createAvatar(initials, {
scale: 50
});dicebear initials --scale 50
radius
TypeintegerMinimum 0Maximum 50010203040500https://api.dicebear.com/9.x/initials/svg?radius=0
createAvatar(initials, {
radius: 0
});dicebear initials --radius 0
size
TypeintegerMinimum 13248648096https://api.dicebear.com/9.x/initials/svg?size=32
createAvatar(initials, {
size: 32
});dicebear initials --size 32
backgroundColor
TypearrayItem Pattern ^(transparent|[a-fA-F0-9]{6})$b6e3f4c0aeded1d4f9ffd5dcffdfbf00acc11e88e55e35b17cb3428e24aa039be543a04700897b3949abc0ca33d81b60e53935f4511efb8c00fdd835ffb300https://api.dicebear.com/9.x/initials/svg?backgroundColor=b6e3f4,c0aede,d1d4f9
createAvatar(initials, {
backgroundColor: ["b6e3f4","c0aede","d1d4f9"]
});dicebear initials --backgroundColor "b6e3f4" "c0aede" "d1d4f9"
backgroundType
TypearraygradientLinearsolidsolidhttps://api.dicebear.com/9.x/initials/svg?backgroundType=gradientLinear,solid
createAvatar(initials, {
backgroundType: ["gradientLinear","solid"]
});dicebear initials --backgroundType "gradientLinear" "solid"
backgroundRotation
Typearray Specify an array of two numbers for this option. The PRNG will generate a number between the two values, which will be used as the rotation degree. The rotation is only visible if backgroundType is set to ['gradientLinear'].
0360https://api.dicebear.com/9.x/initials/svg?backgroundRotation=0,360
createAvatar(initials, {
backgroundRotation: [0,360]
});dicebear initials --backgroundRotation 0 360
translateX
TypeintegerMinimum -100Maximum 100-50-25025500https://api.dicebear.com/9.x/initials/svg?translateX=-50
createAvatar(initials, {
translateX: -50
});dicebear initials --translateX -50
translateY
TypeintegerMinimum -100Maximum 100-50-25025500https://api.dicebear.com/9.x/initials/svg?translateY=-50
createAvatar(initials, {
translateY: -50
});dicebear initials --translateY -50
clip
Typebooleantruehttps://api.dicebear.com/9.x/initials/svg?clip=true
createAvatar(initials, {
clip: true
});dicebear initials --clip true
randomizeIds
TypebooleanThis option randomize the IDs in the generated SVG / XML. This can be useful for example if the avatars are included directly in the HTML and you want to avoid ID collisions.
falsehttps://api.dicebear.com/9.x/initials/svg?randomizeIds=false
createAvatar(initials, {
randomizeIds: false
});dicebear initials --randomizeIds false
textColor
TypearrayItem Pattern ^(transparent|[a-fA-F0-9]{6})$ffffffhttps://api.dicebear.com/9.x/initials/svg?textColor=ffffff
createAvatar(initials, {
textColor: ["ffffff"]
});dicebear initials --textColor "ffffff"
fontFamily deprecated
TypearrayWARNING
This option is not supported by the HTTP-API for PNG and JPEG.
ArialBrush Script MTCourier NewGaramondGeorgiaHelveticasans-serifserifTahomaTimes New RomanTrebuchet MSVerdanaArialsans-serifhttps://api.dicebear.com/9.x/initials/svg?fontFamily=Arial,Brush%20Script%20MT,Courier%20New
createAvatar(initials, {
fontFamily: ["Arial","Brush Script MT","Courier New"]
});dicebear initials --fontFamily "Arial" "Brush Script MT" "Courier New"
fontSize deprecated
TypeintegerMinimum 1Maximum 10050https://api.dicebear.com/9.x/initials/svg?fontSize=50
createAvatar(initials, {
fontSize: 50
});dicebear initials --fontSize 50
chars deprecated
TypeintegerMinimum 0Maximum 22https://api.dicebear.com/9.x/initials/svg?chars=2
createAvatar(initials, {
chars: 2
});dicebear initials --chars 2
fontWeight deprecated
TypeintegerWARNING
This option is not supported by the HTTP-API for PNG and JPEG.
100200300400500600700800900400https://api.dicebear.com/9.x/initials/svg?fontWeight=100
createAvatar(initials, {
fontWeight: 100
});dicebear initials --fontWeight 100
Details
| Naming | |
|---|---|
| Collection Import | import { initials } from '@dicebear/collection'; |
| Package Import | import * as style from '@dicebear/initials'; |
| CLI | dicebear initials |
| HTTP-API | https://api.dicebear.com/9.x/initials/svg |
| JSON Schema | https://api.dicebear.com/9.x/initials/schema.json |
| Source | |
|---|---|
| Title | Initials |
| Creator | DiceBear |
| License | CC0 1.0 |
| Source | https://github.com/dicebear/dicebear |