Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-11-22 04:33:37 +00:00
Code Issues Projects Releases Packages Wiki Activity

Add docstring comment to Style to reference CSS (#2936)

Browse source 
Mention the fact that the UI layout system is based on the CSS layout
model through a docstring comment on the `Style` type.

# Objective

Explain to new users that the Bevy UI uses the CSS layout model, to lower the barrier to entry given the fact documentation (book and code) is fairly limited on the topic.

## Solution

Fix as discussed with @alice-i-cecile on #2918.
This commit is contained in:
Jerome Humbert 2021-11-06 20:53:10 +00:00
parent aac09353fd
commit a5c675f336
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
crates/bevy_ui/src/ui_node.rs
View file

@ -57,6 +57,14 @@ impl AddAssign<f32> for Val {
} }
} }
/// UI node style.
///
/// The UI layout system follows the CSS layout model specification (see
/// [this section](https://www.w3.org/TR/CSS2/visuren.html) in particular).
/// One notable difference however is that the vertical axis is inverted,
/// with the Y axis pointing up in Bevy (origin in bottom left corner).
///
/// You may find [this flexbox guide](https://css-tricks.com/snippets/css/a-guide-to-flexbox/) helpful.
#[derive(Component, Clone, PartialEq, Debug, Reflect)] #[derive(Component, Clone, PartialEq, Debug, Reflect)]
#[reflect(Component, PartialEq)] #[reflect(Component, PartialEq)]
pub struct Style { pub struct Style {