Adorable Avatars component!

Automatic avatar generator for any web frontend! For Angular, React, Vue and HTML web components.

Based on the project https://github.com/itsthatguy/avatars-api-middleware this component has been created to be used directly on the frontend without the need to maintain a server.

How to use

HTML Example

Via npm:

npm install @adorable-avatar/core

Via CDN:

<script type="module" src="https://cdn.jsdelivr.net/npm/@adorable-avatar/core@0.0.2/dist/adorable-avatar/adorable-avatar.esm.js"></script>

Use it!

<adorable-avatar name="bipoza" shape="round"></adorable-avatar>

Angular Example

1. Install the package

$ npm install @adorable-avatar/angular --save

2. Import the module

import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';

import { AppComponent } from './app.component';
import { AdorableAvatarModule } from '@adorable-avatar/angular';

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    AdorableAvatarModule
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }

3. Use it!

<adorable-avatar name="bipoza" shape="round"></adorable-avatar>

React (WIP)

Install the package

npm install @adorable-avatar/react --save

Use it!

import AdorableAvatar from '@adorable-avatar/react'

function App() {
  return <AdorableAvatar name="bipoza" shape="round" />
}

Documentation (WIP)

Documentation

Contributing

Contributions are always welcome!

Authors

• @bipoza

License

MIT