Skip to main content

TextFxConfig

Struct TextFxConfig 

Source
pub struct TextFxConfig {
Show 23 fields pub id: String, pub text: String, pub effect: TextFxEffect, pub timing: TextFxTiming, pub split: TextSplit, pub reduced_motion: ReducedMotion, pub performance_profile: TextFxPerformanceProfile, pub gpu_budget: TextFxGpuBudget, pub render_preference: TextFxRenderPreference, pub layout_reserve: TextFxLayoutReserve, pub trigger: TextFxTrigger, pub direction: TextFxDirection, pub playback: TextFxPlayback, pub intensity: f32, pub palette: Vec<String>, pub charset: String, pub cursor: bool, pub from: Option<f64>, pub to: Option<f64>, pub fx: Option<String>, pub lifecycle: TextFxLifecycle, pub marks: Vec<TokenMark>, pub choreography: Vec<TextFxChoreography>,
}

Fields§

§id: String§text: String§effect: TextFxEffect§timing: TextFxTiming§split: TextSplit§reduced_motion: ReducedMotion§performance_profile: TextFxPerformanceProfile§gpu_budget: TextFxGpuBudget§render_preference: TextFxRenderPreference§layout_reserve: TextFxLayoutReserve§trigger: TextFxTrigger§direction: TextFxDirection§playback: TextFxPlayback§intensity: f32§palette: Vec<String>§charset: String§cursor: bool§from: Option<f64>§to: Option<f64>§fx: Option<String>§lifecycle: TextFxLifecycle§marks: Vec<TokenMark>§choreography: Vec<TextFxChoreography>

Implementations§

Source§

impl TextFxConfig

Source

pub fn new(id: impl Into<String>, text: impl Into<String>) -> TextFxConfig

Source

pub fn with_text(self, text: impl Into<String>) -> TextFxConfig

Source

pub fn content(self, text: impl Into<String>) -> TextFxConfig

Source

pub fn from_fx( id: impl Into<String>, text: impl Into<String>, fx: impl Into<String>, ) -> Result<TextFxConfig, TextFxParseError>

Source

pub fn profile( id: impl Into<String>, text: impl Into<String>, profile: TextFxProfile, ) -> TextFxConfig

Source

pub fn with_profile(self, profile: TextFxProfile) -> TextFxConfig

Source

pub fn profile_preset(self, profile: TextFxProfile) -> TextFxConfig

Source

pub fn with_effect(self, effect: TextFxEffect) -> TextFxConfig

Source

pub fn effect(self, effect: TextFxEffect) -> TextFxConfig

Source

pub fn fade(self) -> TextFxConfig

Source

pub fn slide(self) -> TextFxConfig

Source

pub fn blur(self) -> TextFxConfig

Source

pub fn scale(self) -> TextFxConfig

Source

pub fn typewriter(self) -> TextFxConfig

Source

pub fn scramble(self) -> TextFxConfig

Source

pub fn staggered(self) -> TextFxConfig

Source

pub fn with_timing(self, timing: TextFxTiming) -> TextFxConfig

Source

pub fn timing(self, timing: TextFxTiming) -> TextFxConfig

Source

pub fn with_duration_ms(self, duration_ms: u32) -> TextFxConfig

Source

pub fn dur_ms(self, duration_ms: u32) -> TextFxConfig

Source

pub fn dur(self, duration: Duration) -> TextFxConfig

Source

pub fn with_delay_ms(self, delay_ms: u32) -> TextFxConfig

Source

pub fn delay_ms(self, delay_ms: u32) -> TextFxConfig

Source

pub fn with_speed_ms(self, speed_ms: u32) -> TextFxConfig

Source

pub fn speed_ms(self, speed_ms: u32) -> TextFxConfig

Source

pub fn with_stagger_ms(self, stagger_ms: u32) -> TextFxConfig

Source

pub fn stagger_ms(self, stagger_ms: u32) -> TextFxConfig

Source

pub fn stagger(self, stagger: Duration) -> TextFxConfig

Source

pub fn with_enter_effect(self, effect: TextFxEffect) -> TextFxConfig

Source

pub fn enter(self, effect: TextFxEffect) -> TextFxConfig

Source

