Struct floating_ui_dom::DetectOverflowOptions

pub struct DetectOverflowOptions<Element> {
    pub boundary: Option<Boundary<Element>>,
    pub root_boundary: Option<RootBoundary>,
    pub element_context: Option<ElementContext>,
    pub alt_boundary: Option<bool>,
    pub padding: Option<Padding>,
}

Options for detect_overflow.

Fields

boundary: Option<Boundary<Element>>

The clipping element(s) or area in which overflow will be checked.

Defaults to Boundary::ClippingAncestors.

root_boundary: Option<RootBoundary>

The root clipping area in which overflow will be checked.

Defaults to RootBoundary::Viewport.

element_context: Option<ElementContext>

The element in which overflow is being checked relative to a boundary.

Defaults to ElementContext::Floating.

alt_boundary: Option<bool>

Whether to check for overflow using the alternate element’s boundary (only when boundary is Boundary::ClippingAncestors).

Defaults to false.

padding: Option<Padding>

Virtual padding for the resolved overflow detection offsets.

Defaults to 0 on all sides.

Implementations

impl<Element> DetectOverflowOptions<Element>

pub fn boundary( self, value: Boundary<Element> ) -> DetectOverflowOptions<Element>

Set boundary option.

pub fn root_boundary( self, value: RootBoundary ) -> DetectOverflowOptions<Element>

Set root_boundary option.

pub fn element_context( self, value: ElementContext ) -> DetectOverflowOptions<Element>

Set element_context option.

pub fn alt_boundary(self, value: bool) -> DetectOverflowOptions<Element>

Set alt_boundary option.

pub fn padding(self, value: Padding) -> DetectOverflowOptions<Element>

Set padding option.

Trait Implementations

impl<Element> Clone for DetectOverflowOptions<Element>

where Element: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Element> Debug for DetectOverflowOptions<Element>

where Element: Debug,

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

Formats the value using the given formatter.

impl<Element> Default for DetectOverflowOptions<Element>

fn default() -> DetectOverflowOptions<Element>

Returns the “default value” for a type.