Crate tomt_bevycss

Crate tomt_bevycss 

Source
Expand description

TOMT_BevyCSS BevyECSS Bevy

MIT/Apache 2.0 Realease Doc Rust Crate Bevy tracking

§TOMT BevyCSS

§What is TOMT BevyCSS?

TOMT BevyCSS is a fork project derived from Bevy ECSS, which allows the usage of a subset of CSS to interact with bevy_ecs. It’s mainly aimed to apply styling on bevy_ui but it can be used by any component by implementing custom properties.

The primary goals for this project fork are as follows:

  • Provide more frequent updates for downstream crates
  • Improve upon and expand the existing documentation, tests and examples for downstream users
  • Expand on the feature set currently offered by BevyECSS

§Package name?

  • TOMT = Tome of Many Things
  • BevyCSS = Bevy + CSS, This library brings CSS features into the Bevy UI

§Who is TOMT (Tome of Many Things)?

Tome of Many Things is a small friendship group with various internet projects, primarily focussing on the Tome of Many Things YouTube channel.

This library project is brought to you by TheBeardedQuack (GitHub, YouTube), forked from BevyECSS, and released under the same MIT and Apahe v2.0 licences to allow for continued freedom of use, modification and distribution.

This crate marks the first public release from both Tome of Many Things.

§Changes from BevyECSS

Version Change Log
0.4.0
  • Fixes
    • Respects CSS rule ordering
  • Features
    • Support for pseudo-classes
      • Support for :hover and :click on Interaction component
      • No additional pseudo-classes implemented at this time
    • Placeholder support for pseudo-properties
      • No pseudo-properties implemented at this time
    • Reapply styles based on ECS changes (add/modify of UI node)
    • Additional contexts for auto keyword
  • Documentation
    • Added pseudo-class interaction to the example "theme"
    • Added an example to specifically demonstrate pseudo-class support
0.4.1
  • Documentation
    • ReadMe split into smaller documents
    • Updated project references after fork
0.4.2
  • Fixes
    • Optimised select_entities() when triggered by Changed<> by searching only direct ancestors and children of the modified node
  • Documentation
    • Added changelog and future goals for the project
    • Fixed broken doc links after project fork
0.5.0
  • Dependencies
    • bevy - Updated to 0.11
    • bevy_editor_pls - Removed until updated for bevy 0.11
    • cssparser - Updated to 0.30.0
  • Features
    • overflow css property split into overflow-x and overflow-y to reflect changes to bevy::ui::Overflow
  • Fixed
    • Fixed a bug causing some UI items to not have styling applied until they were updated
  • Documentation
    • Details of changes between bevy 0.10 and 0.11 support (mainly in Features above)
    • Minor format and phrasing changes for readme
    • Added entity # to some of the trace log outputs to help with diagnosing issues
0.5.1
  • Fixed
    • Fixed a bug causing some UI items to not have styling applied until they were updated individually (applying many styles at once caused overwrites)
0.6.0
  • Dependencies
    • bevy - Updated to 0.12
    • bevy_editor_pls - Restored and updated to 0.7
0.6.1
  • Documentation
    • Fixed some errors in latest readme
0.7.0
  • Dependencies
    • bevy - Updated to 0.13.2
    • bevy_editor_pls - Updated to 0.8.1
    • smallvec - Updated to 1.13.2
    • cssparser - Updated to 0.34.0
  • Documentation
    • Added missing `menu` example to Cargo.toml
    • Added contributors to thank you note

§Future Goals

  • Update crate dependencies
  • Backport fixes into BevyECSS They’ve caught up in there own style
  • Higher level language support (LESS / SCSS / SASS)
  • Add CSS color functions

§Getting Started (Usage)

To use TOMT_BevyCSS just add a StyleSheet with a loaded css file to any entity and all style sheet rules will be applied to the entity and all its descendants (children of children of children and so on).

use bevy::prelude::*;
use tomt_bevycss::prelude::*;

fn setup_awesome_ui(
    root: Entity,
    mut commands: Commands,
    asset_server: Res<AssetServer>
) {
    commands
        .entity(root)
        .insert(StyleSheet::new(asset_server.load("sheets/awesome.css")));
}

That’s it, now your UI will indeed look awesome!

§CSS Support

This crate aims to support the most common CSS features first, and add more over time as suggestions are provided. This for now means that only a subset of CSS features are provided.

To view the currently supported CSS features, please see CSS Support (docs/css-support.md).

§Custom Component Selector

TOMT_BevyCSS supports custom component selectors so you’re not limited to components provided by bevy.

Should you need a core bevy component available as a selector that is not currently supported, this feature can also be used to roll your own support. Should you decide to roll your own selector for any bevy built-in componenets, pull requests will be appreciated.

ⓘ
app.register_component_selector::<MyComponent>("selectorname");

See Custom Components (docs/custom-components.md) for more information.

§Custom Property

TOMT_BevyCSS supports custom property setters.

This with the above custom component select should enable you to use the CSS system for more than just styling if you so desired.

ⓘ
#[derive(Default)]
pub(crate) struct MyProperty;

impl Property for MyProperty
{
    /* For implementation details please see:
       https://github.com/TheBeardedQuack/tomt_bevycss/tree/main/docs/custom-properties.md
    */
}

fn main()
{
    let mut app = App::new();
    app.register_property::<MyProperty>();
}

See Custom Properties (docs/custom-properties.md) for more information.

§Bevy support table

bevytomt_bevycss
0.80.1
0.90.2
0.100.3
0.100.4.x
0.110.5.x
0.120.6.x
0.130.7.x

§Contributing

Got some idea, feedback, question or found a bug? Feel free to open an issue at any time!

§License

TOMT_BevyCSS is dual-licensed under either:

This means you can select the license you prefer! This dual-licensing approach is the de-facto standard in the Rust ecosystem and there are very good reasons to include both.

While these are the licenses we’ve inherited from original crate, it is a concious decision for the ToMT_BevyCSS project to maintain this dual-license approach, on the existing licenses.

§Special Thanks

I’d like to say a quick thank you to those who’ve contributed with development of this crate.

  • afonsolage - Original author of BevyECSS, from which this project is forked
  • Leinnan - Bevy 0.12 support
  • AmonDeShir - Bevy 0.13, 0.14 support
  • cndheat - Beta testing and feedback, with usage in a game

Modules§

error
plugins
prelude
use tomt_bevycss::prelude::*; to import common components, and plugins and utility functions.
property
system

Traits§

RegisterComponentSelector
Utility trait which adds the register_component_selector function on App to add a new component selector.
RegisterProperty
Utility trait which adds the register_property function on App to add a Property parser.