vcf-avatar-group | Vaadin

Vaadin Component Factory Avatar Group




Install vcf-avatar-group:

npm i @vaadin-component-factory/vcf-avatar-group --save


Once installed, import it in your application:

import '@vaadin-component-factory/vcf-avatar-group/vcf-avatar-group.js';

And use it:

const people = [
  { name: 'Dave' },
  { abbr: 'JD' },
  { name: 'Hannah' },
  { image: '', name: 'Jane' }
const avatarGroup = document.querySelector('vcf-avatar-group');
avatarGroup.items = people;

For each item, you can provide a name, abbr, or image. Please refer to vcf-avatar-item for more info.

You can set a max attribute to limit how many avatar items are shown. By default, the limit is 4.

Running demo

  1. Fork the vcf-avatar-group repository and clone it locally.

  2. Make sure you have npm installed.

  3. When in the vcf-avatar-group directory, run npm install to install dependencies.

  4. Run npm start to open the demo.


To contribute to the component, please read the guideline first.


Commercial Vaadin Add-on License version 3 (CVALv3). For license terms, see LICENSE.

Vaadin collects development time usage statistics to improve this product. For details and to opt-out, see


Link to this version
ImportedReleased 03 September 2019Other
Framework Support
Polymer 3.0+
Browser Independent
Install with
npm install @vaadin-component-factory/vcf-avatar-group"@1.0.1"
Run the above npm command in your project folder. If you have any issues installing, please contact the author.
Release notes - Version 1.0.1


  • @polymer/polymer#^3.0.0
  • @vaadin-component-factory/vcf-avatar-item#^0.2.1
  • @vaadin/vaadin-element-mixin#^2.1.3
  • @vaadin/vaadin-lumo-styles#^1.5.0
  • @vaadin/vaadin-themable-mixin#^1.4.4