2.0.140 • Published 2 years ago

default-avatar-helper v2.0.140

Weekly downloads
108
License
MIT
Repository
github
Last release
2 years 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

2 years ago

2.0.140

2 years ago

2.0.138

2 years ago

2.0.137

2 years ago

2.0.136

2 years ago

2.0.135

3 years ago

2.0.134

3 years ago

2.0.133

3 years ago

2.0.132

3 years ago

2.0.131

3 years ago

2.0.130

3 years ago

2.0.129

3 years ago

2.0.128

3 years ago

2.0.127

3 years ago

2.0.126

3 years ago

2.0.125

3 years ago

2.0.124

3 years ago

2.0.123

3 years ago

2.0.122

3 years ago

2.0.121

3 years ago

2.0.120

3 years ago

2.0.119

3 years ago

2.0.118

3 years ago

2.0.117

3 years ago

2.0.116

3 years ago

2.0.115

3 years ago

2.0.114

3 years ago

2.0.113

3 years ago

2.0.112

3 years ago

2.0.111

3 years ago

2.0.110

3 years ago

2.0.109

3 years ago

2.0.108

3 years ago

2.0.107

3 years ago

2.0.106

3 years ago

2.0.105

3 years ago

2.0.104

3 years ago

2.0.103

3 years ago

2.0.102

3 years ago

2.0.101

3 years ago

2.0.100

3 years ago

2.0.99

4 years ago

2.0.97

4 years ago

2.0.98

4 years ago

2.0.95

4 years ago

2.0.96

4 years ago

2.0.94

4 years ago

2.0.93

4 years ago

2.0.92

4 years ago

2.0.88

4 years ago

2.0.89

4 years ago

2.0.86

4 years ago

2.0.87

4 years ago

2.0.84

4 years ago

2.0.85

4 years ago

2.0.83

4 years ago

2.0.91

4 years ago

2.0.90

4 years ago

2.0.82

4 years ago

2.0.81

4 years ago

2.0.80

4 years ago

2.0.79

4 years ago

2.0.77

4 years ago

2.0.78

4 years ago

2.0.75

4 years ago

2.0.76

4 years ago

2.0.73

4 years ago

2.0.74

4 years ago

2.0.71

4 years ago

2.0.72

4 years ago

2.0.70

4 years ago

2.0.68

4 years ago

2.0.69

4 years ago

2.0.66

4 years ago

2.0.67

4 years ago

2.0.65

5 years ago

2.0.64

5 years ago

2.0.62

5 years ago

2.0.63

5 years ago

2.0.61

5 years ago

2.0.59

5 years ago

2.0.60

5 years ago

2.0.58

5 years ago

2.0.57

5 years ago

2.0.56

5 years ago

2.0.55

5 years ago

2.0.54

5 years ago

2.0.53

5 years ago

2.0.52

5 years ago

2.0.51

5 years ago

2.0.50

5 years ago

2.0.49

5 years ago

2.0.48

5 years ago

2.0.47

5 years ago

2.0.46

5 years ago

2.0.45

5 years ago

2.0.44

5 years ago

2.0.43

5 years ago

2.0.42

5 years ago

2.0.38

5 years ago

2.0.39

5 years ago

2.0.40

5 years ago

2.0.41

5 years ago

2.0.37

5 years ago

2.0.36

5 years ago

2.0.35

5 years ago

2.0.34

5 years ago

2.0.33

5 years ago

2.0.32

5 years ago

2.0.31

5 years ago

2.0.30

5 years ago

2.0.29

5 years ago

2.0.28

5 years ago

2.0.27

5 years ago

2.0.26

5 years ago

2.0.25

6 years ago

2.0.24

6 years ago

2.0.23

6 years ago

2.0.22

6 years ago

2.0.21

6 years ago

2.0.20

6 years ago

2.0.19

6 years ago

2.0.18

6 years ago

2.0.17

6 years ago

2.0.16

6 years ago

2.0.15

6 years ago

2.0.14

6 years ago

2.0.13

6 years ago

2.0.12

6 years ago

2.0.11

6 years ago

2.0.10

6 years ago

2.0.9

6 years ago

2.0.8

6 years ago

2.0.7

6 years ago

2.0.6

6 years ago

2.0.5

6 years ago

2.0.4

6 years ago

2.0.2

6 years ago

2.0.1

6 years ago

2.0.0

6 years ago

1.0.18

6 years ago

1.0.17

6 years ago

1.0.16

6 years ago

1.0.15

6 years ago

1.0.14

6 years ago

1.0.13

6 years ago

1.0.12

6 years ago

1.0.11

6 years ago

1.0.10

6 years ago

1.0.9

6 years ago

1.0.8

6 years ago

1.0.7

6 years ago

1.0.6

6 years ago

1.0.5

6 years ago

1.0.4

6 years ago

1.0.3

6 years ago

1.0.2

6 years ago

1.0.1

7 years ago

1.0.0

7 years ago