README.md

Hash Value

Get a consistent value from an array based on a string value.

Table of Contents

• Installation
• Usage
• Examples
  • Material UI Avatar
• Development

Installation

npm install hash-value --save

Usage

import hashValue from 'hash-value';

// colors from https://www.materialui.co/flatuicolors
const colors = [
  '#1abc9c', // Turquoise
  '#2ecc71', // Emerald
  '#3498db', // Peterriver
  '#9b59b6', // Amethyst
  '#34495e', // Wetasphalt
  '#f1c40f', // Sunflower
  '#e67e22', // Carrot
  '#e74c3c', // Alizarin
];

hashValue('Luke Skywalker', colors);
// => #3498db

Example

Material UI Avatar

import Avatar from '@material-ui/core/Avatar';
import {
  blue,
  green,
  orange,
  purple,
  red,
  teal,
} from '@material-ui/core/colors';
import hashValue from 'hash-value';

const colors = [
  blue[500],
  green[500],
  orange[500],
  purple[500],
  red[500],
  teal[500],
];

function ColorAvatar(props) {
  const { name } = props;
  const bg = hashValue(name, colors);

  return <Avatar style={{ backgroundColor: bg }}>{name.charAt(0)}</Avatar>;
}

Development

npm install
npm run build