pub fn with_enter_delay_ms(self, delay_ms: u32) -> TextFxConfig

Source

pub fn enter_delay_ms(self, delay_ms: u32) -> TextFxConfig

Source

pub fn with_enter_duration_ms(self, duration_ms: u32) -> TextFxConfig

Source

pub fn enter_dur_ms(self, duration_ms: u32) -> TextFxConfig

Source

pub fn with_enter_stagger_ms(self, stagger_ms: u32) -> TextFxConfig

Source

pub fn enter_stagger_ms(self, stagger_ms: u32) -> TextFxConfig

Source

pub fn with_exit_effect(self, effect: TextFxEffect) -> TextFxConfig

Source

pub fn exit(self, effect: TextFxEffect) -> TextFxConfig

Source

pub fn with_exit_delay_ms(self, delay_ms: u32) -> TextFxConfig

Source

pub fn exit_delay_ms(self, delay_ms: u32) -> TextFxConfig

Source

pub fn with_exit_duration_ms(self, duration_ms: u32) -> TextFxConfig

Source

pub fn exit_dur_ms(self, duration_ms: u32) -> TextFxConfig

Source

pub fn with_exit_stagger_ms(self, stagger_ms: u32) -> TextFxConfig

Source

pub fn exit_stagger_ms(self, stagger_ms: u32) -> TextFxConfig

Source

pub fn with_exit_reverse_of_enter(self) -> TextFxConfig

Source

pub fn exit_reverse(self) -> TextFxConfig

Source

pub fn with_easing(self, easing: TextFxEasing) -> TextFxConfig

Source

pub fn ease(self, easing: TextFxEasing) -> TextFxConfig

Source

pub fn with_split(self, split: TextSplit) -> TextFxConfig

Source

pub fn split(self, split: TextSplit) -> TextFxConfig

Source

pub fn split_lines(self) -> TextFxConfig

Source

pub fn with_performance_profile( self, profile: TextFxPerformanceProfile, ) -> TextFxConfig

Source

pub fn perf(self, profile: TextFxPerformanceProfile) -> TextFxConfig

Source

pub fn with_gpu_budget(self, budget: TextFxGpuBudget) -> TextFxConfig

Source

pub fn gpu(self, budget: TextFxGpuBudget) -> TextFxConfig

Source

pub fn with_render_preference( self, preference: TextFxRenderPreference, ) -> TextFxConfig

Source

pub fn render(self, preference: TextFxRenderPreference) -> TextFxConfig

Source

pub fn with_layout_reserve(self, reserve: TextFxLayoutReserve) -> TextFxConfig

Source

pub fn reserve(self, reserve: TextFxLayoutReserve) -> TextFxConfig

Source

pub fn css_first(self) -> TextFxConfig

Source

pub fn balanced(self) -> TextFxConfig

Source

pub fn visual_exact(self) -> TextFxConfig

Source

pub fn gpu_auto(self) -> TextFxConfig

Source

pub fn gpu_low_power(self) -> TextFxConfig

Source

pub fn gpu_normal(self) -> TextFxConfig

Source

pub fn gpu_exact(self) -> TextFxConfig

Source

pub fn workertown_render(self) -> TextFxConfig

Source

pub fn layout_reserve_off(self) -> TextFxConfig

Source

pub fn layout_reserve_auto(self) -> TextFxConfig

Source

pub fn layout_reserve_exact(self) -> TextFxConfig

Source

pub fn with_trigger(self, trigger: TextFxTrigger) -> TextFxConfig

Source

pub fn trigger(self, trigger: TextFxTrigger) -> TextFxConfig

Source

pub fn on_hover(self) -> TextFxConfig

Source

pub fn on_click(self) -> TextFxConfig

Source

pub fn split_words(self) -> TextFxConfig

Source

pub fn split_chars(self) -> TextFxConfig

Source

pub fn loop_count(self, count: u16) -> TextFxConfig

Source

pub fn loop_infinite(self) -> TextFxConfig

Source

pub fn reverse(self) -> TextFxConfig

Source

pub fn alternate(self) -> TextFxConfig

Source

pub fn yoyo(self) -> TextFxConfig

Source

pub fn target(self, target: TokenTarget, action: TokenAction) -> TextFxConfig

