Struct floating_ui_dom::ShiftOptions

pub struct ShiftOptions<Element, Window>
where
    Element: Clone,
    Window: Clone,
{
    pub detect_overflow: Option<DetectOverflowOptions<Element>>,
    pub main_axis: Option<bool>,
    pub cross_axis: Option<bool>,
    pub limiter: Option<Box<dyn Limiter<Element, Window>>>,
}

Options for Shift middleware.

Fields

detect_overflow: Option<DetectOverflowOptions<Element>>

Options for detect_overflow.

Defaults to DetectOverflowOptions::default.

main_axis: Option<bool>

The axis that runs along the alignment of the floating element. Determines whether overflow along this axis is checked to perform shifting.

Defaults to true.

cross_axis: Option<bool>

The axis that runs along the side of the floating element. Determines whether overflow along this axis is checked to perform shifting.

Defaults to false.

limiter: Option<Box<dyn Limiter<Element, Window>>>

Accepts a limiter that limits the shifting done in order to prevent detachment.

Defaults to DefaultLimiter.

Implementations

impl<Element, Window> ShiftOptions<Element, Window>

where Element: Clone, Window: Clone,

pub fn detect_overflow( self, value: DetectOverflowOptions<Element> ) -> ShiftOptions<Element, Window>

Set detect_overflow option.

pub fn main_axis(self, value: bool) -> ShiftOptions<Element, Window>

Set main_axis option.

pub fn cross_axis(self, value: bool) -> ShiftOptions<Element, Window>

Set cross_axis option.

pub fn limiter( self, value: Box<dyn Limiter<Element, Window>> ) -> ShiftOptions<Element, Window>

Set limiter option.

Trait Implementations

impl<Element, Window> Clone for ShiftOptions<Element, Window>

where Element: Clone, Window: Clone,

fn clone(&self) -> ShiftOptions<Element, Window>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Element, Window> Default for ShiftOptions<Element, Window>

where Element: Clone, Window: Clone,

fn default() -> ShiftOptions<Element, Window>

Returns the “default value” for a type.

impl<'a, Element, Window> MiddlewareWithOptions<Element, Window, ShiftOptions<Element, Window>> for Shift<'a, Element, Window>

where Element: Clone, Window: Clone,

fn options( &self ) -> &Derivable<'_, Element, Window, ShiftOptions<Element, Window>>

The options passed to this middleware.