Struct floating_ui_core::middleware::Shift

pub struct Shift<'a, Element: Clone, Window: Clone> { /* private fields */ }

Optimizes the visibility of the floating element by shifting it in order to keep it in view when it will overflow the clipping boundary.

See https://floating-ui.com/docs/shift for the original documentation.

Implementations

impl<'a, Element: Clone, Window: Clone> Shift<'a, Element, Window>

pub fn new(options: ShiftOptions<Element, Window>) -> Self

Constructs a new instance of this middleware.

pub fn new_derivable( options: Derivable<'a, Element, Window, ShiftOptions<Element, Window>> ) -> Self

Constructs a new instance of this middleware with derivable options.

pub fn new_derivable_fn( options: DerivableFn<'a, Element, Window, ShiftOptions<Element, Window>> ) -> Self

Constructs a new instance of this middleware with derivable options function.

Trait Implementations

impl<'a, Element: Clone, Window: Clone> Clone for Shift<'a, Element, Window>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, Element: Clone, Window: Clone> Middleware<Element, Window> for Shift<'a, Element, Window>

fn name(&self) -> &'static str

The name of this middleware.

fn compute( &self, state: MiddlewareState<'_, Element, Window> ) -> MiddlewareReturn

Executes this middleware.

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

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

The options passed to this middleware.