Struct TypeAnimationProps 

pub struct TypeAnimationProps {

    pub sequence: Vec<SequenceElement>,
    pub repeat: Repeat,
    pub wrapper: Wrapper,
    pub cursor: bool,
    pub speed: Speed,
    pub deletion_speed: Option<Speed>,
    pub omit_deletion_animation: bool,
    pub pre_render_first_string: bool,
    pub splitter: Option<StringSplitter>,
    pub class: Option<String>,
    pub style: Option<String>,
    pub aria_label: Option<String>,
    pub aria_hidden: Option<String>,
    pub role: Option<String>,
}

Props for TypeAnimation.

The component intentionally compares props as always equal, matching the React implementation’s permanent memoization/immutability behavior. If you need changed props to take effect, mount a new component instance with a different key.

Fields

sequence: Vec<SequenceElement>

Animation sequence: text, delays in milliseconds, and callbacks.

repeat: Repeat

Finite or infinite repeat behavior. Default: no repeats.

wrapper: Wrapper

Wrapper element. Default: Wrapper::Span.

cursor: bool

Show the default blinking cursor. Default: true.

speed: Speed

Typing speed. Default: Speed::Preset(40).

deletion_speed: Option<Speed>

Deletion speed. Default: same as speed.

omit_deletion_animation: bool

If true, deletions are instant and only writing is animated.

pre_render_first_string: bool

If true, initially render the first string in sequence without typing it. Default matches the React source: false.

splitter: Option<StringSplitter>

Optional custom splitter. Default: text.chars().

class: Option<String>

Class applied to the wrapper.

style: Option<String>

Inline style string applied to the wrapper.

aria_label: Option<String>

aria-label applied to the wrapper. When set, the animated visual text is rendered in an inner aria-hidden="true" span.

aria_hidden: Option<String>

aria-hidden applied to the wrapper.

role: Option<String>

ARIA role applied to the wrapper.

Implementations

impl TypeAnimationProps

pub fn builder() -> TypeAnimationPropsBuilder<((), (), (), (), (), (), (), (), (), (), (), (), (), ())>

Create a builder for building TypeAnimationProps. On the builder, call .sequence(...), .repeat(...)(optional), .wrapper(...)(optional), .cursor(...)(optional), .speed(...)(optional), .deletion_speed(...)(optional), .omit_deletion_animation(...)(optional), .pre_render_first_string(...)(optional), .splitter(...)(optional), .class(...)(optional), .style(...)(optional), .aria_label(...)(optional), .aria_hidden(...)(optional), .role(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of TypeAnimationProps.

Trait Implementations

impl Clone for TypeAnimationProps

fn clone(&self) -> TypeAnimationProps

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl PartialEq for TypeAnimationProps

fn eq(&self, _other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Properties for TypeAnimationProps

where Self: Clone,

type Builder = TypeAnimationPropsBuilder<((), (), (), (), (), (), (), (), (), (), (), (), (), ())>

The type of the builder for this component. Used to create “in-progress” versions of the props.

fn builder() -> Self::Builder

Create a builder for this component.

fn memoize(&mut self, new: &Self) -> bool

Make the old props equal to the new props. Return if the props were equal and should be memoized.

fn into_vcomponent<M>( self, render_fn: impl ComponentFunction<Self, M>, ) -> VComponent

where M: 'static,

Create a component from the props.