bevy_mod_stylebuilder
This crate provides a set of low-level utilities for configuring bevy_ui
styles using a fluent
API. A StyleBuilder
is an object that understands how to insert, remove, and modify Bevy style
components such as Style
, BackgroundColor
and so on, as well as the Pickable
component used
by bevy_mod_picking
.
StyleBuilder
is extensible by implementing additional traits. In fact, all of the fluent methods
are trait methods.
use *;
In most cases, you won't need to instantiate a StyleBuilder
object yourself, the UI framework
will pass one to you as a callback parameter. For framework authors, however, here are the steps
needed to create a new StyleBuilder
:
/// Construct a new StyleBuilder instance with the entity and `Styles` component.
let mut sb = new;
/// Apply one or more style functions.
self.styles.apply;
/// Call `.finish()` to write out the changes.
sb.finish;
Most style components such as BackgroundColor
are modified immediately, however Style
is
treated as a special case because it has so many properties: it's cached in the StyleBuilder
instance and then flushed out at the end via finish()
.