Source

pub fn add_target(&mut self, target: TokenTarget, action: TokenAction)

Source

pub fn with_reduced_motion(self, reduced_motion: ReducedMotion) -> TextFxConfig

Source

pub fn reduced(self, reduced_motion: ReducedMotion) -> TextFxConfig

Source

pub fn with_direction(self, direction: TextFxDirection) -> TextFxConfig

Source

pub fn direction(self, direction: TextFxDirection) -> TextFxConfig

Source

pub fn with_palette( self, palette: impl IntoIterator<Item = impl Into<String>>, ) -> TextFxConfig

Source

pub fn palette( self, palette: impl IntoIterator<Item = impl Into<String>>, ) -> TextFxConfig

Source

pub fn with_numbers(self, from: f64, to: f64) -> TextFxConfig

Source

pub fn nums(self, from: f64, to: f64) -> TextFxConfig

Source

pub fn with_cursor(self, cursor: bool) -> TextFxConfig

Source

pub fn cursor(self, cursor: bool) -> TextFxConfig

Source

pub fn with_charset(self, charset: impl Into<String>) -> TextFxConfig

Source

pub fn charset(self, charset: impl Into<String>) -> TextFxConfig

Source

pub fn to_json(&self) -> Result<String, Error>

Source

pub fn to_compact_json(&self) -> Result<String, Error>

Source

pub fn data_attr(&self) -> Result<String, Error>

Source

pub fn locale_data_attr(&self) -> Result<String, Error>

Source

pub fn is_css_first(&self) -> bool

Source

pub fn is_css_first_split(&self) -> bool

Source

pub fn is_css_first_renderable(&self) -> bool

Source

pub fn css_first_class(&self) -> Option<String>

Source

pub fn css_first_state_attrs(&self) -> Option<String>

Source

pub fn reserves_layout(&self) -> bool

Source

pub fn layout_reserve_attr(&self) -> Option<String>

Source

pub fn layout_fallback_lines(&self) -> usize

Source

pub fn live_contrast_mode(&self) -> Option<TextFxLiveContrast>

Source

pub fn live_contrast_attr(&self) -> Option<String>

Source

pub fn requires_workertown_render(&self) -> bool

Source

pub fn trigger_attr(&self) -> Option<&'static str>

Source

pub fn resume_trigger_attr(&self) -> Option<String>

Source

pub fn html_attrs(&self) -> Result<String, Error>

Source

pub fn static_html( &self, tag: impl AsRef<str>, extra_attrs: impl AsRef<str>, ) -> Result<String, Error>

Source

pub fn with_route_profile(self, profile: TextFxPresetProfile) -> TextFxConfig

Source

pub fn route_profile(self, profile: TextFxPresetProfile) -> TextFxConfig

Source

pub fn cache_key(&self, route: Option<&str>) -> String

Source

pub fn diagnostics( &self, verbosity: TextFxDiagnosticVerbosity, ) -> TextFxDiagnosticReport

Source

pub fn explain(&self, policy: &TextFxRoutePolicy) -> TextFxExplainReport

Trait Implementations§

Source§

impl Clone for TextFxConfig

Source§

fn clone(&self) -> TextFxConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TextFxConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TextFxConfig

Source§

fn default() -> TextFxConfig

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for TextFxConfig

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<TextFxConfig, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for TextFxConfig

Source§

fn eq(&self, other: &TextFxConfig) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for TextFxConfig

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for TextFxConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DependencyElement for T
where T: 'static + PartialEq + Clone,

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> InitializeFromFunction<T> for T

Source§

fn initialize_from_function(f: fn() -> T) -> T

Create an instance of this type from an initialization function
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<Ret> SpawnIfAsync<(), Ret> for Ret

Source§

fn spawn(self) -> Ret

Spawn the value into the dioxus runtime if it is an async block
Source§

impl<T, O> SuperFrom<T> for O
where O: From<T>,

Source§

fn super_from(input: T) -> O

Convert from a type to another type.
Source§

impl<T, O, M> SuperInto<O, M> for T
where O: SuperFrom<T, M>,

Source§

fn super_into(self) -> O

Convert from a type to another type.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more