Skip to main content

Badge

Struct Badge 

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

A notification circle painted in a corner of a widget.

Build one with Badge::new and attach it with Button::badge. The colour and corner are the two knobs you will reach for; everything else has a sane default.

Empty text (Badge::dot) renders a plain coloured dot.

Implementations§

Source§

impl Badge

Source

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

Create a badge showing text (e.g. a change count) in the top-right corner, filled with ThemeColors::error.

Source

pub fn dot() -> Self

Create a textless badge: a plain coloured dot.

Source

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

Circle fill. Defaults to the theme error colour.

Source

pub fn corner(self, corner: BadgeCorner) -> Self

Which corner of the widget the badge sits in. Default: top-right.

Source

pub fn text_color(self, text_color: Color32) -> Self

Colour of the badge text. Defaults to ThemeColors::bg so glyphs stay readable on chromatic fills.

Source

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

Smallest diameter the circle will take, in points.

The circle grows beyond this when the text needs the room. Default: 16.0. Lower it for Button::small.

Source

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

Distance between the circle and the widget corner, in points.

Negative values let the badge straddle the edge. Default: 2.0.

Source

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

Gap between the text and the circle edge, in points. Default: 3.0.

Source

pub fn outline(self, outline: impl Into<Stroke>) -> Self

Ring drawn around the circle, e.g. Stroke::new(1.5, theme.colors.bg) to lift the badge off a busy button fill.

Source

pub fn paint_at(&self, ui: &Ui, widget_rect: Rect)

Paint the badge on top of widget_rect (usually a widget’s response rect).

Public so any widget can host a badge without re-implementing the placement and text metrics.

Trait Implementations§

Source§

impl Clone for Badge

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Badge

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Badge

§

impl RefUnwindSafe for Badge

§

impl Send for Badge

§

impl Sync for Badge

§

impl Unpin for Badge

§

impl UnsafeUnpin for Badge

§

impl UnwindSafe for Badge

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,

Source§

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

Source§

fn simd_from(_simd: S, value: T) -> 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.