Struct PopupBuilder 

pub struct PopupBuilder<State = Unbound> { /* private fields */ }

Builder for configuring popups

The builder uses phantom types to ensure compile-time safety:

• PopupBuilder<Unbound> - Configuration only, cannot show popups
• PopupBuilder<Bound> - Has shell reference, can show popups

Example

shell.on("Main", "open_menu", |control| {
    let popup_handle = control.popups().builder("MenuPopup")
        .at_cursor()
        .grab(true)
        .close_on("menu_closed")
        .show()?;
});

Implementations

impl PopupBuilder<Unbound>

pub fn new(component: impl Into<String>) -> Self

Creates a new popup builder for the specified component

This builder is unbound and cannot show popups directly. Use PopupShell::builder to create a bound builder that can call .show().

impl<State> PopupBuilder<State>

pub fn position(self, position: PopupPosition) -> Self

pub fn at_cursor(self) -> Self

pub fn at_position(self, x: f32, y: f32) -> Self

pub fn centered(self) -> Self

pub fn relative_to_rect( self, rect: LogicalRect, anchor: AnchorPoint, alignment: Alignment, ) -> Self

pub fn offset(self, x: f32, y: f32) -> Self

pub fn size(self, size: PopupSize) -> Self

pub fn fixed_size(self, width: f32, height: f32) -> Self

pub fn min_size(self, width: f32, height: f32) -> Self

pub fn max_size(self, width: f32, height: f32) -> Self

pub fn content_sized(self) -> Self

pub fn grab(self, enable: bool) -> Self

pub fn modal(self, enable: bool) -> Self

pub fn close_on_click_outside(self) -> Self

pub fn close_on_escape(self) -> Self

pub fn constraint_adjustment(self, adjustment: ConstraintAdjustment) -> Self

pub fn on_output(self, target: OutputTarget) -> Self

pub fn on_primary(self) -> Self

pub fn on_active(self) -> Self

pub fn parent(self, parent: PopupHandle) -> Self

pub const fn z_index(self, index: i32) -> Self

pub fn close_on(self, callback_name: impl Into<String>) -> Self

pub fn resize_on(self, callback_name: impl Into<String>) -> Self

pub fn build(self) -> PopupConfig

Builds the configuration without showing the popup

Returns a PopupConfig that can be shown later using PopupShell::show.

impl PopupBuilder<Bound>

pub fn show(self) -> Result<PopupHandle>

Shows the popup with the configured settings

This method is only available on builders created via PopupShell::builder, ensuring at compile time that the builder has access to a shell.