Package Exports

react-hooks-identicons
react-hooks-identicons/build/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-hooks-identicons) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

header

React Hooks Identicons

A dynamic React component that creates an identicon based on a provided string. This library is based on react-identicons but was rewritten in React Hooks to avoid deprecation warnings.

Install

With npm:

npm i --save react-hooks-identicons

With yarn:

yarn add react-hooks-identicons

Usage

import React from 'react';
import Identicon from 'react-hooks-identicons';

const App = () => {
    return (
        <Identicon string='user@example.com' />
    );
};

export default App;

API

The following props are available:

Prop	Type	Description
string	string	Is used to generate the identicon.
size	integer	Defines the width and height of the identicon.
padding	integer	Adds padding in px to the blocks.
bg	string	Background color.
fg	string	Color of the blocks. If no color was provided, it generates the color based on the string.
palette	[string]	Array of hex color strings that will be used as color for the blocks.
count	number	Number of blocks. Allowed counts are 1-5.
getColor	function	The color for the blocks will be passed to the getColor function, if it was provided.

Only the string prop is mandatory. All other props are optional.

Credits

This library is based on the concept of react-identicons.