Struct floating_ui_core::middleware::FlipOptions

pub struct FlipOptions<Element: Clone> {
    pub detect_overflow: Option<DetectOverflowOptions<Element>>,
    pub main_axis: Option<bool>,
    pub cross_axis: Option<bool>,
    pub fallback_placements: Option<Vec<Placement>>,
    pub fallback_strategy: Option<FallbackStrategy>,
    pub fallback_axis_side_direction: Option<Alignment>,
    pub flip_alignment: Option<bool>,
}

Options for Flip 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 side of the floating element. Determines whether overflow along this axis is checked to perform a flip.

Defaults to true.

cross_axis: Option<bool>

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

Defaults to true.

fallback_placements: Option<Vec<Placement>>

Placements to try sequentially if the preferred placement does not fit.

Defaults to the opposite placement.

fallback_strategy: Option<FallbackStrategy>

What strategy to use when no placements fit.

Defaults to FallbackStrategy::BestFit.

fallback_axis_side_direction: Option<Alignment>

Whether to allow fallback to the perpendicular axis of the preferred placement, and if so, which side direction along the axis to prefer.

Defaults to Option::None (disallow fallback).

flip_alignment: Option<bool>

Whether to flip to placements with the opposite alignment if they fit better.

Defaults to true.

Implementations

impl<Element: Clone> FlipOptions<Element>

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

Set detect_overflow option.

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

Set main_axis option.

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

Set cross_axis option.

pub fn fallback_placements(self, value: Vec<Placement>) -> Self

Set fallback_placements option.

pub fn fallback_strategy(self, value: FallbackStrategy) -> Self

Set fallback_strategy option.

pub fn fallback_axis_side_direction(self, value: Alignment) -> Self

Set fallback_axis_side_direction option.

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

Set flip_alignment option.

Trait Implementations

impl<Element: Clone + Clone> Clone for FlipOptions<Element>

fn clone(&self) -> FlipOptions<Element>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Element: Debug + Clone> Debug for FlipOptions<Element>

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

Formats the value using the given formatter.

impl<Element: Clone> Default for FlipOptions<Element>

fn default() -> Self

Returns the “default value” for a type.

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.

impl<Element: PartialEq + Clone> PartialEq for FlipOptions<Element>

fn eq(&self, other: &FlipOptions<Element>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Element: Clone> StructuralPartialEq for FlipOptions<Element>