Struct Popover 

pub struct Popover { /* private fields */ }

A surface anchored to a trigger, holding whatever the caller puts in it.

Open state and the element that had the keyboard before opening both outlive a frame, so a popover is a view rather than a builder. The body is a callback instead of a stored element because an AnyElement can be consumed once, while an open popover re-renders for as long as it stays open.

Implementations

impl Popover

pub fn new( ident: impl Into<Ident>, _window: &mut Window, cx: &mut Context<'_, Self>, ) -> Self

pub fn trigger(self, label: impl Into<SharedString>) -> Self

The label of the control that opens the surface.

pub fn trigger_icon(self, icon: Icon) -> Self

pub fn content( self, content: impl Fn(&mut Window, &mut App) -> AnyElement + 'static, ) -> Self

Supplies the body, rebuilt on every frame the popover is open.

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

pub fn dismissable(self, dismissable: bool) -> Self

Whether escape and a click outside close the surface. A popover that is not dismissable installs neither handler.

pub fn is_open(&self) -> bool

pub fn is_dismissable(&self) -> bool

pub fn open(&mut self, window: &mut Window, cx: &mut Context<'_, Self>)

pub fn close(&mut self, window: &mut Window, cx: &mut Context<'_, Self>)

Closes the surface and gives the keyboard back to the trigger.

pub fn toggle(&mut self, window: &mut Window, cx: &mut Context<'_, Self>)

pub fn dismiss(&mut self, window: &mut Window, cx: &mut Context<'_, Self>)

Reports a wave-away. A popover that is not dismissable cannot be waved away even by a host calling this directly.

Trait Implementations

impl Debug for Popover

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

Formats the value using the given formatter.

impl EventEmitter<PopoverEvent> for Popover

impl Focusable for Popover

fn focus_handle(&self, _cx: &App) -> FocusHandle

Returns the focus handle associated with this view.

impl Render for Popover

fn render( &mut self, window: &mut Window, cx: &mut Context<'_, Self>, ) -> impl IntoElement

Render this view into an element tree.