2.0.140 • Published 10 months ago

default-avatar-helper v2.0.140

Weekly downloads
108
License
MIT
Repository
github
Last release
10 months ago

default-avatar-helper

npm version build status coverage status npm downloads minzipped size

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

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)

Installation

$ npm install default-avatar-helper

There are also UMD builds available via unpkg:

Make sure you have already included:

License

MIT

avataravatar-generatoravatar-placeholderavatarsdefault-avatarhelperjavascripttypescript
@babel/runtimelodashtslib
@everything-registry/sub-chunk-1461
2.0.139

10 months ago

2.0.140

10 months ago

2.0.138

1 year ago

2.0.137

1 year ago

2.0.136

1 year ago

2.0.135

2 years ago

2.0.134

2 years ago

2.0.133

2 years ago

2.0.132

2 years ago

2.0.131

2 years ago

2.0.130

2 years ago

2.0.129

2 years ago

2.0.128

2 years ago

2.0.127

2 years ago

2.0.126

2 years ago

2.0.125

2 years ago

2.0.124

2 years ago

2.0.123

2 years ago

2.0.122

2 years ago

2.0.121

2 years ago

2.0.120

2 years ago

2.0.119

2 years ago

2.0.118

2 years ago

2.0.117

2 years ago

2.0.116

2 years ago

2.0.115

2 years ago

2.0.114

2 years ago

2.0.113

2 years ago

2.0.112

2 years ago

2.0.111

2 years ago

2.0.110

2 years ago

2.0.109

2 years ago

2.0.108

2 years ago

2.0.107

2 years ago

2.0.106

2 years ago

2.0.105

2 years ago

2.0.104

2 years ago

2.0.103

2 years ago

2.0.102

2 years ago

2.0.101

2 years ago

2.0.100

2 years ago

2.0.99

3 years ago

2.0.97

3 years ago

2.0.98

3 years ago

2.0.95

3 years ago

2.0.96

3 years ago

2.0.94

3 years ago

2.0.93

3 years ago

2.0.92

3 years ago

2.0.88

3 years ago

2.0.89

3 years ago

2.0.86

3 years ago

2.0.87

3 years ago

2.0.84

3 years ago

2.0.85

3 years ago

2.0.83

3 years ago

2.0.91

3 years ago

2.0.90

3 years ago

2.0.82

3 years ago

2.0.81

3 years ago

2.0.80

3 years ago

2.0.79

3 years ago

2.0.77

3 years ago

2.0.78

3 years ago

2.0.75

3 years ago

2.0.76

3 years ago

2.0.73

3 years ago

2.0.74

3 years ago

2.0.71

3 years ago

2.0.72

3 years ago

2.0.70

3 years ago

2.0.68

3 years ago

2.0.69

3 years ago

2.0.66

3 years ago

2.0.67

3 years ago

2.0.65

4 years ago

2.0.64

4 years ago

2.0.62

4 years ago

2.0.63

4 years ago

2.0.61

4 years ago

2.0.59

4 years ago

2.0.60

4 years ago

2.0.58

4 years ago

2.0.57

4 years ago

2.0.56

4 years ago

2.0.55

4 years ago

2.0.54

4 years ago

2.0.53

4 years ago

2.0.52

4 years ago

2.0.51

4 years ago

2.0.50

4 years ago

2.0.49

4 years ago

2.0.48

4 years ago

2.0.47

4 years ago

2.0.46

4 years ago

2.0.45

4 years ago

2.0.44

4 years ago

2.0.43

4 years ago

2.0.42

4 years ago

2.0.38

4 years ago

2.0.39

4 years ago

2.0.40

4 years ago

2.0.41

4 years ago

2.0.37

4 years ago

2.0.36

4 years ago

2.0.35

4 years ago

2.0.34

4 years ago

2.0.33

4 years ago

2.0.32

4 years ago

2.0.31

4 years ago

2.0.30

4 years ago

2.0.29

4 years ago

2.0.28

4 years ago

2.0.27

4 years ago

2.0.26

4 years ago

2.0.25

5 years ago

2.0.24

5 years ago

2.0.23

5 years ago

2.0.22

5 years ago

2.0.21

5 years ago

2.0.20

5 years ago

2.0.19

5 years ago

2.0.18

5 years ago

2.0.17

5 years ago

2.0.16

5 years ago

2.0.15

5 years ago

2.0.14

5 years ago

2.0.13

5 years ago

2.0.12

5 years ago

2.0.11

5 years ago

2.0.10

5 years ago

2.0.9

5 years ago

2.0.8

5 years ago

2.0.7

5 years ago

2.0.6

5 years ago

2.0.5

5 years ago

2.0.4

5 years ago

2.0.2

5 years ago

2.0.1

5 years ago

2.0.0

5 years ago

1.0.18

5 years ago

1.0.17

5 years ago

1.0.16

5 years ago

1.0.15

5 years ago

1.0.14

5 years ago

1.0.13

5 years ago

1.0.12

5 years ago

1.0.11

5 years ago

1.0.10

5 years ago

1.0.9

5 years ago

1.0.8

5 years ago

1.0.7

5 years ago

1.0.6

5 years ago

1.0.5

5 years ago

1.0.4

5 years ago

1.0.3

5 years ago

1.0.2

5 years ago

1.0.1

6 years ago

1.0.0

6 years ago