https://github.com/aidewoode/vue-letter-avatar

A simple and elegant letter avatar component for vue.js
https://github.com/aidewoode/vue-letter-avatar

avatar letter-avatar vue vuejs2

Last synced: about 6 hours ago
JSON representation

A simple and elegant letter avatar component for vue.js

• Host: GitHub
• URL: https://github.com/aidewoode/vue-letter-avatar
• Owner: aidewoode
• License: mit
• Created: 2017-05-24T02:42:53.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-12-31T08:46:54.000Z (over 5 years ago)
• Last Synced: 2024-09-23T04:32:28.077Z (4 days ago)
• Topics: avatar, letter-avatar, vue, vuejs2
• Language: JavaScript
• Homepage:
• Size: 427 KB
• Stars: 65
• Watchers: 3
• Forks: 7
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# vue-letter-avatar

![demo](https://raw.github.com/aidewoode/vue-letter-avatar/master/test/demo.png)

## Introduction

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

## Install

```shell

$ yarn add vue-letter-avatar

```

or

```shell

$ npm install vue-letter-avatar

```

## Usage

```js

import VueLetterAvatar from 'vue-letter-avatar';

Vue.use(VueLetterAvatar);

```

Create avatar

```js

```

## 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

```shell

// 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

```