Skip to content

Commit 65bddbd

Browse files
viridiaalice-i-cecile
viridia
and
alice-i-cecile
authored
Bevy Feathers: an opinionated widget toolkit for building Bevy tooling (#19730)
# Objective This PR introduces Bevy Feathers, an opinionated widget toolkit and theming system intended for use by the Bevy Editor, World Inspector, and other tools. The `bevy_feathers` crate is incomplete and hidden behind an experimental feature flag. The API is going to change significantly before release. --------- Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
1 parent fa9e303 commit 65bddbd

30 files changed

+1547
-2
lines changed

‎Cargo.toml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -306,6 +306,9 @@ bevy_input_focus = ["bevy_internal/bevy_input_focus"]
306306
# Headless widget collection for Bevy UI.
307307
bevy_core_widgets = ["bevy_internal/bevy_core_widgets"]
308308

309+
# Feathers widget collection.
310+
experimental_bevy_feathers = ["bevy_internal/bevy_feathers"]
311+
309312
# Enable passthrough loading for SPIR-V shaders (Only supported on Vulkan, shader capabilities and extensions must agree with the platform implementation)
310313
spirv_shader_passthrough = ["bevy_internal/spirv_shader_passthrough"]
311314

@@ -4526,3 +4529,16 @@ name = "Core Widgets (w/Observers)"
45264529
description = "Demonstrates use of core (headless) widgets in Bevy UI, with Observers"
45274530
category = "UI (User Interface)"
45284531
wasm = true
4532+
4533+
[[example]]
4534+
name = "feathers"
4535+
path = "examples/ui/feathers.rs"
4536+
doc-scrape-examples = true
4537+
required-features = ["experimental_bevy_feathers"]
4538+
4539+
[package.metadata.example.feathers]
4540+
name = "Feathers Widgets"
4541+
description = "Gallery of Feathers Widgets"
4542+
category = "UI (User Interface)"
4543+
wasm = true
4544+
hidden = true

‎crates/bevy_core_widgets/src/core_button.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ use bevy_ui::{InteractionDisabled, Pressed};
1818
/// Headless button widget. This widget maintains a "pressed" state, which is used to
1919
/// indicate whether the button is currently being pressed by the user. It emits a `ButtonClicked`
2020
/// event when the button is un-pressed.
21-
#[derive(Component, Debug)]
21+
#[derive(Component, Default, Debug)]
2222
#[require(AccessibilityNode(accesskit::Node::new(Role::Button)))]
2323
pub struct CoreButton {
2424
/// Optional system to run when the button is clicked, or when the Enter or Space key

‎crates/bevy_core_widgets/src/core_slider.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,9 @@ pub struct SliderValue(pub f32);
9292
#[derive(Component, Debug, PartialEq, Clone, Copy)]
9393
#[component(immutable)]
9494
pub struct SliderRange {
95+
/// The beginning of the allowed range for the slider value.
9596
start: f32,
97+
/// The end of the allowed range for the slider value.
9698
end: f32,
9799
}
98100

‎crates/bevy_feathers/Cargo.toml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
[package]
2+
name = "bevy_feathers"
3+
version = "0.17.0-dev"
4+
edition = "2024"
5+
description = "A collection of UI widgets for building editors and utilities in Bevy"
6+
homepage = "https://bevyengine.org"
7+
repository = "https://github.com/bevyengine/bevy"
8+
license = "MIT OR Apache-2.0"
9+
keywords = ["bevy"]
10+
11+
[dependencies]
12+
# bevy
13+
bevy_app = { path = "../bevy_app", version = "0.17.0-dev" }
14+
bevy_asset = { path = "../bevy_asset", version = "0.17.0-dev" }
15+
bevy_color = { path = "../bevy_color", version = "0.17.0-dev" }
16+
bevy_core_widgets = { path = "../bevy_core_widgets", version = "0.17.0-dev" }
17+
bevy_ecs = { path = "../bevy_ecs", version = "0.17.0-dev" }
18+
bevy_input_focus = { path = "../bevy_input_focus", version = "0.17.0-dev" }
19+
bevy_log = { path = "../bevy_log", version = "0.17.0-dev" }
20+
bevy_picking = { path = "../bevy_picking", version = "0.17.0-dev" }
21+
bevy_platform = { path = "../bevy_platform", version = "0.17.0-dev" }
22+
bevy_text = { path = "../bevy_text", version = "0.17.0-dev" }
23+
bevy_ui = { path = "../bevy_ui", version = "0.17.0-dev", features = [
24+
"bevy_ui_picking_backend",
25+
] }
26+
bevy_window = { path = "../bevy_window", version = "0.17.0-dev" }
27+
bevy_winit = { path = "../bevy_winit", version = "0.17.0-dev" }
28+
29+
# other
30+
accesskit = "0.19"
31+
32+
[features]
33+
default = []
34+
35+
[lints]
36+
workspace = true
37+
38+
[package.metadata.docs.rs]
39+
rustdoc-args = ["-Zunstable-options", "--generate-link-to-definition"]
40+
all-features = true

‎crates/bevy_feathers/src/assets/fonts/FiraMono-LICENSE

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
Digitized data copyright (c) 2012-2015, The Mozilla Foundation and Telefonica S.A.
2+
3+
This Font Software is licensed under the SIL Open Font License, Version 1.1.
4+
This license is copied below, and is also available with a FAQ at:
5+
http://scripts.sil.org/OFL
6+
7+
8+
-----------------------------------------------------------
9+
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
10+
-----------------------------------------------------------
11+
12+
PREAMBLE
13+
The goals of the Open Font License (OFL) are to stimulate worldwide
14+
development of collaborative font projects, to support the font creation
15+
efforts of academic and linguistic communities, and to provide a free and
16+
open framework in which fonts may be shared and improved in partnership
17+
with others.
18+
19+
The OFL allows the licensed fonts to be used, studied, modified and
20+
redistributed freely as long as they are not sold by themselves. The
21+
fonts, including any derivative works, can be bundled, embedded,
22+
redistributed and/or sold with any software provided that any reserved
23+
names are not used by derivative works. The fonts and derivatives,
24+
however, cannot be released under any other type of license. The
25+
requirement for fonts to remain under this license does not apply
26+
to any document created using the fonts or their derivatives.
27+
28+
DEFINITIONS
29+
"Font Software" refers to the set of files released by the Copyright
30+
Holder(s) under this license and clearly marked as such. This may
31+
include source files, build scripts and documentation.
32+
33+
"Reserved Font Name" refers to any names specified as such after the
34+
copyright statement(s).
35+
36+
"Original Version" refers to the collection of Font Software components as
37+
distributed by the Copyright Holder(s).
38+
39+
"Modified Version" refers to any derivative made by adding to, deleting,
40+
or substituting -- in part or in whole -- any of the components of the
41+
Original Version, by changing formats or by porting the Font Software to a
42+
new environment.
43+
44+
"Author" refers to any designer, engineer, programmer, technical
45+
writer or other person who contributed to the Font Software.
46+
47+
PERMISSION & CONDITIONS
48+
Permission is hereby granted, free of charge, to any person obtaining
49+
a copy of the Font Software, to use, study, copy, merge, embed, modify,
50+
redistribute, and sell modified and unmodified copies of the Font
51+
Software, subject to the following conditions:
52+
53+
1) Neither the Font Software nor any of its individual components,
54+
in Original or Modified Versions, may be sold by itself.
55+
56+
2) Original or Modified Versions of the Font Software may be bundled,
57+
redistributed and/or sold with any software, provided that each copy
58+
contains the above copyright notice and this license. These can be
59+
included either as stand-alone text files, human-readable headers or
60+
in the appropriate machine-readable metadata fields within text or
61+
binary files as long as those fields can be easily viewed by the user.
62+
63+
3) No Modified Version of the Font Software may use the Reserved Font
64+
Name(s) unless explicit written permission is granted by the corresponding
65+
Copyright Holder. This restriction only applies to the primary font name as
66+
presented to the users.
67+
68+
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
69+
Software shall not be used to promote, endorse or advertise any
70+
Modified Version, except to acknowledge the contribution(s) of the
71+
Copyright Holder(s) and the Author(s) or with their explicit written
72+
permission.
73+
74+
5) The Font Software, modified or unmodified, in part or in whole,
75+
must be distributed entirely under this license, and must not be
76+
distributed under any other license. The requirement for fonts to
77+
remain under this license does not apply to any document created
78+
using the Font Software.
79+
80+
TERMINATION
81+
This license becomes null and void if any of the above conditions are
82+
not met.
83+
84+
DISCLAIMER
85+
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
86+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
87+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
88+
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
89+
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
90+
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
91+
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
92+
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
93+
OTHER DEALINGS IN THE FONT SOFTWARE.

