@revolist/revo-ui-avatar NPM

Revo ui avatar

This is an avatar webcomponent to generate avatars through out all frameworks.

It displays an avatar image and if none it generate avatar based on name or initials if any provided. Works in any major framework or with no framework at all.

Stencil

Stencil is a compiler for building fast web apps using Web Components.

Stencil combines the best concepts of the most popular frontend frameworks into a compile-time rather than run-time tool. Stencil takes TypeScript, JSX, a tiny virtual DOM layer, efficient one-way data binding, an asynchronous rendering pipeline (similar to React Fiber), and lazy-loading out of the box, and generates 100% standards-based Web Components that run in any browser supporting the Custom Elements v1 spec.

Getting Started

npm i @revolist/revo-ui-avatar  --save

<revo-ui-avatar name="Dodge" is-light="false" background-color-opacity="0.5"></revo-ui-avatar>

Using this component

Script tag

Put a script tag similar to this <script src='https://unpkg.com/@revolist/revo-ui-avatar@latest/dist/revo-ui-avatar/revo-ui-avatar.js'></script> in the head of your index.html
Then you can use the element anywhere in your template, JSX, html etc

Node Modules

Put a script tag similar to this <script src='node_modules/@revolist/revo-ui-avatar/dist/revo-ui-avatar.js'></script> in the head of your index.html
Then you can use the element anywhere in your template, JSX, html etc

Webpack or Modules

import { applyPolyfills, defineCustomElements } from '@revolist/revo-ui-avatar/loader';

applyPolyfills if headed to IE11 support. // Bind the custom elements to the window object applyPolyfills().then(() => { defineCustomElements(); });

Framework webcomponent integration

Read more about per framework webcomponent integration here.

Revo-ui-avatar

Properties

Property	Attribute	Description	Type	Default
`backgroundColor`	`background-color`	The background color to use. If none and @randomColor = true, generate automatically.	`string`	`undefined`
`backgroundColorOpacity`	`background-color-opacity`	The background color opacity.	`number`	`undefined`
`circle`	`circle`	Is circle	`boolean`	`true`
`color`	`color`	The font color to use if no image is provided.	`string`	`'white'`
`initials`	`initials`	Force the displayed initials by overriding the computed ones.	`string`	`undefined`
`inline`	`inline`	Uses inline-flex instead of flex	`boolean`	`false`
`isLight`	`is-light`	Is main background is light	`boolean`	`true`
`letters`	`letters`	Letters count per avatar	`number`	`2`
`name`	`name`	The title that will be used to compute user initial.	`string`	`'?'`
`randomColor`	`random-color`	Generate random color	`boolean`	`true`
`size`	`size`	Rectangle size	`number`	`40`
`src`	`src`	Path to the avatar image to display.	`string`	`undefined`