bevy_extended_ui 1.7.0

Create simply ui's with css and html for 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
use crate::services::image_service::get_or_load_image;
use crate::styles::paint::Colored;
use crate::styles::{CssClass, CssSource, TagName};
use crate::widgets::widget_util::wheel_delta_y;
use crate::widgets::{
    ActiveScrollTarget, BindToID, ChoiceOption, IgnoreParentState, ListBox, UIGenID, UIWidgetState,
    WidgetId, WidgetKind,
};
use crate::{CurrentWidgetState, ExtendedUiConfiguration, ImageCache};
use bevy::camera::visibility::RenderLayers;
use bevy::input::mouse::MouseWheel;
use bevy::prelude::*;
use bevy::ui::RelativeCursorPosition;

/// Marker component for initialized list box widgets.
#[derive(Component)]
struct ListBoxBase;

/// Marker component for individual list box option entries.
#[derive(Component)]
pub(crate) struct ListBoxOptionBase;

/// Plugin that registers list box widget behavior.
pub struct ListBoxWidget;

impl Plugin for ListBoxWidget {
    /// Registers systems for list box setup and interaction.
    fn build(&self, app: &mut App) {
        app.add_systems(
            Update,
            (internal_node_creation_system, handle_scroll_events).chain(),
        );
    }
}

/// System that initializes internal UI nodes for [`ListBox`] components.
///
/// Builds a scrollable list of option entries. Each option is always visible
/// (unlike `ChoiceBox` which hides options behind a dropdown).
///
/// Supports `multiselect`: clicking an option toggles it.
/// In single-select mode clicking an option deselects any previously selected one.
fn internal_node_creation_system(
    mut commands: Commands,
    query: Query<
        (Entity, &UIGenID, &ListBox, Option<&CssSource>),
        (With<ListBox>, Without<ListBoxBase>),
    >,
    config: Res<ExtendedUiConfiguration>,
    asset_server: Res<AssetServer>,
    mut image_cache: ResMut<ImageCache>,
    mut images: ResMut<Assets<Image>>,
) {
    let layer = config.render_layers.first().unwrap_or(&1);
    for (entity, id, list_box, source_opt) in query.iter() {
        let mut css_source = CssSource::default();
        if let Some(source) = source_opt {
            css_source = source.clone();
        }

        commands
            .entity(entity)
            .insert((
                Name::new(format!("List-Box-{}", list_box.entry)),
                Node::default(),
                WidgetId {
                    id: list_box.entry,
                    kind: WidgetKind::ListBox,
                },
                BackgroundColor::default(),
                ImageNode::default(),
                BorderColor::default(),
                BoxShadow::new(
                    Colored::TRANSPARENT,
                    Val::Px(0.),
                    Val::Px(0.),
                    Val::Px(0.),
                    Val::Px(0.),
                ),
                ZIndex::default(),
                Pickable::default(),
                css_source.clone(),
                TagName("listbox".to_string()),
                RenderLayers::layer(*layer),
                ScrollPosition::default(),
                RelativeCursorPosition::default(),
                ListBoxBase,
            ))
            .insert(GlobalZIndex::default())
            .observe(on_internal_click)
            .observe(on_internal_cursor_entered)
            .observe(on_internal_cursor_leave)
            .with_children(|builder| {
                for option in list_box.options.iter() {
                    let is_selected = list_box.values.contains(option);

                    let state = UIWidgetState {
                        checked: is_selected,
                        ..default()
                    };

                    builder
                        .spawn((
                            Name::new(format!("ListBox-Option-{}", list_box.entry)),
                            Node::default(),
                            BackgroundColor::default(),
                            ImageNode::default(),
                            BorderColor::default(),
                            ZIndex::default(),
                            state.clone(),
                            IgnoreParentState,
                            option.clone(),
                            css_source.clone(),
                            CssClass(vec![String::from("listbox-option")]),
                            RenderLayers::layer(*layer),
                            ListBoxOptionBase,
                            BindToID(id.0),
                        ))
                        .observe(on_option_click)
                        .observe(on_option_cursor_entered)
                        .observe(on_option_cursor_leave)
                        .with_children(|builder| {
                            if let Some(icon_path) = option.icon_path.as_deref() {
                                let handle = get_or_load_image(
                                    icon_path,
                                    &mut image_cache,
                                    &mut images,
                                    &asset_server,
                                );

                                builder.spawn((
                                    Name::new(format!("ListBox-Option-Icon-{}", list_box.entry)),
                                    ImageNode {
                                        image: handle,
                                        ..default()
                                    },
                                    ZIndex::default(),
                                    state.clone(),
                                    IgnoreParentState,
                                    css_source.clone(),
                                    CssClass(vec![
                                        String::from("option-icon"),
                                        String::from("option-text"),
                                    ]),
                                    Pickable::IGNORE,
                                    RenderLayers::layer(*layer),
                                    BindToID(id.0),
                                ));
                            }

                            let text = if option.text.trim().is_empty() {
                                Text::new("(empty)")
                            } else {
                                Text::new(option.text.clone())
                            };

                            builder.spawn((
                                Name::new(format!("ListBox-Option-Text-{}", list_box.entry)),
                                text,
                                TextColor::default(),
                                TextFont::default(),
                                TextLayout::default(),
                                ZIndex::default(),
                                state.clone(),
                                IgnoreParentState,
                                css_source.clone(),
                                CssClass(vec![String::from("option-text")]),
                                Pickable::IGNORE,
                                RenderLayers::layer(*layer),
                                BindToID(id.0),
                            ));
                        });
                }
            });
    }
}

