bevy_feathers 0.19.0

A collection of UI widgets for building editors and utilities in Bevy
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
use accesskit::Role;
use bevy_a11y::AccessibilityNode;
use bevy_app::{Plugin, PreUpdate};
use bevy_ecs::{
    bundle::Bundle,
    children,
    component::Component,
    entity::Entity,
    hierarchy::Children,
    lifecycle::RemovedComponents,
    query::{Added, Changed, Has, Or, With},
    reflect::ReflectComponent,
    schedule::IntoScheduleConfigs,
    system::{Commands, Query},
    world::Mut,
};
use bevy_input_focus::tab_navigation::TabIndex;
use bevy_picking::{hover::Hovered, PickingSystems};
use bevy_reflect::{prelude::ReflectDefault, Reflect};
use bevy_scene::prelude::*;
use bevy_ui::{
    percent, px, BorderRadius, Checked, InteractionDisabled, Node, PositionType, Pressed, UiRect,
};
use bevy_ui_widgets::{ActivateOnPress, Checkbox};

use crate::{
    constants::size,
    cursor::EntityCursor,
    focus::FocusIndicator,
    theme::{ThemeBackgroundColor, ThemeBorderColor},
    tokens,
};

/// A toggle switch widget.
///
/// This is spawnable by inheriting it as a "scene component".
///
/// # Emitted events
/// * [`bevy_ui_widgets::ValueChange<bool>`] with the new value when the toggle switch changes state.
///
/// These events can be disabled by adding an [`bevy_ui::InteractionDisabled`] component to the bundle
#[derive(SceneComponent, Default, Clone, Reflect)]
#[reflect(Component, Clone, Default)]
pub struct FeathersToggleSwitch;

impl FeathersToggleSwitch {
    fn scene() -> impl Scene {
        bsn! {
            Node {
                width: size::TOGGLE_WIDTH,
                height: size::TOGGLE_HEIGHT,
                border: px(2),
                border_radius: px(5),
            }
            Checkbox
            FeathersToggleSwitch
            ThemeBackgroundColor(tokens::SWITCH_BG)
            ThemeBorderColor(tokens::SWITCH_BORDER)
            AccessibilityNode(accesskit::Node::new(Role::Switch))
            Hovered
            EntityCursor::System(bevy_window::SystemCursorIcon::Pointer)
            TabIndex(0)
            FocusIndicator
            Children [(
                Node {
                    position_type: PositionType::Absolute,
                    left: percent(0),
                    top: px(0),
                    bottom: px(0),
                    width: percent(50),
                    border: px(2),
                    border_radius: px(3),
                }
                ToggleSwitchSlide
                ThemeBackgroundColor(tokens::SWITCH_SLIDE_BG)
                ThemeBorderColor(tokens::SWITCH_SLIDE_BORDER)
            )]
        }
    }
}

/// Marker for the toggle switch slide
#[derive(Component, Default, Clone, Reflect)]
#[reflect(Component, Clone, Default)]
struct ToggleSwitchSlide;

/// Template function to spawn a toggle switch.
///
/// # Arguments
/// * `props` - construction properties for the toggle switch.
/// * `overrides` - a bundle of components that are merged in with the normal toggle switch components.
///
/// # Emitted events
/// * [`bevy_ui_widgets::ValueChange<bool>`] with the new value when the toggle switch changes state.
///
/// These events can be disabled by adding an [`bevy_ui::InteractionDisabled`] component to the bundle
#[deprecated(since = "0.19.0", note = "Use the toggle_switch() BSN function")]
pub fn toggle_switch_bundle<B: Bundle>(overrides: B) -> impl Bundle {
    (
        Node {
            width: size::TOGGLE_WIDTH,
            height: size::TOGGLE_HEIGHT,
            border: UiRect::all(px(2)),
            border_radius: BorderRadius::all(px(5)),
            ..Default::default()
        },
        Checkbox,
        FeathersToggleSwitch,
        ThemeBackgroundColor(tokens::SWITCH_BG),
        ThemeBorderColor(tokens::SWITCH_BORDER),
        AccessibilityNode(accesskit::Node::new(Role::Switch)),
        Hovered::default(),
        EntityCursor::System(bevy_window::SystemCursorIcon::Pointer),
        TabIndex(0),
        FocusIndicator,
        overrides,
        children![(
            Node {
                position_type: PositionType::Absolute,
                left: percent(0),
                top: px(0),
                bottom: px(0),
                width: percent(50),
                border: UiRect::all(px(2)),
                border_radius: BorderRadius::all(px(3)),
                ..Default::default()
            },
            ToggleSwitchSlide,
            ThemeBackgroundColor(tokens::SWITCH_SLIDE_BG),
            ThemeBorderColor(tokens::SWITCH_SLIDE_BORDER)
        )],
    )
}

