Struct Label 

pub struct Label { /* private fields */ }

Themed text label with an optional trailing (or leading) image.

Interactive by default: hover/click paints a background from LabelVisuals. Set Label::interactive to false for static text. Used as the selected-item face of ComboBox.

ui.add(Label::new("Hello", None));

Implementations

impl Label

pub fn new(text: impl Into<WidgetText>, image: Option<Image<'static>>) -> Self

Create a new Label with text and an optional image. By default the image is shown after the text

pub fn sections( parts: impl IntoIterator<Item = impl Into<RichText>>, image: Option<Image<'static>>, ) -> Self

Mixed-style wrapping paragraph from several RichText spans.

Unlike super::MultiLabel, the parts share one galley, so the sentence wraps across style changes. RichText::strong is a stronger color, not a heavier font weight.

Plain strings need .into() when mixed with RichText:

ui.add(
   Label::sections(
      [
         "Download icons from ".into(),
         RichText::new("app.com").strong(),
         " instead of a placeholder.".into(),
      ],
      None,
   )
   .wrap()
   .fill_width(true)
   .interactive(false),
);

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

Font size for every section.

Overrides per-span sizes from RichText::size.

pub fn visuals(self, visuals: LabelVisuals) -> Self

Set the visuals of the label

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

Set the space between the text and the image.

pub fn expand(self, expansion: Option<f32>) -> Self

Expand the bg color on hover

pub fn sense(self, sense: Sense) -> Self

Make the label respond to clicks and/or drags. This will also turn the selectable to false

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

Make the label interactive

True by default, If false on hover/click there will be no bg color

pub fn wrap_mode(self, wrap_mode: TextWrapMode) -> Self

Set the wrap mode for the text. Defaults to Ui::wrap_mode.

pub fn wrap(self) -> Self

Set Self::wrap_mode to TextWrapMode::Wrap.

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

Set whether the text can be selected with the mouse.

pub fn image_on_left(self) -> Self

Show the image first and then the text

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

Paint the selected fill from LabelVisuals even when not hovered.

pub fn fill_width(self, fill: bool) -> Self

Stretch the label to the available width (useful inside combo popups).

pub fn galley_and_size( &self, ui: &Ui, available_width_for_text: f32, ) -> (Arc<Galley>, Vec2)

Calculate the size needed by the widget.

available_width is the width available for the text part after accounting for image/spacing.

Trait Implementations

impl Clone for Label

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Widget for Label

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

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

fn boxed<'a>(self) -> Box<dyn FnOnce(&mut Ui) -> Response + 'a>

where Self: Sized + 'a,

Box this widget for dynamic dispatch.