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

use bevy::prelude::*;

use crate::{adaptive::WindowSizeClass, theme::MaterialTheme};

use super::{
    spawn_bottom_navigation_scaffold, spawn_navigation_rail_scaffold,
    spawn_permanent_drawer_scaffold, BottomNavigationScaffold, NavigationRailScaffold,
    PermanentDrawerScaffold, ScaffoldEntities,
};

/// Material 3 **navigation suite scaffold**.
///
/// Selects an appropriate navigation pattern based on Material window size classes.
#[derive(Debug, Clone, Default)]
pub struct AdaptiveNavigationScaffold {
    pub bottom: BottomNavigationScaffold,
    pub rail: NavigationRailScaffold,
    pub drawer: PermanentDrawerScaffold,
}

/// Spawn an adaptive navigation scaffold.
///
/// Mapping:
/// - `Large` / `ExtraLarge` => permanent (expanded) drawer
/// - `Medium` / `Expanded`  => navigation rail
/// - `Compact`              => bottom navigation
pub fn spawn_adaptive_navigation_scaffold(
    parent: &mut ChildSpawnerCommands,
    theme: &MaterialTheme,
    size_class: &WindowSizeClass,
    config: &AdaptiveNavigationScaffold,
    nav_children: impl FnOnce(&mut ChildSpawnerCommands),
    content_children: impl FnOnce(&mut ChildSpawnerCommands),
) -> ScaffoldEntities {
    if size_class.use_expanded_drawer() {
        spawn_permanent_drawer_scaffold(
            parent,
            theme,
            &config.drawer,
            nav_children,
            content_children,
        )
    } else if size_class.use_nav_rail() {
        spawn_navigation_rail_scaffold(parent, theme, &config.rail, nav_children, content_children)
    } else {
        // Bottom navigation places the nav slot after the content.
        spawn_bottom_navigation_scaffold(
            parent,
            theme,
            &config.bottom,
            content_children,
            nav_children,
        )
    }
}

/// Material 3 naming alias for [`AdaptiveNavigationScaffold`].
pub type NavigationSuiteScaffold = AdaptiveNavigationScaffold;

/// Material 3 naming alias for [`spawn_adaptive_navigation_scaffold`].
pub fn spawn_navigation_suite_scaffold(
    parent: &mut ChildSpawnerCommands,
    theme: &MaterialTheme,
    size_class: &WindowSizeClass,
    config: &NavigationSuiteScaffold,
    nav_children: impl FnOnce(&mut ChildSpawnerCommands),
    content_children: impl FnOnce(&mut ChildSpawnerCommands),
) -> ScaffoldEntities {
    spawn_adaptive_navigation_scaffold(
        parent,
        theme,
        size_class,
        config,
        nav_children,
        content_children,
    )
}