A universal avatar component for Angular 2+ applications that fetch / generates avatar based on the informations you have about the user. The component has a fallback system that if for example an invalid Facebook ID is used it will try google ID and so on.
You can use this component whether you have a single source or a multiple avatar sources. In this case the fallback system will fetch the first valid avatar.
Moreover, the component can shows name initials or simple value as avatar.
Supported avatar sources:
- Skype
- Gravatar
- Custom image
- name initials
- value
The fallback system uses the same order as the above source list, Facebook has the highest priority, if it fails, google source will be used, and so on.
Install avatar component using NPM::
$ npm install ngx-avatar --saveOr download as ZIP.
- Import AvatarModule :
Once you have installed ngx-avatar, you can import it in your AppModule:
import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
// Import your AvatarModule
import { AvatarModule } from 'ngx-avatar';
@NgModule({
declarations: [
AppComponent
],
imports: [
BrowserModule,
// Specify AvatarModule as an import
AvatarModule
],
providers: [],
bootstrap: [AppComponent]
})
export class AppModule { }- Start using it:
Once the AvatarModule is imported, you can start using the component in your Angular application:
<ngx-avatar></ngx-avatar><ngx-avatar facebookId="1508319875"></ngx-avatar>
<ngx-avatar googleId="1508319875"></ngx-avatar>
<ngx-avatar twitterId="1508319875"></ngx-avatar>
<ngx-avatar name="Jhon Doe"></ngx-avatar>
<ngx-avatar value="75%"></ngx-avatar>
<ngx-avatar source="facebook" skypeId="skype" googleId="google" name="Haithem Mosbahi" custom="assets/custom.jpg" value="28%" initials facebookId="100008343750912" twitterId="twitter" gravatarId="gravatar" size="100" [round]="true"></ngx-avatar>| Attribute | Type | Default | Description |
|---|---|---|---|
facebook-id |
string | ||
twitter-id |
string | ||
google-id |
string | ||
skype-id |
string | ||
name |
string | Will be used to generate avatar based on the initials of the person | |
value |
string | Show a value as avatar | |
color |
string | random | Give the background a fixed color with a hex like for example #FF0000 |
fgColor |
string | #FFF | Used in combination with name and value. Give the text a fixed color with a hex like for example #FF0000 |
size |
number | 50 | Size of the avatar |
textSizeRatio |
number | 3 | For text based avatars the size of the text as a fragment of size (size / textSizeRatio) |
round |
bool | true | Round the avatar corners |
src |
string | Fallback image to use | |
style |
object | Style that will be applied on the root element |
To generate all *.js, *.d.ts and *.metadata.json files:
$ npm run buildTo lint all *.ts files:
$ npm run lintMIT © Haithem Mosbahi