Skip to content

aidewoode/vue-letter-avatar

Repository files navigation

vue-letter-avatar

demo

Introduction

An elegant and easy to use letter avatar component for vue.js 2.0+

Install

$ yarn add vue-letter-avatar

or

$ npm install vue-letter-avatar

Usage

import VueLetterAvatar from 'vue-letter-avatar';

Vue.use(VueLetterAvatar);

Create avatar

<vue-letter-avatar name='aide' size='40' :rounded=true />

Properties

Name Required Type Default Description
name true String the name of avatar
size false String 50 the size of avatar
rounded false Boolean false if is a rounded avatar

Development

// first clone the repo

$ git clone https://github.com/aidewoode/vue-letter-avatar.git

// install all dependencies

$ yarn install

// you can check the result on development server

$ yarn run server

// bundle the file

$ yarn run bundle