https://github.com/revolist/revo-ui-avatar
Light user avatars generator based on name or image.
https://github.com/revolist/revo-ui-avatar
ava avatar avatar-generator ui-components webcomponent
Last synced: 17 days ago
JSON representation
Light user avatars generator based on name or image.
- Host: GitHub
- URL: https://github.com/revolist/revo-ui-avatar
- Owner: revolist
- License: mit
- Created: 2020-10-16T12:23:59.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2020-10-19T09:10:33.000Z (almost 5 years ago)
- Last Synced: 2025-09-01T10:37:29.098Z (about 1 month ago)
- Topics: ava, avatar, avatar-generator, ui-components, webcomponent
- Language: TypeScript
- Homepage: https://jsfiddle.net/m2a2x/p237fom9/11/
- Size: 59.6 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
[Demo sample](https://jsfiddle.net/m2a2x/p237fom9/11/)
# 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
```bash
npm i @revolist/revo-ui-avatar --save
```
```bash
```
## Using this component
### Script tag
- Put a script tag similar to this `` 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 `` 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](https://stenciljs.com/docs/overview).
# 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` |
----------------------------------------------
*Built with [StencilJS](https://stenciljs.com/)*