Struct FluxSpinner 

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

A compact braille rotation spinner.

Each character cell shows a full 8-dot braille glyph (⣿) with one dot missing; the gap rotates through all eight positions every 8 steps, creating an animated “spinning hole” effect.

Direction is controlled by Spin:

• Spin::Clockwise (default) — gap moves clockwise: ⣾ ⣷ ⣯ ⣟ ⡿ ⢿ ⣽ ⣻
• Spin::CounterClockwise — gap moves counter-clockwise: ⣾ ⣻ ⣽ ⢿ ⡿ ⣟ ⣯ ⣷

Scaling up via width / height adds a configurable per-cell phase offset (phase_step) so adjacent characters are staggered in time, producing a smooth diagonal wave across the spinner block. The wave direction follows the spin direction.

Default values

Field	Default
width	1
height	1
spin	Spin::Clockwise
color	Color::Cyan
ticks_per_step	1
phase_step	1
frames	FluxFrames::BRAILLE

Examples

use tui_spinner::{FluxFrames, FluxSpinner, Spin};

// Minimal 1×1 clockwise spinner
let s = FluxSpinner::new(42);

// 8-wide counter-clockwise wave
let wave = FluxSpinner::new(42)
    .width(8)
    .spin(Spin::CounterClockwise)
    .phase_step(1);

// Custom frame sequence
let line = FluxSpinner::new(42).frames(FluxFrames::LINE);

Implementations

impl<'a> FluxSpinner<'a>

pub fn new(tick: u64) -> Self

Creates a new FluxSpinner with default settings: 1 × 1, clockwise, cyan, 1 tick per frame, phase step 1.

Examples

use tui_spinner::FluxSpinner;

let s = FluxSpinner::new(0);

pub fn width(self, w: usize) -> Self

Sets the width in character columns (default 1).

Examples

use tui_spinner::FluxSpinner;

let wide = FluxSpinner::new(0).width(6);

pub fn height(self, h: usize) -> Self

Sets the height in character rows (default 1).

Examples

use tui_spinner::FluxSpinner;

let tall = FluxSpinner::new(0).height(3);

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

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

Also reverses the phase-wave direction for multi-cell spinners.

Examples

use tui_spinner::{FluxSpinner, Spin};

let cw  = FluxSpinner::new(0).spin(Spin::Clockwise);
let ccw = FluxSpinner::new(0).spin(Spin::CounterClockwise);

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

Sets the spinner colour (default Color::Cyan).

Examples

use ratatui::style::Color;
use tui_spinner::FluxSpinner;

let s = FluxSpinner::new(0).color(Color::White);

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

Sets how many ticks each frame is held (default 1; higher = slower).

Examples

use tui_spinner::FluxSpinner;

let slow = FluxSpinner::new(0).ticks_per_step(4);

pub const fn phase_step(self, step: u8) -> Self

Sets the frame offset between adjacent cells (default 1).

value	effect
0	All cells synchronised — a uniform pulsing block
1	Smooth diagonal wave (default)
2	Faster / wider wave
4	Anti-phase: neighbouring cells spin opposite (⣾/⡿)

The wave travels in the spin direction.

Examples

use tui_spinner::FluxSpinner;

let sync = FluxSpinner::new(0).width(4).phase_step(0);
let wave = FluxSpinner::new(0).width(4).phase_step(1);
let anti = FluxSpinner::new(0).width(4).phase_step(4);

pub fn frames(self, frames: &'static [char]) -> Self

Sets the frame sequence (default FluxFrames::BRAILLE).

Use one of the FluxFrames presets or supply any &'static [char] slice for a fully custom animation.

Examples

use tui_spinner::{FluxSpinner, FluxFrames};

let orbit  = FluxSpinner::new(0).frames(FluxFrames::ORBIT);
let line   = FluxSpinner::new(0).frames(FluxFrames::LINE);
let custom = FluxSpinner::new(0).frames(&['◐', '◓', '◑', '◒']);

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

Wraps the spinner in a Block.

Examples

use ratatui::widgets::Block;
use tui_spinner::FluxSpinner;

let s = FluxSpinner::new(0).block(Block::bordered().title("Indexing…"));

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) -> (usize, usize)

Returns the rendered size in character cells (cols, rows).

Examples

use tui_spinner::FluxSpinner;

assert_eq!(FluxSpinner::new(0).width(5).height(2).char_size(), (5, 2));

Trait Implementations

impl<'a> Clone for FluxSpinner<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for FluxSpinner<'a>

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

Formats the value using the given formatter.

impl Styled for FluxSpinner<'_>

type Item = FluxSpinner<'_>

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 &FluxSpinner<'_>

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 FluxSpinner<'_>

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.