Struct Positioner 

pub struct Positioner { /* private fields */ }

An unstyled element that positions its children as an anchored popup.

This owns measurement, side selection, alignment, and viewport clamping. It installs no presentation of its own and adds no wrapper element around its children.

Implementations

impl Positioner

pub fn side(trigger_bounds: Bounds<Pixels>) -> Self

Places the popup on a side of trigger_bounds, flipping when needed.

pub fn corner(anchor: Anchor, position: Point<Pixels>) -> Self

Places anchor’s corner of the popup at position.

This is the corner-anchoring path used by triggers that were written against GPUI’s anchored element. It clamps into the viewport without changing the requested anchor.

pub fn placement(self, placement: Placement) -> Self

Sets the preferred side. Only meaningful for Positioner::side.

pub fn align(self, align: Align) -> Self

Sets the alignment along the chosen side. Only meaningful for Positioner::side.

pub fn offset(self, offset: Pixels) -> Self

Sets the gap between the trigger and the popup. Only meaningful for Positioner::side.

pub fn occlude(self) -> Self

Blocks the mouse over the positioned popup.

Off by default, because a tooltip that swallowed the pointer would un-hover the very trigger keeping it open. An interactive surface — a popover, a menu, a dropdown — wants it on: what the surface covers is the surface’s, not the panel underneath.

pub fn margin(self, margin: Pixels) -> Self

Sets the minimum distance kept between the popup and the viewport edge.

Trait Implementations

impl Element for Positioner

type RequestLayoutState = PositionerState

The type of state returned from Element::request_layout. A mutable reference to this state is subsequently provided to Element::prepaint and Element::paint.

type PrepaintState = ()

The type of state returned from Element::prepaint. A mutable reference to this state is subsequently provided to Element::paint.

fn id(&self) -> Option<ElementId>

If this element has a unique identifier, return it here. This is used to track elements across frames, and will cause a GlobalElementId to be passed to the request_layout, prepaint, and paint methods.

fn source_location(&self) -> Option<&'static Location<'static>>

Source location where this element was constructed, used to disambiguate elements in the inspector and navigate to their source code.

fn request_layout( &mut self, _: Option<&GlobalElementId>, _: Option<&InspectorElementId>, window: &mut Window, cx: &mut App, ) -> (LayoutId, Self::RequestLayoutState)

Before an element can be painted, we need to know where it’s going to be and how big it is. Use this method to request a layout from Taffy and initialize the element’s state.

fn prepaint( &mut self, _: Option<&GlobalElementId>, _: Option<&InspectorElementId>, bounds: Bounds<Pixels>, request_layout: &mut Self::RequestLayoutState, window: &mut Window, cx: &mut App, )

After laying out an element, we need to commit its bounds to the current frame for hitbox purposes. The state argument is the same state that was returned from Element::request_layout().

fn paint( &mut self, _: Option<&GlobalElementId>, _: Option<&InspectorElementId>, _: Bounds<Pixels>, _: &mut Self::RequestLayoutState, _: &mut Self::PrepaintState, window: &mut Window, cx: &mut App, )

Once layout has been completed, this method will be called to paint the element to the screen. The state argument is the same state that was returned from Element::request_layout().

fn a11y_role(&self) -> Option<Role>

Returns the accessible role for this element, if any. Elements that return None are not included in the accessibility tree.

fn write_a11y_info(&self, _node: &mut Node)

Write accessibility properties to the given node. Called only when a11y_role() returns Some.

fn a11y_synthetic_children( &mut self, _prepaint: &mut Self::PrepaintState, _builder: &mut A11ySubtreeBuilder<'_>, )

Add synthetic child nodes to an Element that has an .id() and a .role().

fn into_any(self) -> AnyElement

Convert this element into a dynamically-typed AnyElement.

impl IntoElement for Positioner

type Element = Positioner

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements Element.

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed AnyElement.

impl ParentElement for Positioner

fn extend(&mut self, elements: impl IntoIterator<Item = AnyElement>)

Extend this element’s children with the given child elements.

fn child(self, child: impl IntoElement) -> Self

where Self: Sized,

Add a single child element to this element.

fn children(self, children: impl IntoIterator<Item = impl IntoElement>) -> Self

where Self: Sized,

Add multiple child elements to this element.