Skip to main content

Spinner

Struct Spinner 

Source
pub struct Spinner;
Expand description

An indeterminate loading indicator component.

Spinner displays an animated indicator to show ongoing activity. Unlike ProgressBar, it does not show specific progress - just that something is happening.

§Animation

The spinner advances one frame each time it receives a Tick message. Your application should send Tick messages at regular intervals (typically every 80-100ms) to create smooth animation.

§Styles

Several built-in styles are available:

  • Dots: Braille dots (⠋⠙⠹⠸⠼⠴⠦⠧⠇⠏) - default
  • Line: Classic ASCII (|/-\)
  • Circle: Quarter circles (◐◓◑◒)
  • Bounce: Bouncing dot (⠁⠂⠄⠂)
  • Custom: Your own character sequence

§Example

use envision::component::{Spinner, SpinnerMessage, SpinnerState, Component};

let mut state = SpinnerState::with_label("Processing...");

// In your app's update function, forward timer ticks:
Spinner::update(&mut state, SpinnerMessage::Tick);

// Stop when done:
Spinner::update(&mut state, SpinnerMessage::Stop);

Trait Implementations§

Source§

impl Component for Spinner

Source§

type State = SpinnerState

The component’s internal state type. Read more
Source§

type Message = SpinnerMessage

Messages this component can receive. Read more
Source§

type Output = ()

Messages this component can emit to its parent. Read more
Source§

fn init() -> Self::State

Initialize the component state. Read more
Source§

fn update(state: &mut Self::State, msg: Self::Message) -> Option<Self::Output>

Update component state based on a message. Read more
Source§

fn view( state: &Self::State, frame: &mut Frame<'_>, area: Rect, theme: &Theme, _ctx: &ViewContext, )

Render the component to the given area. Read more
Source§

fn traced_view( state: &Self::State, frame: &mut Frame<'_>, area: Rect, theme: &Theme, ctx: &ViewContext, )

Renders the component with optional tracing instrumentation. Read more
Source§

fn handle_event(state: &Self::State, event: &Event) -> Option<Self::Message>

Maps an input event to a component message. Read more
Source§

fn dispatch_event( state: &mut Self::State, event: &Event, ) -> Option<Self::Output>

Dispatches an event by mapping it to a message and updating state. Read more
Source§

impl Disableable for Spinner

Source§

fn is_disabled(state: &Self::State) -> bool

Returns true if this component is currently disabled.
Source§

fn set_disabled(state: &mut Self::State, disabled: bool)

Sets the disabled state of this component.
Source§

fn disable(state: &mut Self::State)

Disables this component. Read more
Source§

fn enable(state: &mut Self::State)

Enables this component. Read more
Source§

fn view_with_disabled( state: &mut Self::State, frame: &mut Frame<'_>, area: Rect, theme: &Theme, disabled: bool, )

Renders the component with the disabled state temporarily overridden. 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> 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> StateExt for T

Source§

fn updated(self, cmd: Command<impl Clone>) -> UpdateResult<Self, impl Clone>

Updates self and returns a command.
Source§

fn unchanged(self) -> UpdateResult<Self, ()>

Returns self with no command.
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.