bevy_material_ui 0.2.7

Material Design 3 UI components for Bevy game engine
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

use bevy::prelude::*;

use crate::theme::MaterialTheme;

use super::{ScaffoldEntities, ScaffoldTestIds};

/// Configuration for a modal/standard drawer scaffold (drawer + content + scrim).
#[derive(Debug, Clone)]
pub struct ModalDrawerScaffold {
    pub drawer_width_px: f32,
    pub root_padding_px: f32,
    pub content_padding_px: f32,
    pub scrim_color: Color,
    pub test_ids: ScaffoldTestIds,
}

impl Default for ModalDrawerScaffold {
    fn default() -> Self {
        Self {
            drawer_width_px: 280.0,
            root_padding_px: 0.0,
            content_padding_px: 0.0,
            scrim_color: Color::srgba(0.0, 0.0, 0.0, 0.32),
            test_ids: ScaffoldTestIds::default(),
        }
    }
}

/// Spawn a modal drawer scaffold. The drawer is always shown in this helper; show/hide
/// behavior can be layered by toggling `Visibility` on the returned entities.
pub fn spawn_modal_drawer_scaffold(
    parent: &mut ChildSpawnerCommands,
    theme: &MaterialTheme,
    config: &ModalDrawerScaffold,
    drawer_children: impl FnOnce(&mut ChildSpawnerCommands),
    content_children: impl FnOnce(&mut ChildSpawnerCommands),
) -> ScaffoldEntities {
    let mut navigation = Entity::PLACEHOLDER;
    let mut content = Entity::PLACEHOLDER;

    let root = parent
        .spawn((
            Node {
                width: Val::Percent(100.0),
                height: Val::Percent(100.0),
                flex_direction: FlexDirection::Row,
                padding: UiRect::all(Val::Px(config.root_padding_px)),
                ..default()
            },
            BackgroundColor(theme.surface.with_alpha(0.0)),
            config.test_ids.root.clone(),
        ))
        .with_children(|root| {
            // Scrim overlay (full size); by default visible. Consumers can toggle visibility.
            root.spawn((
                Node {
                    position_type: PositionType::Absolute,
                    left: Val::Px(0.0),
                    top: Val::Px(0.0),
                    width: Val::Percent(100.0),
                    height: Val::Percent(100.0),
                    ..default()
                },
                BackgroundColor(config.scrim_color),
                // No TestId for scrim; automation does not need it.
            ));

            navigation = root
                .spawn((
                    Node {
                        width: Val::Px(config.drawer_width_px),
                        height: Val::Percent(100.0),
                        flex_direction: FlexDirection::Column,
                        padding: UiRect::all(Val::Px(16.0)),
                        row_gap: Val::Px(8.0),
                        ..default()
                    },
                    BackgroundColor(theme.surface_container_low),
                    config.test_ids.navigation.clone(),
                ))
                .with_children(drawer_children)
                .id();

            content = root
                .spawn((
                    Node {
                        flex_grow: 1.0,
                        height: Val::Percent(100.0),
                        padding: UiRect::all(Val::Px(config.content_padding_px)),
                        overflow: Overflow::clip_y(),
                        ..default()
                    },
                    BackgroundColor(theme.surface),
                    config.test_ids.content.clone(),
                ))
                .with_children(content_children)
                .id();
        })
        .id();

    ScaffoldEntities {
        root,
        navigation,
        content,
    }
}