Struct floating_ui_core::middleware::Flip

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

Optimizes the visibility of the floating element by flipping the placement in order to keep it in view when the preferred placement(s) will overflow the clipping boundary. Alternative to AutoPlacement.

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

Implementations

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

pub fn new(options: FlipOptions<Element>) -> Self

Constructs a new instance of this middleware.

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

Constructs a new instance of this middleware with derivable options.

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

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

Trait Implementations

impl<'a, Element: Clone, Window: Clone> Clone for Flip<'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 Flip<'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, FlipOptions<Element>> for Flip<'a, Element, Window>

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

The options passed to this middleware.