Struct floating_ui_dom::AutoUpdateOptions

pub struct AutoUpdateOptions {
    pub ancestor_scroll: Option<bool>,
    pub ancestor_resize: Option<bool>,
    pub element_resize: Option<bool>,
    pub layout_shift: Option<bool>,
    pub animation_frame: Option<bool>,
}

Options for auto_update.

Fields

ancestor_scroll: Option<bool>

Whether to update the position when an overflow ancestor is scrolled.

Defaults to true.

ancestor_resize: Option<bool>

Whether to update the position when an overflow ancestor is resized. This uses the native resize event.

Defaults to true.

element_resize: Option<bool>

Whether to update the position when either the reference or floating elements resized. This uses a ResizeObserver.

Defaults to true.

layout_shift: Option<bool>

Whether to update the position when the reference relocated on the screen due to layout shift.

Defaults to true.

animation_frame: Option<bool>

Whether to update on every animation frame if necessary. Only use if you need to update the position in response to an animation using transforms.

Defaults to false.

Implementations

impl AutoUpdateOptions

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

Set ancestor_scroll option.

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

Set ancestor_resize option.

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

Set element_resize option.

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

Set layout_shift option.

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

Set animation_frame option.

Trait Implementations

impl Clone for AutoUpdateOptions

fn clone(&self) -> AutoUpdateOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AutoUpdateOptions

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

Formats the value using the given formatter.

impl Default for AutoUpdateOptions

fn default() -> AutoUpdateOptions

Returns the “default value” for a type.