Struct SquareSpinner 

pub struct SquareSpinner<'a> { /* private fields */ }

A rotating square braille-arc spinner.

A comet-like arc of braille dots travels around the perimeter of a square. Supports filled or empty center modes and clockwise/counter-clockwise directions.

Quick start

use ratatui::style::Color;
use tui_spinner::{Centre, SquareSpinner, Spin};

let spinner = SquareSpinner::new(42)
    .size(3)
    .arc_color(Color::Cyan)
    .dim_color(Color::DarkGray)
    .centre(Centre::Filled);

Implementations

impl<'a> SquareSpinner<'a>

pub fn new(tick: u64) -> Self

Creates a new SquareSpinner with defaults: size 2, clockwise spin, white arc, dark-gray dim, filled centre, 1 tick per step.

Examples

use tui_spinner::SquareSpinner;

let spinner = SquareSpinner::new(42);

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

Sets the arc thickness / square size (default: 2, range: 2–8).

Larger values produce a bigger square with a thicker arc.

Examples

use tui_spinner::SquareSpinner;

let large = SquareSpinner::new(0).size(4);

pub const fn spin(self, spin: Spin) -> Self

Sets the spin direction (default: Spin::Clockwise).

Examples

use tui_spinner::{SquareSpinner, Spin};

let ccw = SquareSpinner::new(0).spin(Spin::CounterClockwise);

pub const fn centre(self, centre: Centre) -> Self

Controls whether the centre is filled or empty (default: Centre::Filled).

Examples

use tui_spinner::{Centre, SquareSpinner};

let hollow = SquareSpinner::new(0).centre(Centre::Empty);

pub const fn arc_color(self, color: Color) -> Self

Sets the colour of the rotating bright arc (default: Color::White).

Examples

use ratatui::style::Color;
use tui_spinner::SquareSpinner;

let spinner = SquareSpinner::new(0).arc_color(Color::Cyan);

pub const fn dim_color(self, color: Color) -> Self

Sets the colour of the filled centre region (default: Color::DarkGray).

Only visible when Centre::Filled is active.

Examples

use ratatui::style::Color;
use tui_spinner::SquareSpinner;

let spinner = SquareSpinner::new(0).dim_color(Color::DarkGray);

pub fn ticks_per_step(self, n: u64) -> Self

Sets how many ticks each arc position is held (default: 1, higher = slower).

Examples

use tui_spinner::SquareSpinner;

let slow = SquareSpinner::new(0).ticks_per_step(3);

pub fn block(self, block: Block<'a>) -> Self

Wraps the spinner in a Block.

Examples

use ratatui::widgets::Block;
use tui_spinner::SquareSpinner;

let spinner = SquareSpinner::new(0).block(Block::bordered().title("Loading…"));

pub fn style<S: Into<Style>>(self, style: S) -> Self

Sets the base style applied to the widget area.

pub const fn alignment(self, alignment: Alignment) -> Self

Sets the horizontal alignment of the rendered output (default: left).

pub fn char_size(&self) -> (u16, u16)

Returns the exact rendered size in terminal characters (cols, rows).

Examples

use tui_spinner::SquareSpinner;

let (cols, rows) = SquareSpinner::new(0).size(2).char_size();
assert_eq!(cols, 4);
assert_eq!(rows, 3);

Trait Implementations

impl<'a> Clone for SquareSpinner<'a>

fn clone(&self) -> SquareSpinner<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for SquareSpinner<'a>

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

Formats the value using the given formatter.

impl Styled for SquareSpinner<'_>

type Item = SquareSpinner<'_>

fn style(&self) -> Style

Returns the style of the object.

fn set_style<S: Into<Style>>(self, style: S) -> Self

Sets the style of the object.

impl Widget for &SquareSpinner<'_>

fn render(self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.

impl Widget for SquareSpinner<'_>

fn render(self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.