‎crates/bevy_feathers/src/assets/fonts/FiraMono-Medium.ttf

169 KB
Binary file not shown.

‎crates/bevy_feathers/src/assets/fonts/FiraSans-Bold.ttf

463 KB
Binary file not shown.

‎crates/bevy_feathers/src/assets/fonts/FiraSans-BoldItalic.ttf

480 KB
Binary file not shown.

‎crates/bevy_feathers/src/assets/fonts/FiraSans-Italic.ttf

446 KB
Binary file not shown.

‎crates/bevy_feathers/src/assets/fonts/FiraSans-License.txt

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
Copyright (c) 2012-2015, The Mozilla Foundation and Telefonica S.A.
2+
3+
This Font Software is licensed under the SIL Open Font License, Version 1.1.
4+
This license is copied below, and is also available with a FAQ at:
5+
https://openfontlicense.org
6+
7+
8+
-----------------------------------------------------------
9+
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
10+
-----------------------------------------------------------
11+
12+
PREAMBLE
13+
The goals of the Open Font License (OFL) are to stimulate worldwide
14+
development of collaborative font projects, to support the font creation
15+
efforts of academic and linguistic communities, and to provide a free and
16+
open framework in which fonts may be shared and improved in partnership
17+
with others.
18+
19+
The OFL allows the licensed fonts to be used, studied, modified and
20+
redistributed freely as long as they are not sold by themselves. The
21+
fonts, including any derivative works, can be bundled, embedded,
22+
redistributed and/or sold with any software provided that any reserved
23+
names are not used by derivative works. The fonts and derivatives,
24+
however, cannot be released under any other type of license. The
25+
requirement for fonts to remain under this license does not apply
26+
to any document created using the fonts or their derivatives.
27+
28+
DEFINITIONS
29+
"Font Software" refers to the set of files released by the Copyright
30+
Holder(s) under this license and clearly marked as such. This may
31+
include source files, build scripts and documentation.
32+
33+
"Reserved Font Name" refers to any names specified as such after the
34+
copyright statement(s).
35+
36+
"Original Version" refers to the collection of Font Software components as
37+
distributed by the Copyright Holder(s).
38+
39+
"Modified Version" refers to any derivative made by adding to, deleting,
40+
or substituting -- in part or in whole -- any of the components of the
41+
Original Version, by changing formats or by porting the Font Software to a
42+
new environment.
43+
44+
"Author" refers to any designer, engineer, programmer, technical
45+
writer or other person who contributed to the Font Software.
46+
47+
PERMISSION & CONDITIONS
48+
Permission is hereby granted, free of charge, to any person obtaining
49+
a copy of the Font Software, to use, study, copy, merge, embed, modify,
50+
redistribute, and sell modified and unmodified copies of the Font
51+
Software, subject to the following conditions:
52+
53+
1) Neither the Font Software nor any of its individual components,
54+
in Original or Modified Versions, may be sold by itself.
55+
56+
2) Original or Modified Versions of the Font Software may be bundled,
57+
redistributed and/or sold with any software, provided that each copy
58+
contains the above copyright notice and this license. These can be
59+
included either as stand-alone text files, human-readable headers or
60+
in the appropriate machine-readable metadata fields within text or
61+
binary files as long as those fields can be easily viewed by the user.
62+
63+
3) No Modified Version of the Font Software may use the Reserved Font
64+
Name(s) unless explicit written permission is granted by the corresponding
65+
Copyright Holder. This restriction only applies to the primary font name as
66+
presented to the users.
67+
68+
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
69+
Software shall not be used to promote, endorse or advertise any
70+
Modified Version, except to acknowledge the contribution(s) of the
71+
Copyright Holder(s) and the Author(s) or with their explicit written
72+
permission.
73+
74+
5) The Font Software, modified or unmodified, in part or in whole,
75+
must be distributed entirely under this license, and must not be
76+
distributed under any other license. The requirement for fonts to
77+
remain under this license does not apply to any document created
78+
using the Font Software.
79+
80+
TERMINATION
81+
This license becomes null and void if any of the above conditions are
82+
not met.
83+
84+
DISCLAIMER
85+
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
86+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
87+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
88+
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
89+
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
90+
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
91+
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
92+
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
93+
OTHER DEALINGS IN THE FONT SOFTWARE.

0 commit comments

Comments
 (0)