Struct bevy_ui::node_bundles::TextBundle

pub struct TextBundle {

    pub node: Node,
    pub style: Style,
    pub text: Text,
    pub text_layout_info: TextLayoutInfo,
    pub text_flags: TextFlags,
    pub calculated_size: ContentSize,
    pub focus_policy: FocusPolicy,
    pub transform: Transform,
    pub global_transform: GlobalTransform,
    pub visibility: Visibility,
    pub inherited_visibility: InheritedVisibility,
    pub view_visibility: ViewVisibility,
    pub z_index: ZIndex,
    pub background_color: BackgroundColor,
}

A UI node that is text

The positioning of this node is controlled by the UI layout system. If you need manual control, use Text2dBundle.

Fields

node: Node

Describes the logical size of the node

style: Style

Styles which control the layout (size and position) of the node and its children In some cases these styles also affect how the node drawn/painted.

text: Text

Contains the text of the node

text_layout_info: TextLayoutInfo

Text layout information

text_flags: TextFlags

Text system flags

calculated_size: ContentSize

The calculated size based on the given image

focus_policy: FocusPolicy

Whether this node should block interaction with lower nodes

transform: Transform

The transform of the node

This component is automatically managed by the UI layout system. To alter the position of the TextBundle, use the properties of the Style component.

global_transform: GlobalTransform

The global transform of the node

This component is automatically updated by the TransformPropagate systems.

visibility: Visibility

Describes the visibility properties of the node

inherited_visibility: InheritedVisibility

Inherited visibility of an entity.

view_visibility: ViewVisibility

Algorithmically-computed indication of whether an entity is visible and should be extracted for rendering

z_index: ZIndex

Indicates the depth at which the node should appear in the UI

background_color: BackgroundColor

The background color that will fill the containing node

Implementations

impl TextBundle

pub fn from_section(value: impl Into<String>, style: TextStyle) -> Self

Create a TextBundle from a single section.

See Text::from_section for usage.

pub fn from_sections(sections: impl IntoIterator<Item = TextSection>) -> Self

Create a TextBundle from a list of sections.

See Text::from_sections for usage.

pub const fn with_text_justify(self, justify: JustifyText) -> Self

Returns this TextBundle with a new JustifyText on Text.

pub fn with_style(self, style: Style) -> Self

Returns this TextBundle with a new Style.

pub const fn with_background_color(self, color: Color) -> Self

Returns this TextBundle with a new BackgroundColor.

pub const fn with_no_wrap(self) -> Self

Returns this TextBundle with soft wrapping disabled. Hard wrapping, where text contains an explicit linebreak such as the escape sequence \n, will still occur.

Trait Implementations

impl Bundle for TextBundle

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.

impl Debug for TextBundle

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

Formats the value using the given formatter.

impl Default for TextBundle

fn default() -> TextBundle

Returns the “default value” for a type.

impl<I> From<I> for TextBundle

where I: Into<TextSection>,

fn from(value: I) -> Self

Converts to this type from the input type.

impl DynamicBundle for TextBundle