Struct CircularProgress

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

A non-focusable determinate circular progress ring with an optional label.

The ring is centered in the shortest resolved side and begins at 12 o’clock. With show_label(true) and no custom label, a rounded whole percentage is generated. A stored custom label is painted even after show_label(false); there is no builder that clears it.

§Examples

use ailloli_ui_widgets::controls::CircularProgress;
let progress = CircularProgress::new().value(0.75).show_label(true);
let _ = progress;

Implementations§

Source§

impl CircularProgress

Source

pub fn width(self, value: impl Into<Length>) -> Self

Sets preferred width from a logical-pixel or length value.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).width(24.0);
let _ = widget;
Source

pub fn height(self, value: impl Into<Length>) -> Self

Sets preferred height from a logical-pixel or length value.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).height(24.0);
let _ = widget;
Source

pub fn min_width(self, value: impl Into<Length>) -> Self

Sets the minimum width bound.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).min_width(12.0);
let _ = widget;
Source

pub fn max_width(self, value: impl Into<Length>) -> Self

Sets the maximum width bound.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).max_width(32.0);
let _ = widget;
Source

pub fn min_height(self, value: impl Into<Length>) -> Self

Sets the minimum height bound.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).min_height(12.0);
let _ = widget;
Source

pub fn max_height(self, value: impl Into<Length>) -> Self

Sets the maximum height bound.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).max_height(32.0);
let _ = widget;
Source

pub fn fill(self) -> Self

Sets both preferred axes to parent fill.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).fill();
let _ = widget;
Source

pub fn fill_width(self) -> Self

Sets preferred width to parent fill.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).fill_width();
let _ = widget;
Source

pub fn fill_height(self) -> Self

Sets preferred height to parent fill.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).fill_height();
let _ = widget;
Source

pub fn margin(self, value: f32) -> Self

Sets uniform outer margin in logical pixels.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).margin(4.0);
let _ = widget;
Source

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

Sets uniform inner padding in logical pixels.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).padding(4.0);
let _ = widget;
Source

pub fn flex_grow(self) -> Self

Sets flex-grow weight to one.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).flex_grow();
let _ = widget;
Source

pub fn flex_grow_by(self, value: f32) -> Self

Sets a dimensionless flex-grow weight.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).flex_grow_by(2.0);
let _ = widget;
Source

pub fn flex_shrink(self, value: f32) -> Self

Sets a dimensionless flex-shrink weight.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).flex_shrink(1.0);
let _ = widget;
Source

pub fn flex_basis(self, value: impl Into<Length>) -> Self

Sets the preferred main-axis flex basis.

§Examples
use ailloli_ui_core::IconId;
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).flex_basis(20.0);
let _ = widget;
Source

pub fn align_self(self, value: AlignItems) -> Self

Overrides cross-axis alignment for this flex item.

§Examples
use ailloli_ui_core::{style::AlignItems, IconId};
use ailloli_ui_widgets::primitives::Icon;
let widget = Icon::new(IconId::Close).align_self(AlignItems::Center);
let _ = widget;
Source§

impl CircularProgress

Source

pub fn new() -> Self

Creates an enabled, empty unlabeled ring over 0.0..=1.0.

§Examples
use ailloli_ui_widgets::controls::CircularProgress;
let progress = CircularProgress::new();
let _ = progress;
Source

pub fn value(self, value: impl Into<Binding<f32>>) -> Self

Sets a static or reactive value, visually clamped through the domain.

§Examples
use ailloli_ui_widgets::controls::CircularProgress;
let progress = CircularProgress::new().value(0.25);
let _ = progress;
Source

pub fn disabled(self, disabled: impl Into<Binding<bool>>) -> Self

Sets static or reactive disabled state.

Disabled state changes colors and label style; the ring is non-interactive in either state.

§Examples
use ailloli_ui_widgets::controls::CircularProgress;
let progress = CircularProgress::new().disabled(true);
let _ = progress;
Source

pub fn disabled_signal(self, disabled: Memo<bool>) -> Self

Convenience alias for Self::disabled with a reactive memo.

