tanem / default-avatar-helper Goto Github PK

View Code? Open in Web Editor NEW

:bowtie: A helper for creating default avatars.

License: MIT License

JavaScript 80.58% TypeScript 19.42%

default-avatar-helper's Introduction

default-avatar-helper

A helper for creating default avatars.

Usage

import { getDefaultAvatarDetails } from 'default-avatar-helper'

const palette = ['red', 'green', 'blue']
const name = 'random name'

// Providing both arguments at once will return a result object straight away:
const { colour, initials } = getDefaultAvatarDetails(palette, name)

// Alternatively, since `getDefaultAvatarDetails` is curried, you can do
// something like:
const getDefaultAvatarDetailsWithPalette = getDefaultAvatarDetails(palette)
const { colour, initials } = getDefaultAvatarDetailsWithPalette(name)

The following live examples show how colour and initials can be used to create a default avatar.

Live Examples

Vanilla: Source | Sandbox
UMD Build (Development): Source | Sandbox
UMD Build (Production): Source | Sandbox

API

getDefaultAvatarDetails(palette, colour)

Arguments

palette - An array of strings representing the colour palette to use.
name - A string representing a user name.

Returns

If less than two arguments have been provided, returns a function accepting the remaining argument.

If both arguments have been provided, returns an object containing the properties defined below:

colour - A colour string.
initials - The user initials string.

Example

const palette = ['red', 'green', 'blue']
const name = 'random name'

// Providing both arguments at once.
const { colour, initials } = getDefaultAvatarDetails(palette, name)

// Making use of currying.
const getDefaultAvatarDetailsWithPalette = getDefaultAvatarDetails(palette)
const { colour, initials } = getDefaultAvatarDetailsWithPalette(name)