Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/laurentpayot/minidenticons
Super lightweight SVG identicon (pixelated avatar) generator
https://github.com/laurentpayot/minidenticons
avatar avatar-component avatar-generator avatars gdpr identicon identicon-generator identicon-generators identicon-github identicon-library identicon-svgs identicons javascript light lightweight profile-picture profile-picture-generator svg tiny typescript
Last synced: 26 days ago
JSON representation
Super lightweight SVG identicon (pixelated avatar) generator
- Host: GitHub
- URL: https://github.com/laurentpayot/minidenticons
- Owner: laurentpayot
- License: mit
- Created: 2021-03-16T07:55:04.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-30T07:43:40.000Z (4 months ago)
- Last Synced: 2024-08-26T15:45:22.846Z (28 days ago)
- Topics: avatar, avatar-component, avatar-generator, avatars, gdpr, identicon, identicon-generator, identicon-generators, identicon-github, identicon-library, identicon-svgs, identicons, javascript, light, lightweight, profile-picture, profile-picture-generator, svg, tiny, typescript
- Language: JavaScript
- Homepage: https://laurentpayot.github.io/minidenticons
- Size: 288 KB
- Stars: 463
- Watchers: 6
- Forks: 22
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Minidenticons
Super lightweight SVG identicon generator. No dependencies.
(using the `minidenticon()` function only)
(using the included custom element)
[](https://github.com/laurentpayot/minidenticons/blob/main/package.json#L60)
[](https://github.com/laurentpayot/minidenticons/blob/main/index.d.ts)
[](https://www.npmjs.com/package/minidenticons)
[](https://github.com/laurentpayot/minidenticons/blob/main/LICENSE)
[
](https://laurentpayot.github.io/minidenticons/)
## Why
- Generate identicons (pixelated avatars) on the client from usernames instead of fetching images from a server. Much faster, saves bandwidth and [GDPR compliant](https://gdpr.eu/eu-gdpr-personal-data/).
- Replace dull initial avatars like 
by easily remembered graphical avatars.
- Give a visual representation of hashes or any ID string.
## Live Demo :video_game:
Play with it [here](https://laurentpayot.github.io/minidenticons/).
## Basic usage with the included custom element
Minidenticons uses [ES modules](https://jakearchibald.com/2017/es-modules-in-browsers/), now [widely supported](https://caniuse.com/es6-module) in browsers. Import the `minidenticonSvg` custom element from the `minidenticons.min.js` file. This file can be located in a CDN (example below) or copied in any directory of your website (for better performance and to be GDPR compliant, since you don’t have to connect to a third party server).
```html
import { minidenticonSvg } from 'https://cdn.jsdelivr.net/npm/[email protected]/minidenticons.min.js'
```
Then simply use `minidenticon-svg` tags with a `username` attribute :joy:
```html
```
(Note that like for all elements except [void elements](https://html.spec.whatwg.org/multipage/syntax.html#void-elements), the closing tag `` is required)
For instance with the `laurent` username you will get the following identicon (without the border):
### Styling
For easy CSS styling:
- Minidenticons are [SVG](https://en.wikipedia.org/wiki/SVG) images that will take [all the space available.](https://raw.githubusercontent.com/laurentpayot/minidenticons/main/img/laurent.svg) The picture above is resized.
- The background is transparent.
- There is white space around the colored square matrix to allow uncropped circle avatars.
So with the following CSS:
```css
minidenticon-svg svg {
border-radius: 50%;
background-color: grey;
height: 48px;
width: 48px;
};
```
You will get:
By default the color saturation is set to 95% and the lightness is set to 45%. But you can change these values with the `saturation` and/or `lightness` attributes, for instance:
```html
```
Play with [the demo](https://laurentpayot.github.io/minidenticons/) to find a combination of saturation and lightness that matches your website theme colors: light, dark or whatever :sunglasses:
### Performance
- *Custom element* identicons are [memoized](https://en.wikipedia.org/wiki/Memoization) (stored in memory so that it does not need to be recalculated).
- To see how long it takes for your browser to generate 100 identicon custom elements (for a big page) try out the [online browser benchmark](https://laurentpayot.github.io/minidenticons/benchmark/browser.html).
## Advanced usage with the `minidenticon()` function
Instead of using the custom element, you can also use the `minidenticon()` function to generate SVG strings in your client (or your server).
```typescript
minidenticon(seed: string, saturation?: number|string, lightness?: number|string, hashFn?: (str: string) => number): string
```
The `minidenticon()` function will return a SVG string generated from its seed string argument. The seed argument can be a username, but actually any string used as an identifier.
Optional saturation and lightness arguments should be percentages; that is, numbers (or strings) between 0 and 100.
If you need to, you can use your own hash function as argument of the fourth parameter (optional). Your custom hash function must take a string and return a number. The last 15 bits of the integer part of the hash will be used to draw the squares. The included custom element does not use this last parameter.
Note that the `minidenticon()` function itself is *not* memoized.
### NodeJS
Be sure to use a NodeJS version greater or equal to **15.14.0**.
#### Installation
```bash
npm install minidenticons
```
#### Import
```javascript
import { minidenticon } from 'minidenticons'
```
The `minidenticonSvg` custom element should be tree-shaken from your bundle, for an even smaller size of minidenticons :grin:
#### Performance
The `minidenticon()` function is *fast*. You can see by yourself if you run `node benchmark/node` at the root of a Minidenticons git clone. On my machine I get the following result:
```
Time to generate 10000 minidenticon SVG strings for 15 characters random seeds:
8 milliseconds (10 runs average)
```
### React
The following [React component example](https://codepen.io/laurentpayot/pen/RweNNQR) inserts the identicon into an `img` tag `src` attribute. It also uses React `useMemo` to memoize the identicon.
```jsx
import { minidenticon } from 'minidenticons'
import { useMemo } from 'react'
const MinidenticonImg = ({ username, saturation, lightness, ...props }) => {
const svgURI = useMemo(
() => 'data:image/svg+xml;utf8,' + encodeURIComponent(minidenticon(username, saturation, lightness)),
[username, saturation, lightness]
)
return (
)
}
```
You can then use this component with `img` props such as `width` and `height` along with minidenticons ones. All props except `username` are optional.
```html
```
For a TypeScript version of this example see the [original issue comment](https://github.com/laurentpayot/minidenticons/issues/2#issuecomment-1485545388) by [Dan Yishai](https://github.com/danyi1212).
### Workbox
In this example using [Workbox](https://developer.chrome.com/docs/workbox/), images with a path ending with `minidenticons/.svg` are generated by the service worker and cached for one year.
```javascript
import { minidenticon } from 'minidenticons'
import { registerRoute } from 'workbox-routing'
registerRoute(
/minidenticons\/[^\/]+\.svg$/,
async ({ url }) => {
const username = url.pathname.match(/([^\/]+)\.svg$/)[1]
return new Response(
minidenticon(username),
{ headers: { "Content-Type": "image/svg+xml", "Cache-Control": "max-age=31536000" } }
)
}
)
```
## Rust
A [Rust](https://www.rust-lang.org/) port of Minidenticons was made by Théo Battrel: [`minidenticons-rs`](https://gitlab.com/Emplis/minidenticons-rs).
## Elm
For [Elm](https://elm-lang.org/) enthusiasts there is a Minidenticons package on the Elm package repository: [`minidenticons-elm`](https://package.elm-lang.org/packages/laurentpayot/minidenticons-elm/latest).
## Collisions
You will always get the same identicon for a given username. But it is not impossible to have different usernames with the same identicon. That's a [collision](https://en.wikipedia.org/wiki/Hash_collision).
Generated identicons are 5×5 matrices with vertical symmetry, and can have 9 different hues for the same saturation and lightness.
This means there are 2(3×5) × 9 = 294,912 different identicons possible, but duplicate identicons are inevitable when using a lot of them. It shouldn’t matter as identicons should not be used solely to identify an user, and should always be coupled to a *unique* username :wink:
The `npm test` command results below show that you have less than a 2 percent chance to generate a duplicate identicon when already using 10,000 of them.
```text
0 collisions out of 100 (0.00%)
0 collisions out of 200 (0.00%)
0 collisions out of 300 (0.00%)
0 collisions out of 400 (0.00%)
0 collisions out of 500 (0.00%)
0 collisions out of 600 (0.00%)
0 collisions out of 700 (0.00%)
0 collisions out of 800 (0.00%)
1 collisions out of 900 (0.11%)
1 collisions out of 1000 (0.10%)
8 collisions out of 2000 (0.40%)
14 collisions out of 3000 (0.47%)
22 collisions out of 4000 (0.55%)
37 collisions out of 5000 (0.74%)
58 collisions out of 6000 (0.97%)
75 collisions out of 7000 (1.07%)
99 collisions out of 8000 (1.24%)
129 collisions out of 9000 (1.43%)
163 collisions out of 10000 (1.63%)
```
## License
[MIT](https://github.com/laurentpayot/minidenticons/blob/main/LICENSE)
## Stargazers :heart:
[](https://github.com/laurentpayot/minidenticons/stargazers)