Struct Model

pub struct Model {
    pub spinner: Spinner,
    pub style: Style,
    /* private fields */
}

Model represents the state and configuration of a spinner component.

The Model struct contains all the state needed to render and animate a spinner, including the animation frames, styling, current position, and unique identifier for message routing. This matches the Go bubbles spinner.Model for full compatibility.

Fields

• spinner - The Spinner configuration (frames and timing)
• style - Lipgloss Style for visual formatting
• frame - Current animation frame index (private)
• id - Unique instance identifier for message routing (private)
• tag - Message sequence number to prevent flooding (private)

Examples

use bubbletea_widgets::spinner::{new, with_spinner, DOT};
use lipgloss_extras::prelude::*;

let mut spinner = new(&[
    with_spinner(DOT.clone())
]);

// Use in a bubbletea-rs application
let view = spinner.view(); // Returns current frame as a styled string

Fields

spinner: Spinner

Spinner settings to use.

style: Style

Style sets the styling for the spinner.

Implementations

impl Model

pub fn new() -> Self

Creates a new spinner model with default settings.

Creates a spinner using the LINE animation with default styling. Each spinner instance gets a unique ID for message routing.

Examples

use bubbletea_widgets::spinner::Model;

let spinner = Model::new();
assert!(spinner.id() > 0);

pub fn new_with_options(opts: &[SpinnerOption]) -> Self

Creates a new spinner model with custom configuration options.

This function implements the options pattern to create a customized spinner. It matches Go’s New function exactly for API compatibility.

Arguments

• opts - Slice of SpinnerOption values to configure the spinner

Examples

use bubbletea_widgets::spinner::{Model, with_spinner, DOT};

let spinner = Model::new_with_options(&[with_spinner(DOT.clone())]);
assert_eq!(spinner.spinner.frames.len(), 8);

pub fn with_spinner(self, spinner: Spinner) -> Self

Sets the spinner animation configuration using builder pattern.

Arguments

• spinner - The Spinner configuration to use

Examples

use bubbletea_widgets::spinner::{Model, DOT};

let spinner = Model::new().with_spinner(DOT.clone());
assert_eq!(spinner.spinner.frames.len(), 8);

pub fn with_style(self, style: Style) -> Self

Sets the visual styling using builder pattern.

Arguments

• style - The lipgloss Style to apply

Examples

use bubbletea_widgets::spinner::Model;
use lipgloss_extras::prelude::*;

let spinner = Model::new()
    .with_style(Style::new().foreground(Color::from("blue")));

pub fn id(&self) -> i64

Returns the spinner’s unique identifier.

Each spinner instance has a unique ID used for message routing to ensure tick messages are delivered to the correct spinner. Matches Go’s ID() method for API compatibility.

Examples

use bubbletea_widgets::spinner::Model;

let spinner1 = Model::new();
let spinner2 = Model::new();
assert_ne!(spinner1.id(), spinner2.id());

pub fn tick_msg(&self) -> TickMsg

Creates a tick message to advance the spinner animation.

This method creates a TickMsg that can be sent through the bubbletea-rs message system to trigger the next animation frame. The message includes the current time, spinner ID, and tag for proper routing. Matches Go’s Tick() method for API compatibility.

Examples

use bubbletea_widgets::spinner::Model;

let spinner = Model::new();
let tick_msg = spinner.tick_msg();
assert_eq!(tick_msg.id, spinner.id());

impl Model

pub fn update(&mut self, msg: Msg) -> Option<Cmd>

Processes messages and updates the spinner state.

This is the standard bubbletea-rs update function that processes incoming messages. It handles TickMsg messages to advance the animation and ignores other message types. The function includes ID and tag validation to ensure proper message routing and prevent animation rate issues. Matches Go’s Update method exactly.

Arguments

• msg - The message to process

Returns

Returns Some(Cmd) to schedule the next tick, or None if the message was ignored.

Examples

use bubbletea_widgets::spinner::Model;

let mut spinner = Model::new();
let tick_msg = spinner.tick_msg();
let cmd = spinner.update(Box::new(tick_msg));
assert!(cmd.is_some()); // Should return next tick command

pub fn view(&self) -> String

Renders the current spinner frame as a styled string.

This method returns the current animation frame with styling applied. It’s the standard bubbletea-rs view function that produces the visual output. Matches Go’s View method exactly.

Returns

Returns the styled string representation of the current frame. Returns “(error)” if the frame index is invalid.

Examples

use bubbletea_widgets::spinner::{new, with_spinner, LINE};

let spinner = new(&[with_spinner(LINE.clone())]);
let output = spinner.view();
assert_eq!(output, "|"); // First frame of LINE spinner

Trait Implementations

impl Debug for Model

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

Formats the value using the given formatter.

impl Default for Model

fn default() -> Self

Returns the “default value” for a type.

impl Model for Model

fn init() -> (Self, Option<Cmd>)

Initialize the model with its initial state and optional startup command.

fn update(&mut self, msg: Msg) -> Option<Cmd>

Update the model in response to a received message.

fn view(&self) -> String

Render the current model state as a string for terminal display.