Skip to main content

Avatar

Struct Avatar 

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

A circular profile avatar with initials and an optional presence dot.

ui.add(
    Avatar::new("AL")
        .size(AvatarSize::Large)
        .tone(AvatarTone::Sky)
        .presence(AvatarPresence::Online),
);

Implementations§

Source§

impl Avatar

Source

pub fn new(initials: impl Into<WidgetText>) -> Self

Create an avatar that displays the given initials. One or two uppercase glyphs read best ("AL", "MR", "??").

Source

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

Pick a size preset. Default: AvatarSize::Medium.

Source

pub fn tone(self, tone: AvatarTone) -> Self

Pin the tone explicitly. When unset, the tone is derived from the initials so the same name always gets the same colour.

Source

pub fn presence(self, presence: AvatarPresence) -> Self

Render a presence dot in the bottom-right corner. Default: none.

Source

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

Override the surface colour the avatar is painted against. Drives the inner border on the presence dot and the colour of the outer ring (when Avatar::ring is set). Defaults to the page background; pass theme.palette.card when placing an avatar inside a Card so the presence dot punches cleanly out of the card surface.

Source

pub fn ring(self, ring: bool) -> Self

Paint a 2 pt outer ring in the surface colour around the disc. Used by AvatarGroup to separate overlapping members; rarely needed for solo avatars. Default: off.

Trait Implementations§

Source§

impl Debug for Avatar

Source§

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

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

impl Widget for Avatar

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.