Struct leptos_use::UseIntersectionObserverOptions

pub struct UseIntersectionObserverOptions<El, T>
where
    El: Into<ElementMaybeSignal<T, Element>>,
    T: Into<Element> + Clone + 'static,
{ /* private fields */ }

Options for use_intersection_observer_with_options.

Implementations

impl<El, T> UseIntersectionObserverOptions<El, T>

where El: Into<ElementMaybeSignal<T, Element>>, T: Into<Element> + Clone + 'static,

pub fn immediate(self, value: bool) -> Self

If true, the IntersectionObserver will be attached immediately. Otherwise it will only be attached after the returned resume closure is called. That is use_intersections_observer will be started “paused”.

pub fn root<New__El, New__T>( self, value: Option<New__El>, ) -> UseIntersectionObserverOptions<New__El, New__T>

where New__El: Into<ElementMaybeSignal<New__T, Element>>, New__T: Into<Element> + Clone + 'static,

A web_sys::Element or web_sys::Document object which is an ancestor of the intended target, whose bounding rectangle will be considered the viewport. Any part of the target not visible in the visible area of the root is not considered visible. Defaults to None (which means the root document will be used). Please note that setting this to a Some(document) may not be supported by all browsers. See Browser Compatibility

pub fn root_margin(self, value: impl Into<String>) -> Self

A string which specifies a set of offsets to add to the root’s bounding box when calculating intersections, effectively shrinking or growing the root for calculation purposes. The syntax is approximately the same as that for the CSS margin property; see The intersection root and root margin for more information on how the margin works and the syntax. The default is "0px".

pub fn thresholds(self, value: Vec<f64>) -> Self

A Vec of numbers between 0.0 and 1.0, specifying a ratio of intersection area to total bounding box area for the observed target. A value of 0.0 means that even a single visible pixel counts as the target being visible. 1.0 means that the entire target element is visible. See Thresholds for a more in-depth description of how thresholds are used. The default is a single threshold of [0.0].

Trait Implementations

impl Default for UseIntersectionObserverOptions<Element, Element>

fn default() -> Self

Returns the “default value” for a type.