Struct Badge 

pub struct Badge { /* private fields */ }

A badge for displaying a count, dot, or icon on an element.

Implementations

impl Badge

pub fn new() -> Self

Create a new badge.

pub fn dot(self) -> Self

Set to use [BadgeVariant::Dot] to show a dot.

pub fn count(self, count: usize) -> Self

Set to use [BadgeVariant::Number] to show a count.

If count is 0, the badge will be hidden.

pub fn icon(self, icon: impl Into<Icon>) -> Self

Set to use [BadgeVariant::Icon] to show an icon.

pub fn max(self, max: usize) -> Self

Set the maximum count to show (Only if [BadgeVariant::Number] is used).

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

Set the color (background) of the badge.

Trait Implementations

impl IntoElement for Badge

type Element = Component<Badge>

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 ParentElement for Badge

fn extend(&mut self, elements: impl IntoIterator<Item = AnyElement>)

Extend this element’s children with the given child elements.

fn child(self, child: impl IntoElement) -> Self

where Self: Sized,

Add a single child element to this element.

fn children(self, children: impl IntoIterator<Item = impl IntoElement>) -> Self

where Self: Sized,

Add multiple child elements to this element.

impl RenderOnce for Badge

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.

impl Sizable for Badge

fn with_size(self, size: impl Into<Size>) -> Self

Set the ui::Size of this element.

fn xsmall(self) -> Self

Set to Size::XSmall

fn small(self) -> Self

Set to Size::Small

fn large(self) -> Self

Set to Size::Large