§Examples
use ailloli_ui_runtime::component::Memo;
use ailloli_ui_widgets::controls::CircularProgress;
let progress = CircularProgress::new().disabled_signal(Memo::new(|| false));
let _ = progress;
Source

pub fn range(self, min: f32, max: f32) -> Self

Replaces range bounds and immediately sanitizes them.

Reversed bounds swap, equal finite bounds try to expand max by 1.0, and any non-finite bound resets the domain to 0.0..=1.0.

§Examples
use ailloli_ui_widgets::controls::CircularProgress;
let progress = CircularProgress::new().range(0.0, 100.0).value(75.0);
let _ = progress;
Source

pub fn progress_spec(self, spec: ProgressSpec) -> Self

Replaces and sanitizes the complete numeric domain.

§Examples
use ailloli_ui_core::ProgressSpec;
use ailloli_ui_widgets::controls::CircularProgress;
let progress = CircularProgress::new().progress_spec(ProgressSpec::new(10.0, 20.0));
let _ = progress;
Source

pub fn progress_style(self, style: ProgressStyle) -> Self

Replaces complete resolved style without clamping its values.

§Examples
use ailloli_ui_core::Theme;
use ailloli_ui_widgets::controls::{CircularProgress, ProgressSize, ProgressStyle};
let style = ProgressStyle::from_theme(Theme::dark(), ProgressSize::Large);
let progress = CircularProgress::new().progress_style(style);
let _ = progress;
Source

pub fn progress_size(self, size: ProgressSize) -> Self

Replaces complete style with the default-theme built-in size.

§Examples
use ailloli_ui_widgets::controls::{CircularProgress, ProgressSize};
let progress = CircularProgress::new().progress_size(ProgressSize::Compact);
let _ = progress;
Source

pub fn show_label(self, show: bool) -> Self

Controls generated percentage visibility when no custom label exists.

A custom label remains visible regardless of show; call this before Self::label only to document intent, because label sets it true.

§Examples
use ailloli_ui_widgets::controls::CircularProgress;
let progress = CircularProgress::new().value(0.5).show_label(true);
let _ = progress; // generated label is "50%"
Source

pub fn label(self, label: impl Into<Binding<String>>) -> Self

Sets static or reactive custom center text and enables label painting.

Empty text remains a custom label and suppresses generated percentage. There is no builder to return to None.

§Examples
use ailloli_ui_widgets::controls::CircularProgress;
let progress = CircularProgress::new().value(3.0).range(0.0, 10.0).label("3 / 10");
let _ = progress;

Trait Implementations§

Source§

impl Default for CircularProgress

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<A: 'static> IntoView<A> for CircularProgress

Source§

fn into_view(self) -> View<A>

Consumes a builder/value and returns its declarative view tree. Read more
Source§

impl LayoutExt for CircularProgress

Source§

fn layout_mut(&mut self) -> &mut LayoutStyle

Returns the widget’s mutable declarative size/inset state. 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, A> FlexItemExt<A> for T
where T: IntoView<A>,

Source§

fn flex_grow(self) -> View<A>

Sets flex-grow weight to one. Read more
Source§

fn flex_grow_by(self, value: f32) -> View<A>

Sets the dimensionless flex-grow weight. Read more
Source§

fn flex_shrink(self, value: f32) -> View<A>

Sets the dimensionless flex-shrink weight. Read more
Source§

fn flex_basis(self, value: impl Into<Length>) -> View<A>

Sets the preferred main-axis flex basis. Read more
Source§

fn align_self(self, value: AlignItems) -> View<A>

Overrides the parent cross-axis alignment for this view. Read more
Source§

fn fill_width(self) -> View<A>

Marks width as parent-fill in the view size hint. Read more
Source§

fn fill_height(self) -> View<A>

Marks height as parent-fill in the view size hint. Read more
Source§

fn fill(self) -> View<A>

Marks both axes as parent-fill in the view size hint. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.

§

impl<T, A> IntoViewKeyExt<A> for T
where T: IntoView<A>,

§

fn key(self, key: impl Into<String>) -> View<A>

Converts self, assigns the owned key, and returns the view. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,