Struct MenuPopup 

pub struct MenuPopup {
    pub layout: MenuLayout,
}

Component that defines a popup menu container.

Menus are automatically dismissed when the user clicks outside the menu bounds. Unlike a modal dialog, where the click event is intercepted, we don’t want to actually prevent the click event from triggering its normal action. The easiest way to detect this kind of click is to look for keyboard focus loss. When a menu is opened, one of its children will gain focus, and the menu remains open so long as at least one descendant is focused. Arrow keys can be used to navigate between menu items.

This means that popup menu must contain at least one focusable entity. It also means that two menus cannot be displayed at the same time unless one is an ancestor of the other.

Some care needs to be taken in implementing a menu button: we normally want menu buttons to toggle the open state of the menu; but clicking on the button will cause focus loss which means that the menu will always be closed by the time the click event is processed.

Fields

layout: MenuLayout

The layout orientation of the menu

Trait Implementations

impl Clone for MenuPopup

fn clone(&self) -> MenuPopup

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for MenuPopup

where MenuPopup: Send + Sync + 'static,

Required Components: AccessibilityNode, TabGroup, [MenuAcquireFocus].

A component’s Required Components are inserted whenever it is inserted. Note that this will also insert the required components of the required components, recursively, in depth-first order.

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<MenuPopup>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Debug for MenuPopup

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

Formats the value using the given formatter.

impl Default for MenuPopup

fn default() -> MenuPopup

Returns the “default value” for a type.