Package com.vaadin.flow.component.avatar

Class AvatarGroup

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.avatar.AvatarGroup
All Implemented Interfaces:
AttachNotifier, DetachNotifier, HasElement, HasSize, HasStyle, HasTheme, HasOverlayClassName, HasThemeVariant<AvatarGroupVariant>, Serializable
@Tag("vaadin-avatar-group") @NpmPackage(value="@vaadin/polymer-legacy-adapter",version="24.9.6") @NpmPackage(value="@vaadin/avatar-group",version="24.9.6") @JsModule("@vaadin/polymer-legacy-adapter/style-modules.js") @JsModule("@vaadin/avatar-group/src/vaadin-avatar-group.js") public class AvatarGroup extends Component implements HasOverlayClassName, HasStyle, HasSize, HasThemeVariant<AvatarGroupVariant>
Avatar Group is used to group multiple Avatars together. It can be used, for example, to show that there are multiple users viewing the same page or for listing members of a project.

You can specify the max number of items an Avatar Group should display. Items that overflow are grouped into a single Avatar that displays the overflow count. The name of each hidden item is shown on hover in a tooltip. Clicking the overflow item displays the overflowing avatars and names in a list.

Author:
Vaadin Ltd
See Also:

  • Constructor Details

    • AvatarGroup

      public AvatarGroup()
      Creates an empty avatar group component.

    • AvatarGroup

      public AvatarGroup(Collection<AvatarGroup.AvatarGroupItem> items)
      Creates an avatar group with the provided items to be displayed as avatars.
      Parameters:
      items - the items to be displayed

    • AvatarGroup

      public AvatarGroup(AvatarGroup.AvatarGroupItem... items)
      Creates an avatar group with the provided items to be displayed as avatars.
      Parameters:
      items - the items to be displayed

  • Method Details

    • setItems

      public void setItems(Collection<AvatarGroup.AvatarGroupItem> items)
      Sets the items that will be displayed as avatars.
      Parameters:
      items - the items to set

    • setItems

      public void setItems(AvatarGroup.AvatarGroupItem... items)
      Sets the items that will be displayed as avatars.
      Parameters:
      items - the items to set

    • add

      public void add(AvatarGroup.AvatarGroupItem... items)
      Adds the items to the list of displayed as avatars.
      Parameters:
      items - the items to add

    • remove

      public void remove(AvatarGroup.AvatarGroupItem... items)
      Removes the items from the list of displayed as avatars.
      Parameters:
      items - the items to remove

    • getItems

      public List<AvatarGroup.AvatarGroupItem> getItems()
      Gets the items that were set for the avatar group in an unmodifiable list.
      Returns:
      list of items

    • getI18n

      public AvatarGroup.AvatarGroupI18n getI18n()
      Gets the internationalization object previously set for this component.

      NOTE: Updating the instance that is returned from this method will not update the component if not set again using setI18n(AvatarGroupI18n)

      Returns:
      the i18n object or null if no i18n object has been set

    • setI18n

      public void setI18n(AvatarGroup.AvatarGroupI18n i18n)
      Sets the internationalization object for this component.
      Parameters:
      i18n - the i18n object, not null

    • setMaxItemsVisible

      public void setMaxItemsVisible(Integer max)
      Sets the the maximum number of avatars to display.

      By default, all the avatars are displayed. When max is set, the overflowing avatars are grouped into one avatar.

      Parameters:
      max - the maximum number of avatars, or null to remove the limit

    • getMaxItemsVisible

      public Integer getMaxItemsVisible()
      Gets the maximum number of avatars to display, or null if no limit has been set.
      Returns:
      the max number of avatars
      See Also: