Struct HButton 

pub struct HButton { /* private fields */ }

A horizontally laid-out button view with customizable border, background, and shadow.

HButton is a styled UI component composed using Bevy’s ECS Bundle. By default, it uses a horizontal FlexDirection::Row layout with centered alignment, and includes styling traits such as BorderView, BackgroundView, BoxShadowView, and PositionView.

This component is ideal for creating rich, composable buttons in declarative UI.

Default Layout

• display: Flex
• flex_direction: Row
• justify_content: Center
• align_items: Center
• column_gap: 0.0

Example

commands.spawn(HButton::default()
    .text("Click me")
    .font(my_font)
    .border_width(Val::Px(2.0))
    .background_color(Color::BLUE));

Trait Implementations

impl BackgroundView for HButton

fn background_node(&mut self) -> &mut BackgroundStyle

Returns a mutable reference to the current background style

fn background_color(self, color: impl Into<Color>) -> Self

Sets a solid color as the background

fn background_image(self, image: Handle<Image>) -> Self

Sets an image as the background

fn background_image_mode(self, image_mode: NodeImageMode) -> Self

Sets background image mode

impl BorderView for HButton

fn border_node(&mut self) -> &mut BorderStyle

Returns a mutable reference to the current border style

fn border(self, border: UiRect) -> Self

Sets the border size

fn border_color(self, border_color: impl Into<Color>) -> Self

Sets the border color

fn border_radius(self, border_radius: BorderRadius) -> Self

Sets the border radius

impl BoxShadowView for HButton

fn box_shadow_node(&mut self) -> &mut BoxShadow

Returns a mutable reference to the internal shadow style list.

fn shadow(self, shadows: Vec<ShadowStyle>) -> Self

Replaces all existing shadows with the provided list.

fn add_shadow(self, shadow: ShadowStyle) -> Self

Appends a new shadow to the current list.

impl Bundle for HButton

fn get_component_ids( components: &Components, ids: &mut impl FnMut(Option<ComponentId>), )

Gets this Bundle’s component ids. This will be None if the component has not been registered.

fn register_required_components( components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, )

Registers components that are required by the components in this Bundle.

impl Clone for HButton

fn clone(&self) -> HButton

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HButton

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

Formats the value using the given formatter.

impl Default for HButton

fn default() -> Self

Creates a default HButton with centered horizontal layout and themed styling.

impl DynamicBundle for HButton

type Effect = ()

An operation on the entity that happens after inserting this bundle.

impl PositionView for HButton

fn top(self, y: Val) -> Self

Sets the top offset of the view in absolute positioning mode.

fn left(self, x: Val) -> Self

Sets the left offset of the view in absolute positioning mode.

fn right(self, x: Val) -> Self

Sets the right offset of the view in absolute positioning mode.

fn bottom(self, y: Val) -> Self

Sets the bottom offset of the view in absolute positioning mode.

fn position(self, x: Val, y: Val) -> Self

Sets both the left and top offsets of the view in absolute positioning mode.

impl StackView for HButton

fn from_justify_content(justify_content: JustifyContent) -> Self

Creates a new instance with a specified JustifyContent alignment along the main axis.

fn from_align_items(align_items: AlignItems) -> Self

Creates a new instance with a specified AlignItems alignment along the cross axis.

fn flex_direction(self, direction: FlexDirection) -> Self

Sets the direction of content flow within the stack (e.g. horizontal or vertical).

fn wrap(self, wrap: FlexWrap) -> Self

Sets the wrapping behavior of the flex container.

fn justify_content(self, justify: JustifyContent) -> Self

Defines how extra space along the main axis is distributed.

fn align_items(self, align_items: AlignItems) -> Self

Defines how children are aligned along the cross axis.

fn row_gap(self, gap: Val) -> Self

Sets the vertical spacing between rows when wrapping is enabled.

fn column_gap(self, gap: Val) -> Self

Sets the horizontal spacing between columns when wrapping is enabled.

impl View for HButton

fn name_node(&mut self) -> &mut Name

Provides mutable access to the underlying Name component.

fn node_node(&mut self) -> &mut Node

Provides mutable access to the underlying Node component.

fn new() -> Self

Creates a new instance using the type’s Default implementation.

fn from_name(name: impl Into<Cow<'static, str>>) -> Self

Constructs a new instance and sets its Name component.

fn name(self, name: impl Into<Cow<'static, str>>) -> Self

Sets the Name component of this instance.

fn padding(self, padding: UiRect) -> Self

Sets the padding (insets) around the content of the Node.

fn frame(self, width: Val, height: Val) -> Self

Sets both the width and height of the Node.

fn width(self, val: Val) -> Self

Sets the width of the Node.

fn max_width(self, val: Val) -> Self

Sets the maximum width constraint of the Node.

fn min_width(self, val: Val) -> Self

Sets the minimum width constraint of the Node.

fn height(self, val: Val) -> Self

Sets the height of the Node.

fn max_height(self, val: Val) -> Self

Sets the maximum height constraint of the Node.

fn min_height(self, val: Val) -> Self

Sets the minimum height constraint of the Node.

fn flex_grow(self, grow: f32) -> Self

Sets the flex_grow factor of the Node.

fn flex_shrink(self, shrink: f32) -> Self

Sets the flex_shrink factor of the Node.

fn grid_row(self, row: GridPlacement) -> Self

Assigns this node to a specific grid row in a grid layout.

fn grid_column(self, column: GridPlacement) -> Self

Assigns this node to a specific grid column in a grid layout.

impl BundleFromComponents for HButton