Struct UseFloatingOptions

pub struct UseFloatingOptions {
    pub open: MaybeProp<bool>,
    pub placement: MaybeProp<Placement>,
    pub strategy: MaybeProp<Strategy>,
    pub middleware: MaybeProp<WrappedMiddleware>,
    pub transform: MaybeProp<bool>,
    pub while_elements_mounted: MaybeProp<SendWrapper<Rc<WhileElementsMountedFn>>>,
}

Options for use_floating.

Fields

open: MaybeProp<bool>

Represents the open/close state of the floating element.

Defaults to true.

placement: MaybeProp<Placement>

Where to place the floating element relative to the reference element.

Defaults to Placement::Bottom.

strategy: MaybeProp<Strategy>

The strategy to use when positioning the floating element.

Defaults to Strategy::Absolute.

middleware: MaybeProp<WrappedMiddleware>

Array of middleware objects to modify the positioning or provide data for rendering.

Defaults to an empty vector.

transform: MaybeProp<bool>

Whether to use transform for positioning instead of top and left in the floatingStyles object.

Defaults to true.

while_elements_mounted: MaybeProp<SendWrapper<Rc<WhileElementsMountedFn>>>

Callback to handle mounting/unmounting of the elements.

Defaults to Option::None.

Implementations

impl UseFloatingOptions

pub fn open(self, value: MaybeProp<bool>) -> Self

Set open option.

pub fn placement(self, value: MaybeProp<Placement>) -> Self

Set placement option.

pub fn strategy(self, value: MaybeProp<Strategy>) -> Self

Set strategy option.

pub fn middleware(self, value: MaybeProp<WrappedMiddleware>) -> Self

Set middleware option.

pub fn transform(self, value: MaybeProp<bool>) -> Self

Set transform option.

pub fn while_elements_mounted( self, value: MaybeProp<SendWrapper<Rc<WhileElementsMountedFn>>>, ) -> Self

Set while_elements_mounted option.

pub fn while_elements_mounted_auto_update(self) -> Self

Set while_elements_mounted option to auto_update with AutoUpdateOptions::default.

pub fn while_elements_mounted_auto_update_with_enabled( self, enabled: Signal<bool>, ) -> Self

Set while_elements_mounted option to auto_update with AutoUpdateOptions::default when enabled is true.

pub fn while_elements_mounted_auto_update_with_options( self, options: Signal<AutoUpdateOptions>, ) -> Self

Set while_elements_mounted option to auto_update with options.

pub fn while_elements_mounted_auto_update_with_enabled_and_options( self, enabled: Signal<bool>, options: Signal<AutoUpdateOptions>, ) -> Self

Set while_elements_mounted option to auto_update with options when enabled is true.

Trait Implementations

impl Clone for UseFloatingOptions

fn clone(&self) -> UseFloatingOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for UseFloatingOptions

fn default() -> UseFloatingOptions

Returns the “default value” for a type.