 166686e0f2
			
		
	
	
		166686e0f2
		
			
		
	
	
	
	
		
			
			# Objective The name `TextAlignment` is really deceptive and almost every new user gets confused about the differences between aligning text with `TextAlignment`, aligning text with `Style` and aligning text with anchor (when using `Text2d`). ## Solution * Rename `TextAlignment` to `JustifyText`. The associated helper methods are also renamed. * Improve the doc comments for text explaining explicitly how the `JustifyText` component affects the arrangement of text. * Add some extra cases to the `text_debug` example that demonstate the differences between alignment using `JustifyText` and alignment using `Style`. <img width="757" alt="text_debug_2" src="https://github.com/bevyengine/bevy/assets/27962798/9d53e647-93f9-4bc7-8a20-0d9f783304d2"> --- ## Changelog * `TextAlignment` has been renamed to `JustifyText` * `TextBundle::with_text_alignment` has been renamed to `TextBundle::with_text_justify` * `Text::with_alignment` has been renamed to `Text::with_justify` * The `text_alignment` field of `TextMeasureInfo` has been renamed to `justification` ## Migration Guide * `TextAlignment` has been renamed to `JustifyText` * `TextBundle::with_text_alignment` has been renamed to `TextBundle::with_text_justify` * `Text::with_alignment` has been renamed to `Text::with_justify` * The `text_alignment` field of `TextMeasureInfo` has been renamed to `justification`
		
			
				
	
	
		
			140 lines
		
	
	
		
			4.6 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
			
		
		
	
	
			140 lines
		
	
	
		
			4.6 KiB
		
	
	
	
		
			Rust
		
	
	
	
	
	
| //! This example demonstrates text wrapping and use of the `LineBreakOn` property.
 | |
| 
 | |
| use argh::FromArgs;
 | |
| use bevy::prelude::*;
 | |
| use bevy::text::BreakLineOn;
 | |
| use bevy::window::WindowResolution;
 | |
| use bevy::winit::WinitSettings;
 | |
| 
 | |
| #[derive(FromArgs, Resource)]
 | |
| /// `text_wrap_debug` demonstrates text wrapping and use of the `LineBreakOn` property
 | |
| struct Args {
 | |
|     #[argh(option)]
 | |
|     /// window scale factor
 | |
|     scale_factor: Option<f64>,
 | |
| 
 | |
|     #[argh(option, default = "1.")]
 | |
|     /// ui scale factor
 | |
|     ui_scale: f64,
 | |
| }
 | |
| 
 | |
| fn main() {
 | |
|     let args: Args = argh::from_env();
 | |
|     let window = if let Some(scale_factor) = args.scale_factor {
 | |
|         Window {
 | |
|             resolution: WindowResolution::default().with_scale_factor_override(scale_factor),
 | |
|             ..Default::default()
 | |
|         }
 | |
|     } else {
 | |
|         Window::default()
 | |
|     };
 | |
| 
 | |
|     App::new()
 | |
|         .add_plugins(DefaultPlugins.set(WindowPlugin {
 | |
|             primary_window: Some(window),
 | |
|             ..Default::default()
 | |
|         }))
 | |
|         .insert_resource(WinitSettings::desktop_app())
 | |
|         .insert_resource(UiScale(args.ui_scale))
 | |
|         .add_systems(Startup, spawn)
 | |
|         .run();
 | |
| }
 | |
| 
 | |
| fn spawn(mut commands: Commands, asset_server: Res<AssetServer>) {
 | |
|     commands.spawn(Camera2dBundle::default());
 | |
| 
 | |
|     let text_style = TextStyle {
 | |
|         font: asset_server.load("fonts/FiraSans-Bold.ttf"),
 | |
|         font_size: 14.0,
 | |
|         ..default()
 | |
|     };
 | |
| 
 | |
|     let root = commands
 | |
|         .spawn(NodeBundle {
 | |
|             style: Style {
 | |
|                 width: Val::Percent(100.),
 | |
|                 height: Val::Percent(100.),
 | |
|                 flex_direction: FlexDirection::Column,
 | |
|                 ..Default::default()
 | |
|             },
 | |
|             background_color: Color::BLACK.into(),
 | |
|             ..Default::default()
 | |
|         })
 | |
|         .id();
 | |
| 
 | |
|     for linebreak_behavior in [
 | |
|         BreakLineOn::AnyCharacter,
 | |
|         BreakLineOn::WordBoundary,
 | |
|         BreakLineOn::NoWrap,
 | |
|     ] {
 | |
|         let row_id = commands
 | |
|             .spawn(NodeBundle {
 | |
|                 style: Style {
 | |
|                     flex_direction: FlexDirection::Row,
 | |
|                     justify_content: JustifyContent::SpaceAround,
 | |
|                     align_items: AlignItems::Center,
 | |
|                     width: Val::Percent(100.),
 | |
|                     height: Val::Percent(50.),
 | |
|                     ..Default::default()
 | |
|                 },
 | |
|                 ..Default::default()
 | |
|             })
 | |
|             .id();
 | |
| 
 | |
|         let justifications = vec![
 | |
|             JustifyContent::Center,
 | |
|             JustifyContent::FlexStart,
 | |
|             JustifyContent::FlexEnd,
 | |
|             JustifyContent::SpaceAround,
 | |
|             JustifyContent::SpaceBetween,
 | |
|             JustifyContent::SpaceEvenly,
 | |
|         ];
 | |
| 
 | |
|         for (i, justification) in justifications.into_iter().enumerate() {
 | |
|             let c = 0.3 + i as f32 * 0.1;
 | |
|             let column_id = commands
 | |
|                 .spawn(NodeBundle {
 | |
|                     style: Style {
 | |
|                         justify_content: justification,
 | |
|                         flex_direction: FlexDirection::Column,
 | |
|                         width: Val::Percent(16.),
 | |
|                         height: Val::Percent(95.),
 | |
|                         overflow: Overflow::clip_x(),
 | |
|                         ..Default::default()
 | |
|                     },
 | |
|                     background_color: Color::rgb(0.5, c, 1.0 - c).into(),
 | |
|                     ..Default::default()
 | |
|                 })
 | |
|                 .id();
 | |
| 
 | |
|             let messages = [
 | |
|                 format!("JustifyContent::{justification:?}"),
 | |
|                 format!("LineBreakOn::{linebreak_behavior:?}"),
 | |
|                 "Line 1\nLine 2\nLine 3".to_string(),
 | |
|                 "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Maecenas auctor, nunc ac faucibus fringilla.".to_string(),
 | |
|             ];
 | |
| 
 | |
|             for (j, message) in messages.into_iter().enumerate() {
 | |
|                 let text = Text {
 | |
|                     sections: vec![TextSection {
 | |
|                         value: message.clone(),
 | |
|                         style: text_style.clone(),
 | |
|                     }],
 | |
|                     justify: JustifyText::Left,
 | |
|                     linebreak_behavior,
 | |
|                 };
 | |
|                 let text_id = commands
 | |
|                     .spawn(TextBundle {
 | |
|                         text,
 | |
|                         background_color: Color::rgb(0.8 - j as f32 * 0.2, 0., 0.).into(),
 | |
|                         ..Default::default()
 | |
|                     })
 | |
|                     .id();
 | |
|                 commands.entity(column_id).add_child(text_id);
 | |
|             }
 | |
|             commands.entity(row_id).add_child(column_id);
 | |
|         }
 | |
|         commands.entity(root).add_child(row_id);
 | |
|     }
 | |
| }
 |