Skip to main content

Popover

Struct Popover 

Source
pub struct Popover { /* private fields */ }
Expand description

A click-to-toggle popover anchored to a trigger Response.

Call Popover::show immediately after painting the trigger; the popover toggles open on trigger clicks and closes on outside-click, Esc, or a subsequent trigger click.

Implementations§

Source§

impl Popover

Source

pub fn new(id_salt: impl Hash) -> Self

Create a popover keyed by id_salt. The salt is used to persist the open/closed state across frames and must be stable for the trigger it’s attached to.

Source

pub fn popup_id(id_salt: impl Hash) -> Id

The internal popup id for a given id_salt.

Use this with egui::Popup::open_id / egui::Popup::close_id to open or close a popover programmatically (for example, from a keyboard shortcut or a test harness).

Source

pub fn side(self, side: PopoverSide) -> Self

Which side of the trigger to anchor on. Default: PopoverSide::Bottom.

Source

pub fn title(self, title: impl Into<WidgetText>) -> Self

Add a strong title row above the body.

Source

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

Fix the popover’s content width. When unset, the popover sizes itself to the content and its min_width.

Source

pub fn min_width(self, min_width: f32) -> Self

Minimum content width in points. Default: 200.

Source

pub fn gap(self, gap: f32) -> Self

Gap between the trigger and the popover, in points. Default: 8.

Source

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

Toggle the small arrow that points at the trigger. Default: on.

Source

pub fn show<R>( self, trigger: &Response, add_contents: impl FnOnce(&mut Ui) -> R, ) -> Option<InnerResponse<R>>

Render the popover attached to trigger. Returns Some with the body closure’s return value while the popover is open, None while it is closed.

Trait Implementations§

Source§

impl Clone for Popover

Source§

fn clone(&self) -> Popover

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Popover

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(value: T, _simd: S) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> SerializableAny for T
where T: 'static + Any + Clone + for<'a> Send + Sync,