Struct ScrollIntoViewRequest 

pub struct ScrollIntoViewRequest {
    pub container: Option<WidgetId>,
    pub target: WidgetId,
    pub axis: ScrollAxis,
    pub alignment: ScrollAlignment,
    pub padding: [f32; 4],
    pub behavior: ScrollBehavior,
    pub if_needed: bool,
}

Request a post-layout scroll adjustment that reveals a target widget.

Reducers can emit this as a runtime effect when application state changes. The runtime resolves it after the next layout pass, when target and container rectangles are available, then mutates the scroll state and schedules another frame so paint, hit testing, and semantics see the new offset.

Example

ctx.effects.scroll_into_view(ScrollIntoViewRequest {
    container: Some(WidgetId::explicit("document.canvas.scroll")),
    target: WidgetId::explicit("document.page.3"),
    axis: ScrollAxis::Vertical,
    alignment: ScrollAlignment::Start,
    padding: [24.0, 24.0, 24.0, 24.0],
    behavior: ScrollBehavior::Instant,
    if_needed: false,
});

Fields

container: Option<WidgetId>

Explicit scroll container, or None to use the nearest matching scroll ancestor.

target: WidgetId

Descendant widget that should become visible.

axis: ScrollAxis

Axis to scroll.

alignment: ScrollAlignment

Alignment to use when computing the new offset.

padding: [f32; 4]

Reveal margin as [left, right, top, bottom].

behavior: ScrollBehavior

Whether to jump immediately or request smooth behavior.

if_needed: bool

If true, leave the offset unchanged when the target is already fully visible.

Trait Implementations

impl Clone for ScrollIntoViewRequest

fn clone(&self) -> ScrollIntoViewRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ScrollIntoViewRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ScrollIntoViewRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ScrollIntoViewRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ScrollIntoViewRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ScrollIntoViewRequest