Struct Avatar 

pub struct Avatar { /* private fields */ }

An element that renders a user avatar with customizable appearance options.

Examples

use ui::Avatar;

Avatar::new("path/to/image.png")
    .grayscale(true)
    .border_color(gpui::red());

Implementations

impl Avatar

pub fn new(src: impl Into<ImageSource>) -> Self

Creates a new avatar element with the specified image source.

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

Applies a grayscale filter to the avatar image.

Examples

use ui::Avatar;

let avatar = Avatar::new("path/to/image.png").grayscale(true);

pub fn border_color(self, color: impl Into<Hsla>) -> Self

Sets the border color of the avatar.

This might be used to match the border to the background color of the parent element to create the illusion of cropping another shape underneath (for example in face piles.)

pub fn size<L: Into<AbsoluteLength>>(self, size: impl Into<Option<L>>) -> Self

Size overrides the avatar size. By default they are 1rem.

pub fn indicator<E: IntoElement>(self, indicator: impl Into<Option<E>>) -> Self

Sets the current indicator to be displayed on the avatar, if any.

Trait Implementations

impl Component for Avatar

fn scope() -> ComponentScope

Returns the scope of the component.

fn description() -> Option<&'static str>

An optional description of the component.

fn preview(_window: &mut Window, cx: &mut App) -> Option<AnyElement>

The component’s preview.

fn id() -> ComponentId

The component’s unique identifier.

fn status() -> ComponentStatus

The ready status of this component.

fn name() -> &'static str

The name of the component.

fn sort_name() -> &'static str

Returns a name that the component should be sorted by.

impl Documented for Avatar

const DOCS: &'static str = "An element that renders a user avatar with customizable appearance options.\n\n# Examples\n\n```\nuse ui::Avatar;\n\nAvatar::new(\"path/to/image.png\")\n.grayscale(true)\n.border_color(gpui::red());\n```"

The static doc comments on this type.

impl IntoElement for Avatar

type Element = Component<Avatar>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl RenderOnce for Avatar

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to Render::render() method which takes a mutable reference.