Struct Caption 

pub struct Caption {
    pub words: Vec<CaptionWord>,
    pub active_color: String,
    pub mode: CaptionStyle,
    pub max_width: Option<f32>,
    pub pill_color: Option<String>,
    pub style: CssStyle,
    pub timing: TimingConfig,
    pub timeline: Vec<TimelineStep>,
    pub stagger: Option<f32>,
}

Fields

words: Vec<CaptionWord>

active_color: String

mode: CaptionStyle

max_width: Option<f32>

pill_color: Option<String>

Pill background color behind the active word (word_pop / karaoke_pop modes). Defaults to black at 70% opacity.

style: CssStyle

timing: TimingConfig

timeline: Vec<TimelineStep>

stagger: Option<f32>

Trait Implementations

impl Animatable for Caption

fn animation_effects(&self) -> &[AnimationEffect]

fn timeline_steps(&self) -> &[TimelineStep]

Timed animation steps (timeline field): each step’s animations are resolved with delay += step.at. Empty by default.

impl Debug for Caption

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Caption

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for Caption

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Painter for Caption

fn paint_content( &self, canvas: &Canvas, layout: &BoxLayout, _props: &AnimatedProperties, ctx: &PaintCtx, )

Paint the component’s content into the canvas. The canvas is already translated to the content-box origin and clipped if overflow: hidden was set. Generic decorations (bg, border, shadow) are already painted by the engine.

fn intrinsic_size( &self, _available: AvailableSize, _ctx: &MeasureCtx, ) -> Option<(f32, f32)>

Optional intrinsic measurement for leaves like text, image, codeblock. Return None to let taffy compute the size from the CSS style alone. available mirrors taffy’s AvailableSpace.

impl Serialize for Caption

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Styled for Caption

fn style_config(&self) -> &CssStyle

impl StyledMut for Caption

fn style_config_mut(&mut self) -> &mut CssStyle

impl Timed for Caption

fn timing(&self) -> (Option<f64>, Option<f64>)