Skip to content

Blockies react SVG function component, blocky identicons, address-unique ethereum avatar, SVG base64 generation in browser or nodejs.

License

Notifications You must be signed in to change notification settings

YYsuni/blockies-react-svg

Repository files navigation

blockies-react-svg

Blockies react SVG function component, blocky identicons, address-unique ethereum avatar, SVG base64 generation in browser or nodejs.

It allows you to use responsive width and height without rerendering because of SVG properties, and it will store the result.

Base64 url is smaller(~2kb) than the canvas size(~16kb), so it is suitable for server-side rendering.(8x8)

The address will automatically be converted to lower case until you set the caseSensitive property.

Sample of generated blockies

Installation

$ npm i blockies-react-svg
$ npm i blockies-react-svg@canary

Usage

// canary
import { BlockiesSvg, BlockiesSvgSync, makeBlockiesUrl, makeBlockiesSvgString } from 'blockies-react-svg'

// <BlockiesSvgSync 
<BlockiesSvg 
  address={address}
//size={8}
//scale={10}
//caseSensitive={false}
//defaultBackgroundColor="black"
  className='classname'
  style={styles} 
  />

<img src={makeBlockiesUrl(address)} />

<div dangerouslySetInnerHTML={{ __html: makeBlockiesSvgString(address) }} />

Why SVG?

  1. Canvas render doesn't support arbitrary size or other customized styles.

  2. SVG is the better experience, because of the infinite resolution.

  3. SVG file size is smaller than canvas.

Todo

  • ts component
  • base64 url
  • js compile
  • demo display (github pages)
  • pure base64 (remove react-dom/server dependence, ~70kb bundle size)
  • support nodejs
  • svg mirror optmization (reduce image size)
  • svg polygon optmization (reduce image size)
  • more shapes
  • different rand algorithm

About

Blockies react SVG function component, blocky identicons, address-unique ethereum avatar, SVG base64 generation in browser or nodejs.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published