2.0.138 • Published 1 month ago

default-avatar-helper v2.0.138

Weekly downloads
108
License
MIT
Repository
github
Last release
1 month 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.138

1 month ago

2.0.137

3 months ago

2.0.136

5 months ago

2.0.135

6 months ago

2.0.134

6 months ago

2.0.133

7 months ago

2.0.132

7 months ago

2.0.131

7 months ago

2.0.130

7 months ago

2.0.129

8 months ago

2.0.128

8 months ago

2.0.127

8 months ago

2.0.126

9 months ago

2.0.125

9 months ago

2.0.124

9 months ago

2.0.123

10 months ago

2.0.122

10 months ago

2.0.121

11 months ago

2.0.120

11 months ago

2.0.119

11 months ago

2.0.118

12 months ago

2.0.117

12 months ago

2.0.116

12 months ago

2.0.115

1 year ago

2.0.114

1 year ago

2.0.113

1 year ago

2.0.112

1 year ago

2.0.111

1 year ago

2.0.110

1 year ago

2.0.109

1 year ago

2.0.108

1 year ago

2.0.107

1 year ago

2.0.106

1 year ago

2.0.105

1 year ago

2.0.104

1 year ago

2.0.103

1 year ago

2.0.102

1 year ago

2.0.101

1 year ago

2.0.100

1 year ago

2.0.99

1 year ago

2.0.97

1 year ago

2.0.98

1 year ago

2.0.95

2 years ago

2.0.96

1 year ago

2.0.94

2 years ago

2.0.93

2 years ago

2.0.92

2 years ago

2.0.88

2 years ago

2.0.89

2 years ago

2.0.86

2 years ago

2.0.87

2 years ago

2.0.84

2 years ago

2.0.85

2 years ago

2.0.83

2 years ago

2.0.91

2 years ago

2.0.90

2 years ago

2.0.82

2 years ago

2.0.81

2 years ago

2.0.80

2 years ago

2.0.79

2 years ago

2.0.77

2 years ago

2.0.78

2 years ago

2.0.75

2 years ago

2.0.76

2 years ago

2.0.73

2 years ago

2.0.74

2 years ago

2.0.71

2 years ago

2.0.72

2 years ago

2.0.70

2 years ago

2.0.68

2 years ago

2.0.69

2 years ago

2.0.66

2 years ago

2.0.67

2 years ago

2.0.65

2 years ago

2.0.64

2 years ago

2.0.62

2 years ago

2.0.63

2 years ago

2.0.61

3 years ago

2.0.59

3 years ago

2.0.60

3 years ago

2.0.58

3 years ago

2.0.57

3 years ago

2.0.56

3 years ago

2.0.55

3 years ago

2.0.54

3 years ago

2.0.53

3 years ago

2.0.52

3 years ago

2.0.51

3 years ago

2.0.50

3 years ago

2.0.49

3 years ago

2.0.48

3 years ago

2.0.47

3 years ago

2.0.46

3 years ago

2.0.45

3 years ago

2.0.44

3 years ago

2.0.43

3 years ago

2.0.42

3 years ago

2.0.38

3 years ago

2.0.39

3 years ago

2.0.40

3 years ago

2.0.41

3 years ago

2.0.37

3 years ago

2.0.36

3 years ago

2.0.35

3 years ago

2.0.34

3 years ago

2.0.33

3 years ago

2.0.32

3 years ago

2.0.31

3 years ago

2.0.30

3 years ago

2.0.29

3 years ago

2.0.28

3 years ago

2.0.27

3 years ago

2.0.26

3 years ago

2.0.25

3 years ago

2.0.24

3 years ago

2.0.23

3 years ago

2.0.22

4 years ago

2.0.21

4 years ago

2.0.20

4 years ago

2.0.19

4 years ago

2.0.18

4 years ago

2.0.17

4 years ago

2.0.16

4 years ago

2.0.15

4 years ago

2.0.14

4 years ago

2.0.13

4 years ago

2.0.12

4 years ago

2.0.11

4 years ago

2.0.10

4 years ago

2.0.9

4 years ago

2.0.8

4 years ago

2.0.7

4 years ago

2.0.6

4 years ago

2.0.5

4 years ago

2.0.4

4 years ago

2.0.2

4 years ago

2.0.1

4 years ago

2.0.0

4 years ago

1.0.18

4 years ago

1.0.17

4 years ago

1.0.16

4 years ago

1.0.15

4 years ago

1.0.14

4 years ago

1.0.13

4 years ago

1.0.12

4 years ago

1.0.11

4 years ago

1.0.10

4 years ago

1.0.9

4 years ago

1.0.8

4 years ago

1.0.7

4 years ago

1.0.6

4 years ago

1.0.5

4 years ago

1.0.4

4 years ago

1.0.3

4 years ago

1.0.2

4 years ago

1.0.1

5 years ago

1.0.0

5 years ago