@vaadin/vaadin-avatar

<vaadin-avatar>

<vaadin-avatar> is a Web Component providing avatar displaying functionality.

Live Demo ↗ | API documentation ↗

<vaadin-avatar></vaadin-avatar>
<vaadin-avatar name="Jens Jansson"></vaadin-avatar>
<vaadin-avatar abbr="SK"></vaadin-avatar>
<vaadin-avatar-group max="2"></vaadin-avatar-group>
<script>
  document.querySelector('vaadin-avatar-group').items = [
    { name: 'Foo Bar', colorIndex: 1 },
    { colorIndex: 2 },
    { name: 'Foo Bar', colorIndex: 3 }
  ];
</script>

Installation

Install vaadin-avatar:

npm i @vaadin/vaadin-avatar --save

Once installed, import it in your application:

import '@vaadin/vaadin-avatar/vaadin-avatar.js';
import '@vaadin/vaadin-avatar/vaadin-avatar-group.js';

Getting started

Vaadin components use the Lumo theme by default.

To use the Material theme, import the correspondent file from the theme/material folder.

Entry points

• The components with the Lumo theme:

  theme/lumo/vaadin-avatar.js theme/lumo/vaadin-avatar-group.js

• The components with the Material theme:

  theme/material/vaadin-avatar.js theme/material/vaadin-avatar-group.js

• Alias for theme/lumo/vaadin-avatar.js theme/lumo/vaadin-avatar-group.js:

  vaadin-avatar.js vaadin-avatar-group.js

Contributing

Read the contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to test your changes to Vaadin components.

License

Apache License 2.0

Vaadin collects development time usage statistics to improve this product. For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.