Animal Avatar Generator

Generate SVG avatars on client side from a string seed. As long as the same version of the library is used it always returns the same avatar for the corresponding seed.

Live example

Install

Using npm:

$ npm install animal-avatar-generator --save

or using yarn:

$ yarn add animal-avatar-generator

Usage

import avatar from 'animal-avatar-generator'

const svg = avatar('your custom seed', { size: 200 })
document.getElementById('avatar').innerHTML = svg

Configuration options

Name	Type	Description	Default
`size`	`number or string`	Avatar size in pixels or css property	`150 or '75%'`
`round`	`boolean`	Use round or rectangle shape	`true`
`blackout`	`boolean`	Use blackout for right side of an avatar	`true`
`avatarColors`	`string[]`	Palette for avatar colors	`['#d7b89c', '#b18272','#ec8a90','#a1Ac88','#99c9bd','#50c8c6']`
`backgroundColors`	`string[]`	Palette for background colors	`['#fcf7d1', '#ece2e1','#e4e3cd','#c4ddd6','#b5f4bc']`

Missing a configuration? Raise an issue.

License

MIT

Typescript error occurs when building project

Typescript error occurs when building project:

ERROR in ../common/temp/node_modules/.pnpm/${path}[email protected]/node_modules/animal-avatar-generator/dist/index.js 1:0-37
Module not found: Error: Can't resolve './utils/array' in '/${path}/node_modules/.pnpm/[email protected]/node_modules/animal-avatar-generator/dist'
Did you mean 'array.js'?
BREAKING CHANGE: The request './utils/array' failed to resolve only because it was resolved as fully specified
(probably because the origin is a '.mjs' file or a '.js' file where the package.json contains '"type": "module"').
The extension in the request is mandatory for it to be fully specified.
Add the extension to the request.
@ ../packages/base-components/build/dist/components/UserAvatar/UserAvatar.js 29:48-82
@ ../packages/base-components/build/dist/components/UserAvatar/index.js 13:13-36
@ ../packages/base-components/build/dist/components/index.js 80:13-36
@ ../packages/base-components/build/dist/index.js 17:13-36
@ ../packages/externals-init/build/dist/index.js 41:37-68
@ ./src/index.js 1:0-59 4:1-21

ERROR in ../common/temp/node_modules/.pnpm/${path}[email protected]/node_modules/animal-avatar-generator/dist/index.js 2:0-74
Module not found: Error: Can't resolve './utils/svg' in '/${path}/node_modules/.pnpm/[email protected]/node_modules/animal-avatar-generator/dist'
Did you mean 'svg.js'?
BREAKING CHANGE: The request './utils/svg' failed to resolve only because it was resolved as fully specified
(probably because the origin is a '.mjs' file or a '.js' file where the package.json contains '"type": "module"').
The extension in the request is mandatory for it to be fully specified.
Add the extension to the request.
@ ../packages/base-components/build/dist/components/UserAvatar/UserAvatar.js 29:48-82
@ ../packages/base-components/build/dist/components/UserAvatar/index.js 13:13-36
@ ../packages/base-components/build/dist/components/index.js 80:13-36
@ ../packages/base-components/build/dist/index.js 17:13-36
@ ../packages/externals-init/build/dist/index.js 41:37-68
@ ./src/index.js 1:0-59 4:1-21

ERROR in ../common/temp/node_modules/.pnpm/${path}[email protected]/node_modules/animal-avatar-generator/dist/index.js 3:0-44
Module not found: Error: Can't resolve './utils/random' in '/${path}/node_modules/.pnpm/[email protected]/node_modules/animal-avatar-generator/dist'
Did you mean 'random.js'?
BREAKING CHANGE: The request './utils/random' failed to resolve only because it was resolved as fully specified
(probably because the origin is a '.mjs' file or a '.js' file where the package.json contains '"type": "module"').
The extension in the request is mandatory for it to be fully specified.
Add the extension to the request.
@ ../packages/base-components/build/dist/components/UserAvatar/UserAvatar.js 29:48-82
@ ../packages/base-components/build/dist/components/UserAvatar/index.js 13:13-36
@ ../packages/base-components/build/dist/components/index.js 80:13-36
@ ../packages/base-components/build/dist/index.js 17:13-36
@ ../packages/externals-init/build/dist/index.js 41:37-68
@ ./src/index.js 1:0-59 4:1-21

ERROR in ../common/temp/node_modules/.pnpm/${path}[email protected]/node_modules/animal-avatar-generator/dist/index.js 4:0-81
Module not found: Error: Can't resolve './palette' in '/${path}/node_modules/.pnpm/[email protected]/node_modules/animal-avatar-generator/dist'
Did you mean 'index.js'?
BREAKING CHANGE: The request './palette' failed to resolve only because it was resolved as fully specified
(probably because the origin is a '.mjs' file or a '.js' file where the package.json contains '"type": "module"').
The extension in the request is mandatory for it to be fully specified.
Add the extension to the request.
@ ../packages/base-components/build/dist/components/UserAvatar/UserAvatar.js 29:48-82
@ ../packages/base-components/build/dist/components/UserAvatar/index.js 13:13-36
@ ../packages/base-components/build/dist/components/index.js 80:13-36
@ ../packages/base-components/build/dist/index.js 17:13-36
@ ../packages/externals-init/build/dist/index.js 41:37-68
@ ./src/index.js 1:0-59 4:1-21

ERROR in ../common/temp/node_modules/.pnpm/${path}[email protected]/node_modules/animal-avatar-generator/dist/index.js 5:0-90
Module not found: Error: Can't resolve './shapes' in '/${path}/node_modules/.pnpm/[email protected]/node_modules/animal-avatar-generator/dist'
Did you mean 'index.js'?
BREAKING CHANGE: The request './shapes' failed to resolve only because it was resolved as fully specified
(probably because the origin is a '.mjs' file or a '.js' file where the package.json contains '"type": "module"').
The extension in the request is mandatory for it to be fully specified.
Add the extension to the request.
@ ../packages/base-components/build/dist/components/UserAvatar/UserAvatar.js 29:48-82
@ ../packages/base-components/build/dist/components/UserAvatar/index.js 13:13-36
@ ../packages/base-components/build/dist/components/index.js 80:13-36
@ ../packages/base-components/build/dist/index.js 17:13-36
@ ../packages/externals-init/build/dist/index.js 41:37-68
@ ./src/index.js 1:0-59 4:1-21

5 errors have detailed information that is not shown.
Use 'stats.errorDetails: true' resp. '--stats-error-details' to show it.

webpack 5.21.2 compiled with 5 errors in 54167 ms

roma-lukashik / animal-avatar-generator Goto Github PK