Struct floating_ui_core::middleware::OffsetOptionsValues

pub struct OffsetOptionsValues {
    pub main_axis: Option<f64>,
    pub cross_axis: Option<f64>,
    pub alignment_axis: Option<f64>,
}

Axes configuration for OffsetOptions.

Fields

main_axis: Option<f64>

The axis that runs along the side of the floating element. Represents the distance (gutter or margin) between the reference and floating element.

Defaults to 0.

cross_axis: Option<f64>

The axis that runs along the alignment of the floating element. Represents the skidding between the reference and floating element.

Defaults to 0.

alignment_axis: Option<f64>

The same axis as cross_axis but applies only to aligned placements and inverts the End alignment. When set to a number, it overrides the cross_axis value.

A positive number will move the floating element in the direction of the opposite edge to the one that is aligned, while a negative number the reverse.

Defaults to Option::None.

Implementations

impl OffsetOptionsValues

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

Set main_axis option.

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

Set cross_axis option.

pub fn alignment_axis(self, value: f64) -> Self

Set alignment_axis option.

Trait Implementations

impl Clone for OffsetOptionsValues

fn clone(&self) -> OffsetOptionsValues

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OffsetOptionsValues

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

Formats the value using the given formatter.

impl Default for OffsetOptionsValues

fn default() -> OffsetOptionsValues

Returns the “default value” for a type.