Struct RadioGroup 

pub struct RadioGroup;

Headless widget implementation for a “radio button group”. This component is used to group multiple RadioButton components together, allowing them to behave as a single unit. It implements the tab navigation logic and keyboard shortcuts for radio buttons.

The RadioGroup component does not have any state itself, and makes no assumptions about what, if any, value is associated with each radio button, or what Rust type that value might be. Instead, the output of the group is a ValueChange event whose payload is the entity id of the selected button. This event is emitted whenever a radio button is clicked, or when using the arrow keys while the radio group is focused. The app can then derive the selected value from this using app-specific means, such as accessing a component on the individual buttons.

The RadioGroup doesn’t actually set the Checked states directly, that is presumed to happen by the app or via some external data-binding scheme. Typically, each button would be associated with a particular constant value, and would be checked whenever that value is equal to the group’s value. This also means that as long as each button’s associated value is unique within the group, it should never be the case that more than one button is selected at a time.

Trait Implementations

impl Component for RadioGroup

where Self: Send + Sync + 'static,

Required Components: AccessibilityNode.

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 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 RadioGroup

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

Formats the value using the given formatter.