Shake

Shake — wraps a child and plays a damped horizontal oscillation whenever an external trigger Signal<u32> is bumped. The classic invalid-input feedback: wrong password, failed form validation, "no more results" wall.

Public functions

`Shake`

Returns	Function
	Constructors
`Self`	`new(trigger: Signal<u32>)`
	Builder methods
`Self`	`amplitude(px: f32)`
`Self`	`duration(duration: Duration)`
`Self`	`cycles(cycles: f32)`
`Self`	`child(widget: impl teksilo_core::IntoTeksiChild)`
`Self`	`child_opt(widget: Option<impl teksilo_core::IntoTeksiChild>)`

Detailed description

let shake_trigger = ctx.signal(0_u32);
ctx.add(
    Shake::new(shake_trigger.clone())
        .child(text_input_field),
);
// ...elsewhere, on validation failure:
shake_trigger.set(shake_trigger.get() + 1);

Layout semantics

Layout-stable: the wrapper reports the child's full natural size and clips the oscillating-out-of-bounds excursions on each side. Siblings don't reflow. The shake is a pure visual offset.

Reduced motion

Honours prefers-reduced-motion: the trigger no-ops. The widget is still focusable / interactive — the visual feedback just doesn't play. Pair with another a11y-friendly cue (red border, error text) when error state must be communicated.

API reference

📖 Full rustdoc API for this module

`pub struct Shake`

Import: use teksilo::widgets::Shake;

Wraps a child and plays a damped horizontal-oscillation shake each time the trigger signal value changes.

#![allow(unused)]
fn main() {
pub struct Shake { /* fields */ }
}

Methods

`pub fn new(trigger: Signal<u32>) -> Self`

Build a shake wrapper. Bumping trigger (any new value) plays one shake cycle.

`pub fn amplitude(mut self, px: f32) -> Self`

Peak horizontal offset in logical pixels. Default 8 px.

`pub fn duration(mut self, duration: Duration) -> Self`

Override the total shake duration. Default: MotionTokens::duration_slow (~300 ms) — the same one-shot "this should feel deliberate" budget dialogs use.

`pub fn cycles(mut self, cycles: f32) -> Self`

Number of full back-and-forth oscillations within duration. Default 4 cycles. Higher = jitterier; lower = wobblier.

Inline child widget (deferred insertion).

Attach widget when it is Some, and do nothing when it is None.

The conditional-child form. teksu!'s if without an else lowers to this, and it is what cond.then(|| w) is for in a builder chain. None adds no arena node, so nothing is laid out, painted, or published to the accessibility tree, and a stack applies no spacing around it.

Teksilo Documentation