vue-profile-avatar

vue-profile-avatar

An minimalist avatar component for Vue 3.

• Colors decided by initial of username.
• You can customize all colors.

New Update with Custom Images!

Installation

npm install vue-profile-avatar

// or

yarn add vue-profile-avatar

Usage

ES6

import ProfileAvatar from 'vue-profile-avatar'

export default {
  ...
  components: {
    ProfileAvatar
  },
  ...
}

Then:

<ProfileAvatar username="Lorem Ipsum"></ProfileAvatar>

Configuration

Component props

username

• Type: String
• Description: Username required for getting background and text color.
• Required: true

size

• Type: String
• Description: Size of the avatar. Can be s, m, or l.
• Default: s
• Required: false

customSize

• Type: String
• Description: Custom size of the avatar. Example: 150px.
• Required: false

border

• Type: Boolean
• Description: false if you don't want border.
• Default: true
• Required: false

bgColor

• Type: ColorHex
• Description: Custom background color.
• Required: false

borderColor

• Type: ColorHex
• Description: Custom border color.
• Required: false

textColor

• Type: ColorHex
• Description: Custom text color.
• Required: false

colorType

• Type: String
• Description: Type of palette colors for your avatars. Can be normal, pastel, or brownie.
• Default: normal
• Required: false

image

• Type: String
• Description: Url of image.
• Required: false

Examples

Sizes

    <profile-avatar username="Thomas Bush" size="s" />
    <profile-avatar username="Alexis Wolf" size="m" />
    <profile-avatar username="Paul Daniels" size="l" />