Struct TextButton

pub struct TextButton { /* private fields */ }

A horizontally laid-out button view that includes styling for border, background, box shadow, and text shadow.

TextButton is a Bevy UI bundle suited for building rich, styled buttons with optional text shadow effects. It uses FlexDirection::Row to horizontally align its children, and implements positioning and style-related traits such as BorderView, BackgroundView, BoxShadowView, TextShadowView, and PositionView (if implemented).

Default Layout

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

Example

commands.spawn(TextButton::default()
    .text("OK")
    .text_color(Color::WHITE)
    .font(my_font)
    .background_color(Color::rgb(0.2, 0.6, 0.8)));

Trait Implementations

impl BackgroundView for TextButton

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

impl BorderView for TextButton

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 TextButton

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 Clone for TextButton

fn clone(&self) -> TextButton

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextButton

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

Formats the value using the given formatter.

impl Default for TextButton

fn default() -> Self

Returns the “default value” for a type.

impl PositionView for TextButton

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 TextButton

fn from_justify_content(justify_content: JustifyContent) -> Self

fn from_align_items(align_items: AlignItems) -> Self

fn reverse(self) -> Self

Reverses the current flex direction (e.g. Row ⇄ RowReverse, Column ⇄ ColumnReverse)

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 vertical spacing between rows

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

Sets horizontal spacing between columns

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

Automatically applies spacing based on current flex direction

impl TextShadowView for TextButton

fn text_shadow_node(&mut self) -> &mut TextShadow

Returns a mutable reference to the underlying TextShadow node, which stores shadow-related styling information.

fn text_shadow_offset(self, offset: Vec2) -> Self

Sets the offset of the text shadow.

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

Sets the color of the text shadow.

impl TextView for TextButton

fn text_node(&mut self) -> &mut TextStyle

Returns a mutable reference to the inner TextStyle node used for text styling.

fn text_alignment(self, justify_text: JustifyText) -> Self

Sets the text alignment mode within the layout container.

fn text_linebreak(self, line_break: LineBreak) -> Self

Sets the line-breaking behavior of the text content.

fn text(self, text: impl Into<String>) -> Self

Sets the string content of the text node.

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

Sets the text color of the node.

fn font(self, font: Handle<Font>) -> Self

Sets the font asset used for rendering the text.

fn font_size(self, font_size: f32) -> Self

Sets the size of the font in logical pixels.

fn line_height(self, line_height: LineHeight) -> Self

Sets the line height for the text, controlling vertical spacing between lines.

fn font_smoothing(self, font_smoothing: FontSmoothing) -> Self

Sets the font smoothing mode for the text.

impl View for TextButton

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

Returns a mutable reference to the entity’s Name component

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

Returns a mutable reference to the entity’s Node component

fn new() -> Self

Short Default Method

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

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

Sets the Name component

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

Applies padding to the Node

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

Sets width and height of the Node

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

Sets the width of the Node

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

Sets the height of the Node

impl ViewToBundle for TextButton

fn pack(self) -> impl Bundle