Struct floating_ui_core::middleware::AutoPlacementOptions

pub struct AutoPlacementOptions<Element: Clone> {
    pub detect_overflow: Option<DetectOverflowOptions<Element>>,
    pub cross_axis: Option<bool>,
    pub alignment: Option<Alignment>,
    pub auto_alignment: Option<bool>,
    pub allowed_placements: Option<Vec<Placement>>,
}

Options for AutoPlacement middleware.

Fields

detect_overflow: Option<DetectOverflowOptions<Element>>

Options for detect_overflow.

Defaults to DetectOverflowOptions::default.

cross_axis: Option<bool>

The axis that runs along the alignment of the floating element. Determines whether to check for most space along this axis.

Defaults to false.

alignment: Option<Alignment>

Choose placements with a particular alignment.

Defaults to Option::None.

auto_alignment: Option<bool>

Whether to choose placements with the opposite alignment if the preferred alignment does not fit.

Defaults to true.

allowed_placements: Option<Vec<Placement>>

Which placements are allowed to be chosen. Placements must be within the alignment option if explicitly set.

Defaults to all possible placements.

Implementations

impl<Element: Clone> AutoPlacementOptions<Element>

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

Set detect_overflow option.

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

Set cross_axis option.

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

Set alignment option.

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

Set auto_alignment option.

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

Set alignment option.

Trait Implementations

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

fn clone(&self) -> AutoPlacementOptions<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 AutoPlacementOptions<Element>

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

Formats the value using the given formatter.

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

fn default() -> Self

Returns the “default value” for a type.

impl<'a, Element: Clone, Window: Clone> MiddlewareWithOptions<Element, Window, AutoPlacementOptions<Element>> for AutoPlacement<'a, Element, Window>

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

The options passed to this middleware.