Struct Spinner 

pub struct Spinner { /* private fields */ }

An animated one-cell spinner with an optional trailing label.

The reference consumer of the animation clock: it paints the [Frames] glyph for PaintCtx::now and requests its next repaint with PaintCtx::wake, so it animates only while presented and stops costing anything the moment it leaves the tree.

Implementations

impl Spinner

pub fn new() -> Self

Creates a bare spinner.

Examples found in repository

examples/gallery/anim.rs (line 34)

pub(crate) fn pane() -> Box<dyn Component> {
	let (_, mood_bg, mood_text) = MOODS[0];
	dom! {
		<col gap=1 pad="1 2">
			<row gap=2>
				<text bold fg="#f953c6..#43e97b" spin="4s">{"ANIMATION LAB"}</text>
				{Spinner::new()}
				<text dim>{"anim · ease · spin as plain props"}</text>
			</row>
			<box title="Easing race" border=round bc=muted pad="0 1">
				<col>
					for (id, ease) in BARS {
						<row gap=1>
							<text w=7 dim>{*ease}</text>
							<col id={*id} w=12% h=1 bg=accent anim="900ms" ease={*ease}/>
						</row>
					}
				</col>
			</box>
			<row gap=1>
				<box id=mood grow title="Mood" border=round bleed anim="450ms" bc=ok bg={mood_bg}>
					<text id="mood-text" fg=ok anim="450ms">{mood_text}</text>
				</box>
				<box id=hero grow title="Gradient morph" border=round bleed anim="900ms"
					ease="in-out" bg={PALETTES[0]} angle=25 spin="6s">
					<text bold>{"endpoints tween"}</text>
					<text dim>{"angle spins forever"}</text>
				</box>
			</row>
			<row gap=1>
				<col id=sidebar w=14 anim="500ms" ease="in-out" bg="#1b2735" pad="0 1">
					<text bold>{"sidebar"}</text>
					<text dim>{"w tweens"}</text>
				</col>
				<box id=drawer grow h=4 anim="600ms" ease="in-out" border=round bc=muted
					title="Drawer">
					<md>{"Height tweens through **layout wakes**: every row below shifts \
							smoothly.\n\n- retarget mid-flight: it resumes from the screen\n- \
							first paint never animates\n- settled components request no frames"}</md>
				</box>
			</row>
			<text dim>
				{"space race · m mood · g gradient · s sidebar · d drawer · a autoplay"}
			</text>
		</col>
	}
	.into_component()
}

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

Sets the text following the spinner glyph.

pub fn with(self, prop: Prop, value: impl Into<PropValue>) -> Self

Sets one spinner property.

Trait Implementations

impl Component for Spinner

fn props(&self) -> &Props

Component properties.

fn props_mut(&mut self) -> &mut Props

Mutable component properties.

fn slot(&self) -> Slot

Stable identity.

fn measure(&mut self, _ctx: &UiContext) -> (u16, u16)

Content width bounds, exclusive of this component’s chrome.

fn height(&mut self, _ctx: &UiContext, _width: u16) -> u16

Content height at the supplied content width.

fn paint(&mut self, pc: &mut PaintCtx<'_>, rect: Rect)

Paints content inside the supplied content rectangle.

fn set_text(&mut self, _ctx: &UiContext, text: Str) -> bool

Replaces text content where supported.

fn kind(&self) -> &'static str

Concrete implementation name for debug tooling; defaults to the type’s full path via std::any::type_name. The OMP_TUI_DEBUG tree dump trims it to the trailing path segment.

fn children(&self) -> &[Cached]

Every owned child, including embedded inactive subtrees.

fn children_mut(&mut self) -> &mut [Cached]

Every owned child, including embedded inactive subtrees.

fn place(&mut self, ctx: &UiContext, content: Rect)

Places children inside the supplied content rectangle.

fn paints_border(&self) -> bool

Whether Cached should paint this component’s border property as chrome.

fn paints_background(&self) -> bool

Whether Cached should paint this component’s background property across its rectangle. Components that own a partial background fill opt out and paint it themselves.

fn gradient_bounds(&self, content: Rect) -> Option<Rect>

A narrowed projection frame for two-stop fg=/bg= ramps, given the painted content rectangle. None projects across the full chrome; content-sized leaves (crate::components::Pre) return their authored extent so the ramp completes across the glyphs instead of the stretched layout width.

fn resize_tail(&mut self) -> Option<ResizeTail<'_>>

Opt-in viewport-tail provider for resize drags: children a drag frame may compose bottom-up, with the vertical gap between them. None — the default — renders this component whole.

fn validation_error(&self) -> Option<String>

A validation error blocking submission — an unmet required or match= constraint owned by this component’s internal records; None when valid. Component-level props are checked by the caller.

fn stretch_in_row(&self) -> bool

Whether a row should stretch this component across its cross axis.

fn focusable(&self) -> bool

Whether this component contributes its own slot to the focus ring. The default honors the focus flag, so any container can opt into keyboard navigation from markup.

fn enter(&mut self, forward: bool)

Positions internal selection when focus enters from either direction.

fn ring(&self, out: &mut Vec<Slot>)

Appends focusable slots in document order.

fn key(&mut self, ec: &mut EventCtx<'_>, key: Key) -> Flow

Handles a keyboard event.

fn mouse( &mut self, ec: &mut EventCtx<'_>, tag: HitTag, at: (u16, u16), rect: Rect, mouse: Mouse, ) -> Flow

Handles a mouse gesture over one of this component’s hit regions.

fn paste(&mut self, ec: &mut EventCtx<'_>, text: &str) -> Flow

Pastes text into this component: Flow::Consumed repaints, Flow::Event additionally surfaces a crate::UiEvent, and Flow::Skip leaves the paste unhandled.

fn paste_raw(&mut self, ec: &mut EventCtx<'_>, text: &str) -> Flow

Pastes text verbatim, bypassing any smart-paste interpretation the component applies in Component::paste (drop classification, large-paste collapse). Defaults to Component::paste for components without such interpretation.

fn value(&self, out: &mut Map<String, Value>)

Adds this component’s named value to an output object.

impl Default for Spinner

fn default() -> Self

Returns the “default value” for a type.