https://github.com/ickshonpe/bevy_ui_borders

https://github.com/ickshonpe/bevy_ui_borders

Last synced: 24 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/ickshonpe/bevy_ui_borders
• Owner: ickshonpe
• License: mit
• Created: 2023-03-02T12:15:20.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-03-18T15:39:23.000Z (almost 2 years ago)
• Last Synced: 2024-11-16T18:43:34.998Z (about 1 month ago)
• Language: Rust
• Size: 41 KB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# bevy_ui_borders

[![crates.io](https://img.shields.io/crates/v/bevy_ui_borders)](https://crates.io/crates/bevy_ui_borders)

[![MIT/Apache 2.0](https://img.shields.io/badge/license-MIT%2FApache-blue.svg)](https://github.com/ickshonpe/bevy_ui_borders)

[![crates.io](https://img.shields.io/crates/d/bevy_ui_borders)](https://crates.io/crates/bevy_ui_borders)

## Draw borders around Bevy UI Nodes

![image](borders_example.png)

* A Bevy plugin that adds border and outline rendering to UI nodes.

* Supports Bevy 0.10

* Only supports solid one-colour borders due to the limitations of the current Bevy UI renderer.

#

## Usage

Add the dependency to your Bevy project:

```

cargo add bevy_ui_borders

```

To display a bordered UI node:

* Add the `BordersPlugin` plugin to your app.

* Spawn an entity with a `BorderColor` component and a `NodeBundle` where the `border` field of its `Style` component is set to a non-zero thickness.

## Components

* `BorderColor`: Defines the color of a UI node's border.

* `Outline`: Specifies the color and thickness of the outline around the UI node's border.

## Bundles

* `BorderedNodeBundle`: A bundle for creating UI nodes with a border and outline.

* `BorderBundle`: A bundle for adding border and outline components to an existing UI node.

## Example

To draw a white UI node with a red border:

```rust

use bevy::prelude::*;

use bevy_ui_borders::*;

fn main() {

    App::new()

        .add_plugins(DefaultPlugins)

        .add_plugin(BordersPlugin)

        .add_startup_system(spawn_example)

        .run();

}

fn spawn_example(mut commands: Commands) {

    commands.spawn(Camera2dBundle::default());

    commands.spawn((

        NodeBundle {

            style: Style {

                size: Size::new(Val::Px(100.), Val::Px(100.)),

                margin: UiRect::all(Val::Px(100.)),

                border: UiRect::all(Val::Px(10.)),

                ..Default::default()

            },

            background_color: Color::WHITE.into(),

            ..Default::default()

        },

        BorderColor(Color::RED),

    ));       

}

```

#

## Examples

```

cargo --run --example minimal

cargo --run --example tiles

cargo --run --example outlines

cargo --run --example stress

```