Skip to main content

AvatarGroup

Struct AvatarGroup 

Source
pub struct AvatarGroup { /* private fields */ }
Expand description

A row of overlapping avatars with an optional +N overflow tile.

All members share the group’s size and surface so the punch-out ring reads cleanly. Pass an explicit surface when placing the group on a card or non-default background.

ui.add(
    AvatarGroup::new()
        .size(AvatarSize::Medium)
        .item(Avatar::new("AL").tone(AvatarTone::Sky))
        .item(Avatar::new("MR").tone(AvatarTone::Green))
        .item(Avatar::new("JK").tone(AvatarTone::Amber))
        .overflow(7),
);

Implementations§

Source§

impl AvatarGroup

Source

pub fn new() -> Self

Create an empty group at the default medium size.

Source

pub fn item(self, avatar: Avatar) -> Self

Append an avatar. The group’s size and surface override anything set on the passed avatar so members share a uniform diameter.

Source

pub fn overflow(self, n: usize) -> Self

Show a trailing +N neutral tile. Counts beyond the on-screen items.

Source

pub fn overlap(self, overlap: f32) -> Self

Pixels of overlap between adjacent avatars. Default: 10 pt.

Source

pub fn size(self, size: AvatarSize) -> Self

Pin the size for every member of the group. Default: AvatarSize::Medium.

Source

pub fn surface(self, color: Color32) -> Self

Override the surface colour. Drives the punch-out ring around each member and the inner border on any presence dots. Defaults to the page background.

Trait Implementations§

Source§

impl Debug for AvatarGroup

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for AvatarGroup

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Widget for AvatarGroup

Source§

fn ui(self, ui: &mut Ui) -> Response

Allocate space, interact, paint, and return a Response. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(value: T, _simd: S) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.