fn update_switch_styles(
    q_switches: Query<
        (
            Entity,
            Has<InteractionDisabled>,
            Has<Checked>,
            Has<Pressed>,
            Has<ActivateOnPress>,
            &Hovered,
            &ThemeBackgroundColor,
            &ThemeBorderColor,
        ),
        (
            With<FeathersToggleSwitch>,
            Or<(
                Changed<Hovered>,
                Added<Checked>,
                Added<Pressed>,
                Added<InteractionDisabled>,
            )>,
        ),
    >,
    q_children: Query<&Children>,
    mut q_slide: Query<
        (&mut Node, &ThemeBackgroundColor, &ThemeBorderColor),
        With<ToggleSwitchSlide>,
    >,
    mut commands: Commands,
) {
    for (
        switch_ent,
        disabled,
        checked,
        pressed,
        activate_on_press,
        hovered,
        outline_bg,
        outline_border,
    ) in q_switches.iter()
    {
        let Some(slide_ent) = q_children
            .iter_descendants(switch_ent)
            .find(|en| q_slide.contains(*en))
        else {
            continue;
        };
        // Safety: since we just checked the query, should always work.
        let (ref mut slide_style, slide_bg_color, slide_border_color) =
            q_slide.get_mut(slide_ent).unwrap();
        set_switch_styles(
            switch_ent,
            slide_ent,
            disabled,
            checked,
            pressed,
            hovered.0,
            activate_on_press,
            outline_bg,
            outline_border,
            slide_style,
            slide_bg_color,
            slide_border_color,
            &mut commands,
        );
    }
}

fn update_switch_styles_remove(
    q_switches: Query<
        (
            Entity,
            Has<InteractionDisabled>,
            Has<Checked>,
            Has<Pressed>,
            Has<ActivateOnPress>,
            &Hovered,
            &ThemeBackgroundColor,
            &ThemeBorderColor,
        ),
        With<FeathersToggleSwitch>,
    >,
    q_children: Query<&Children>,
    mut q_slide: Query<
        (&mut Node, &ThemeBackgroundColor, &ThemeBorderColor),
        With<ToggleSwitchSlide>,
    >,
    mut removed_disabled: RemovedComponents<InteractionDisabled>,
    mut removed_checked: RemovedComponents<Checked>,
    mut remove_pressed: RemovedComponents<Pressed>,
    mut remove_activate_on_press: RemovedComponents<ActivateOnPress>,
    mut commands: Commands,
) {
    removed_disabled
        .read()
        .chain(removed_checked.read())
        .chain(remove_pressed.read())
        .chain(remove_activate_on_press.read())
        .for_each(|ent| {
            if let Ok((
                switch_ent,
                disabled,
                checked,
                pressed,
                activate_on_press,
                hovered,
                outline_bg,
                outline_border,
            )) = q_switches.get(ent)
            {
                let Some(slide_ent) = q_children
                    .iter_descendants(switch_ent)
                    .find(|en| q_slide.contains(*en))
                else {
                    return;
                };
                // Safety: since we just checked the query, should always work.
                let (ref mut slide_style, slide_bg_color, slide_border_color) =
                    q_slide.get_mut(slide_ent).unwrap();
                set_switch_styles(
                    switch_ent,
                    slide_ent,
                    disabled,
                    checked,
                    pressed,
                    hovered.0,
                    activate_on_press,
                    outline_bg,
                    outline_border,
                    slide_style,
                    slide_bg_color,
                    slide_border_color,
                    &mut commands,
                );
            }
        });
}

