https://github.com/yysuni/blockies-react-svg

Blockies react SVG function component, blocky identicons, address-unique ethereum avatar, SVG base64 generation in browser or nodejs.
https://github.com/yysuni/blockies-react-svg

address avatar base64 blockies ethereum nodejs react svg

Last synced: 11 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/yysuni/blockies-react-svg
• Owner: YYsuni
• License: mit
• Created: 2023-01-05T14:20:09.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-09-26T16:52:54.000Z (over 1 year ago)
• Last Synced: 2025-01-01T20:37:03.590Z (about 1 month ago)
• Topics: address, avatar, base64, blockies, ethereum, nodejs, react, svg
• Language: TypeScript
• Homepage: https://blockies-react-svg.vercel.app/
• Size: 813 KB
• Stars: 6
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](sample.png "Blockies")

## Installation

```bash

$ npm i blockies-react-svg

```

```bash

$ npm i blockies-react-svg@canary

```

## Usage

```tsx

// canary

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

// 





```

## 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

- [x] ts component

- [x] base64 url

- [x] js compile

- [x] demo display (github pages)

- [x] pure base64 (remove react-dom/server dependence, ~70kb bundle size)

- [x] support nodejs

- [ ] svg mirror optmization (reduce image size)

- [ ] svg polygon optmization (reduce image size)

- [ ] more shapes

- [ ] different rand algorithm