/// Enables mouse-wheel scrolling within a [`ListBox`].
fn handle_scroll_events(
    mut scroll_events: MessageReader<MouseWheel>,
    active_scroll_target: Res<ActiveScrollTarget>,
    mut layout_query: Query<
        (
            Entity,
            &Visibility,
            &Children,
            &mut ScrollPosition,
            &ComputedNode,
            &RelativeCursorPosition,
        ),
        With<ListBoxBase>,
    >,
    option_query: Query<(&ComputedNode, &ChildOf), With<ListBoxOptionBase>>,
    time: Res<Time>,
) {
    let smooth_factor = 30.0;

    for event in scroll_events.read() {
        for (layout_entity, visibility, children, mut scroll, layout_computed, cursor_pos) in
            layout_query.iter_mut()
        {
            let is_visible = matches!(*visibility, Visibility::Visible | Visibility::Inherited);
            if !is_visible || cursor_pos.normalized.is_none() {
                continue;
            }

            if active_scroll_target.entity != Some(layout_entity) {
                continue;
            }

            let inv_sf = layout_computed.inverse_scale_factor.max(f32::EPSILON);
            let delta = -wheel_delta_y(event, inv_sf);

            if children.is_empty() {
                scroll.y = 0.0;
                continue;
            }

            let mut option_height = None;
            for (opt_computed, parent) in option_query.iter() {
                if parent.parent() == layout_entity {
                    let opt_inv_sf = opt_computed.inverse_scale_factor.max(f32::EPSILON);
                    option_height = Some((opt_computed.size().y * opt_inv_sf).max(1.0));
                    break;
                }
            }

            let option_h = option_height.unwrap_or(40.0);
            let measured_viewport = (layout_computed.size().y * inv_sf).max(1.0);
            let content_h = children.len() as f32 * option_h;
            let max_scroll = (content_h - measured_viewport).max(0.0);

            let target = (scroll.y + delta).clamp(0.0, max_scroll);
            let smoothed = scroll.y + (target - scroll.y) * smooth_factor * time.delta_secs();
            scroll.y = smoothed.clamp(0.0, max_scroll);
        }
    }
}

// ===============================================
//                   Intern Events
// ===============================================

/// Handles click events on the [`ListBox`] background (focus tracking).
fn on_internal_click(
    mut trigger: On<Pointer<Click>>,
    mut query: Query<(&mut UIWidgetState, &UIGenID), With<ListBox>>,
    mut current_widget_state: ResMut<CurrentWidgetState>,
) {
    if let Ok((mut state, gen_id)) = query.get_mut(trigger.entity) {
        state.focused = true;
        current_widget_state.widget_id = gen_id.0;
    }

    trigger.propagate(false);
}

/// Sets `hovered = true` on a [`ListBox`] when the cursor enters.
fn on_internal_cursor_entered(
    mut trigger: On<Pointer<Over>>,
    mut query: Query<&mut UIWidgetState, With<ListBox>>,
    mut active_scroll_target: ResMut<ActiveScrollTarget>,
) {
    if let Ok(mut state) = query.get_mut(trigger.entity) {
        state.hovered = true;
        active_scroll_target.entity = Some(trigger.entity);
    }

    trigger.propagate(false);
}

