@vaadin/avatar-group
TypeScript icon, indicating that this package has built-in type declarations

24.3.9 • Public • Published

@vaadin/avatar-group

A web component for grouping multiple <vaadin-avatar> components together.

Documentation + Live Demo ↗

npm version Discord

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

Screenshot of vaadin-avatar-group

Installation

Install the component:

npm i @vaadin/avatar-group

Once installed, import the component in your application:

import '@vaadin/avatar-group';

Themes

Vaadin components come with two built-in themes, Lumo and Material. The main entrypoint of the package uses the Lumo theme.

To use the Material theme, import the component from the theme/material folder:

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

You can also import the Lumo version of the component explicitly:

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

Finally, you can import the un-themed component from the src folder to get a minimal starting point:

import '@vaadin/avatar-group/src/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 usage statistics at development time to improve this product. For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.

Package Sidebar

Install

npm i @vaadin/avatar-group

Weekly Downloads

19,714

Version

24.3.9

License

Apache-2.0

Unpacked Size

63.6 kB

Total Files

18

Last publish

Collaborators

  • web-padawan
  • diegocardoso
  • alvarezguille
  • platosha
  • jouni
  • manolo
  • yuriyyev
  • vaadin-owner
  • tomivirkki
  • artur-
  • sunzhewyq
  • sosa-vaadin