fn set_switch_styles(
    switch_ent: Entity,
    slide_ent: Entity,
    disabled: bool,
    checked: bool,
    pressed: bool,
    hovered: bool,
    activate_on_press: bool,
    outline_bg: &ThemeBackgroundColor,
    outline_border: &ThemeBorderColor,
    slide_style: &mut Mut<Node>,
    slide_bg_color: &ThemeBackgroundColor,
    slide_border_color: &ThemeBorderColor,
    commands: &mut Commands,
) {
    let outline_border_token = if checked {
        if disabled {
            tokens::SWITCH_BORDER_CHECKED_DISABLED
        } else if pressed && !activate_on_press {
            tokens::SWITCH_BORDER_CHECKED_PRESSED
        } else if hovered {
            tokens::SWITCH_BORDER_CHECKED_HOVER
        } else {
            tokens::SWITCH_BORDER_CHECKED
        }
    } else {
        if disabled {
            tokens::SWITCH_BORDER_DISABLED
        } else if pressed && !activate_on_press {
            tokens::SWITCH_BORDER_PRESSED
        } else if hovered {
            tokens::SWITCH_BORDER_HOVER
        } else {
            tokens::SWITCH_BORDER
        }
    };

    let outline_bg_token = if checked {
        if disabled {
            tokens::SWITCH_BG_CHECKED_DISABLED
        } else if pressed && !activate_on_press {
            tokens::SWITCH_BG_CHECKED_PRESSED
        } else if hovered {
            tokens::SWITCH_BG_CHECKED_HOVER
        } else {
            tokens::SWITCH_BG_CHECKED
        }
    } else {
        if disabled {
            tokens::SWITCH_BG_DISABLED
        } else if pressed && !activate_on_press {
            tokens::SWITCH_BG_PRESSED
        } else if hovered {
            tokens::SWITCH_BG_HOVER
        } else {
            tokens::SWITCH_BG
        }
    };

    let slide_border_token = if checked {
        if disabled {
            tokens::SWITCH_SLIDE_BORDER_CHECKED_DISABLED
        } else if pressed && !activate_on_press {
            tokens::SWITCH_SLIDE_BORDER_CHECKED_PRESSED
        } else if hovered {
            tokens::SWITCH_SLIDE_BORDER_CHECKED_HOVER
        } else {
            tokens::SWITCH_SLIDE_BORDER_CHECKED
        }
    } else {
        if disabled {
            tokens::SWITCH_SLIDE_BORDER_DISABLED
        } else if pressed && !activate_on_press {
            tokens::SWITCH_SLIDE_BORDER_PRESSED
        } else if hovered {
            tokens::SWITCH_SLIDE_BORDER_HOVER
        } else {
            tokens::SWITCH_SLIDE_BORDER
        }
    };

    let slide_bg_token = if checked {
        if disabled {
            tokens::SWITCH_SLIDE_BG_CHECKED_DISABLED
        } else if pressed && !activate_on_press {
            tokens::SWITCH_SLIDE_BG_CHECKED_PRESSED
        } else if hovered {
            tokens::SWITCH_SLIDE_BG_CHECKED_HOVER
        } else {
            tokens::SWITCH_SLIDE_BG_CHECKED
        }
    } else {
        if disabled {
            tokens::SWITCH_SLIDE_BG_DISABLED
        } else if pressed && !activate_on_press {
            tokens::SWITCH_SLIDE_BG_PRESSED
        } else if hovered {
            tokens::SWITCH_SLIDE_BG_HOVER
        } else {
            tokens::SWITCH_SLIDE_BG
        }
    };

    let slide_pos = match checked {
        true => percent(50),
        false => percent(0),
    };

    let cursor_shape = match disabled {
        true => bevy_window::SystemCursorIcon::NotAllowed,
        false => bevy_window::SystemCursorIcon::Pointer,
    };

    // Change outline background
    if outline_bg.0 != outline_bg_token {
        commands
            .entity(switch_ent)
            .insert(ThemeBackgroundColor(outline_bg_token));
    }

    // Change outline border
    if outline_border.0 != outline_border_token {
        commands
            .entity(switch_ent)
            .insert(ThemeBorderColor(outline_border_token));
    }

    // Change slide background color
    if slide_bg_color.0 != slide_bg_token {
        commands
            .entity(slide_ent)
            .insert(ThemeBackgroundColor(slide_bg_token));
    }

    // Change slide border color
    if slide_border_color.0 != slide_border_token {
        commands
            .entity(slide_ent)
            .insert(ThemeBorderColor(slide_border_token));
    }

    // Change slide position
    if slide_pos != slide_style.left {
        slide_style.left = slide_pos;
    }

    // Change cursor shape
    commands
        .entity(switch_ent)
        .insert(EntityCursor::System(cursor_shape));
}

/// Plugin which registers the systems for updating the toggle switch styles.
pub struct ToggleSwitchPlugin;

impl Plugin for ToggleSwitchPlugin {
    fn build(&self, app: &mut bevy_app::App) {
        app.add_systems(
            PreUpdate,
            (update_switch_styles, update_switch_styles_remove).in_set(PickingSystems::Last),
        );
    }
}