/// Sets `hovered = false` on a [`ListBox`] when the cursor leaves.
fn on_internal_cursor_leave(
    mut trigger: On<Pointer<Out>>,
    mut query: Query<&mut UIWidgetState, With<ListBox>>,
    mut active_scroll_target: ResMut<ActiveScrollTarget>,
) {
    if let Ok(mut state) = query.get_mut(trigger.entity) {
        state.hovered = false;
        if active_scroll_target.entity == Some(trigger.entity) {
            active_scroll_target.entity = None;
        }
    }

    trigger.propagate(false);
}

/// Handles selection when a list box option is clicked.
///
/// In multiselect mode the option's `checked` state is toggled.
/// In single-select mode all other options are unchecked and the clicked one is checked.
fn on_option_click(
    mut trigger: On<Pointer<Click>>,
    mut option_query: Query<
        (
            Entity,
            &mut UIWidgetState,
            &ChoiceOption,
            &BindToID,
            &Children,
        ),
        With<ListBoxOptionBase>,
    >,
    mut parent_query: Query<(&UIGenID, &mut ListBox), Without<ListBoxOptionBase>>,
    mut inner_query: Query<&mut UIWidgetState, (Without<ListBoxOptionBase>, Without<ListBox>)>,
) {
    let clicked_entity = trigger.entity;

    let (clicked_parent_id, clicked_option, was_checked) =
        if let Ok((_, state, option, bind_id, _)) = option_query.get(clicked_entity) {
            (bind_id.0, option.clone(), state.checked)
        } else {
            return;
        };

    let Some((_, mut list_box)) = parent_query
        .iter_mut()
        .find(|(id, _)| id.0 == clicked_parent_id)
    else {
        return;
    };

    if list_box.multiselect {
        let new_checked = !was_checked;
        if let Ok((_, mut state, _, _, children)) = option_query.get_mut(clicked_entity) {
            sync_option_checked_state(new_checked, &mut state, children, &mut inner_query);
        }

        if new_checked {
            if !list_box.values.contains(&clicked_option) {
                list_box.values.push(clicked_option);
            }
        } else {
            list_box.values.retain(|option| option != &clicked_option);
        }

        trigger.propagate(false);
        return;
    }

    // Update checked states on all sibling options.
    for (entity, mut state, _, bind_id, children) in option_query.iter_mut() {
        if bind_id.0 != clicked_parent_id {
            continue;
        }

        sync_option_checked_state(
            entity == clicked_entity,
            &mut state,
            children,
            &mut inner_query,
        );
    }

    let selected_values = vec![clicked_option];
    if list_box.values != selected_values {
        list_box.values = selected_values;
    }

    trigger.propagate(false);
}

fn sync_option_checked_state(
    checked: bool,
    state: &mut UIWidgetState,
    children: &Children,
    inner_query: &mut Query<&mut UIWidgetState, (Without<ListBoxOptionBase>, Without<ListBox>)>,
) {
    if state.checked == checked {
        return;
    }

    state.checked = checked;
    for child in children.iter() {
        if let Ok(mut inner_state) = inner_query.get_mut(child) {
            inner_state.checked = checked;
        }
    }
}

/// Sets `hovered = true` on a list box option and its visual children.
fn on_option_cursor_entered(
    trigger: On<Pointer<Over>>,
    mut query: Query<(&mut UIWidgetState, &Children), With<ListBoxOptionBase>>,
    mut inner_query: Query<&mut UIWidgetState, Without<ListBoxOptionBase>>,
) {
    if let Ok((mut state, children)) = query.get_mut(trigger.entity) {
        if state.hovered {
            return;
        }
        state.hovered = true;

        for child in children.iter() {
            if let Ok(mut inner_state) = inner_query.get_mut(child) {
                inner_state.hovered = true;
            }
        }
    }
}

/// Sets `hovered = false` on a list box option and its visual children.
fn on_option_cursor_leave(
    trigger: On<Pointer<Out>>,
    mut query: Query<(&mut UIWidgetState, &Children), With<ListBoxOptionBase>>,
    mut inner_query: Query<&mut UIWidgetState, Without<ListBoxOptionBase>>,
) {
    if let Ok((mut state, children)) = query.get_mut(trigger.entity) {
        if !state.hovered {
            return;
        }
        state.hovered = false;

        for child in children.iter() {
            if let Ok(mut inner_state) = inner_query.get_mut(child) {
                inner_state.hovered = false;
            }
        }
    }
}