rb-letter-avatar

Angular Letter Avatar Component

A forked version of the letter avatar component from ngu-utility. That library was forked due to the immediate need for a pull-request to be accepted.

This component is a letter avatar for a given string. Like Gmail or Google inbox text avatar i.e. First letter of the given data will be the avatar

Quick Start

npm install rb-letter-avatar --save

Simple Example

// app.module.ts
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';

import { RbLetterAvatarModule } from 'rb-letter-avatar'; // <-- import the module

@NgModule({
  declarations: [],
  imports: [
    RbLetterAvatarModule
  ],
  providers: [],
  bootstrap: [AppComponent]
})

<rb-letter-avatar [avatar-data]='title' ></rb-letter-avatar>

Option attributes

You can affect how the letter avatar operates with the following settings:

attribute name	default	description
avatar-custom-bg-color	No default value	Using this attribute set the custom color for avatar background.
avatar-dynamic	false	Set this attribute to true if dynamically avatar needs to be generated on data change.
avatar-rotate-degree	0	Set this attribute required degrees of rotation of the avatar.
avatar-alphabet-colors	default color set	Using this attribute set the custom colors for the alphabets only.
avatar-char-count	1	Specifies the number of letters to displayed. to generate combined letter avatar of first name and last name which are separated by space then set the value to '2'
avatar-data		Input data i.e. email, names...etc -OR- If image already exists for item, set image URL or image data
avatar-height	50px	set the height for the avatar
avatar-width	50px	set the width for the avatar
avatar-font-weight	400	set the font weight for the avatar
avatar-font-size	30px	set the font size for the letter
avatar-shape	square	set the shape for the avatar. set 'round' for rounded avatars
avatar-font-family	HelveticaNeue-Light,Helvetica Neue Light,Helvetica Neue,Helvetica, Arial,Lucida Grande, sans-serif	set the font Family of the avatar.
avatar-border	false	set the avatar border to 'true' for the white border to avatar.
avatar-custom-border	no default value	using this attribute set the custom style to avatar borders i.e "border:5px solid black".

preview snaps :

Building from source

Requires globally-installed node (tested with v8.x) & npm.

npm install
npm run build 

Contributions

For problems/suggestions please create an issue on Github.

Contributors

• @ryanburr

License

The MIT License

Copyright (c) 2018 Ryan M. Burr

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.