vaadin-component-factory / vcf-avatar-group

Vaadin Component Factory Avatar Group

<vcf-avatar-group>

Demo

https://vcf-avatar-group.netlify.com/

Installation

Install vcf-avatar-group:

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

Usage

Once installed, import it in your application:

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

And use it:

<vcf-avatar-group></vcf-avatar-group>

const people = [
  { name: 'Dave' },
  { abbr: 'JD' },
  { name: 'Hannah' },
  { image: 'https://randomuser.me/api/portraits/women/5.jpg', 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.

Contributing

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

License

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 https://github.com/vaadin/vaadin-usage-statistics.

vcf-avatar-group's Issues

Depending on this breaks the app

This component depends on a pre-release of vcf-avatar-item and if used with the latest 1.0.4 it breaks the loading of the app with this client error:

Uncaught DOMException: Failed to execute 'define' on 'CustomElementRegistry': the name "vcf-avatar-item" has already been used with this registry

vcf-avatar-group

First version implementation.