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
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
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
//! # Bevy Material UI
//!
//! Material Design 3 UI components for the Bevy game engine.
//!
//! This library provides a comprehensive set of UI components following
//! [Material Design 3](https://m3.material.io/) guidelines, implemented
//! as Bevy ECS components and systems.
//!
//! ## Features
//!
//! - **Theme System**: Complete MD3 color scheme with light/dark mode support
//! - **Components**: Button, Card, Checkbox, Dialog, Divider, FAB, List, Menu,
//!   Progress, Radio, Ripple, Select, Slider, Switch, Tabs, TextField
//! - **Accessibility**: Built-in support for focus rings
//! - **Customization**: Token-based styling system for easy theming
//!
//! ## Quick Start
//!
//! ```rust,no_run
//! use bevy::prelude::*;
//! use bevy_material_ui::prelude::*;
//!
//! fn main() {
//!     App::new()
//!         .add_plugins(DefaultPlugins)
//!         .add_plugins(MaterialUiPlugin)
//!         .add_systems(Startup, setup)
//!         .run();
//! }
//!
//! fn setup(mut commands: Commands, theme: Res<MaterialTheme>) {
//!     commands.spawn(Camera2d);
//!     
//!     // Create a filled button
//!     commands.spawn(
//!         MaterialButtonBuilder::new("Click Me")
//!             .filled()
//!             .build(&theme)
//!     );
//! }
//! ```
//!
//! ## Architecture
//!
//! This library follows patterns from the official Material Design implementations:
//! - [material-web](https://github.com/material-components/material-web)
//! - [material-components-flutter](https://github.com/material-components/material-components-flutter)

#![allow(clippy::type_complexity)]
#![allow(clippy::too_many_arguments)]

use bevy::prelude::*;

// ============================================================================
// Core modules
// ============================================================================

/// Theme and color system based on Material Design 3
pub mod theme;

/// Locale configuration and locale-driven defaults
pub mod locale;

/// Runtime localization / translation (i18n)
pub mod i18n;

/// HCT color space and dynamic color generation
pub mod color;

/// Embedded icon system
pub mod icons;

/// Typography scale definitions
pub mod typography;

/// Spacing, corner radius, duration, and easing tokens
pub mod tokens;

/// Elevation and shadow utilities
pub mod elevation;

/// Focus ring component for accessibility
pub mod focus;

/// Ripple effect component for touch feedback
pub mod ripple;

/// Telemetry and test automation support
pub mod telemetry;

// ============================================================================
// Component modules
// ============================================================================

/// Button components (filled, outlined, text, elevated, tonal)
pub mod button;

/// Button groups / segmented buttons (toggle groups)
pub mod button_group;

/// Icon button component
pub mod icon_button;

/// Floating Action Button (FAB) component
pub mod fab;

/// Card components (elevated, filled, outlined)
pub mod card;

/// Checkbox component
pub mod checkbox;

/// Radio button component
pub mod radio;

/// Switch/toggle component
pub mod switch;

/// Slider component
pub mod slider;

/// Text field components (filled, outlined)
pub mod text_field;

/// Progress indicators (linear and circular)
pub mod progress;

/// Dialog component
pub mod dialog;

/// Date picker component (Material Design 3)
pub mod date_picker;

/// Time picker component (Material Design 3)
pub mod time_picker;

/// List and list item components
pub mod list;

/// Menu and menu item components
pub mod menu;

/// Tabs component
pub mod tabs;

/// Divider component
pub mod divider;

/// Select/dropdown component
pub mod select;

/// Adaptive layout utilities (window size classes)
pub mod adaptive;

/// Material layout components (e.g. Scaffold)
pub mod layout;

/// Motion and animation utilities
pub mod motion;

/// Snackbar component for brief messages
pub mod snackbar;

/// Chip components for filters, actions, and tags
pub mod chip;

/// App bar components (top and bottom)
pub mod app_bar;

/// Badge component for notifications
pub mod badge;

/// Tooltip component for contextual help
pub mod tooltip;

/// Scroll container for scrollable content
pub mod scroll;

/// Search bar component
pub mod search;

/// Toolbar component
pub mod toolbar;

/// Loading indicator component
pub mod loading_indicator;

// ============================================================================
// Prelude
// ============================================================================

/// Prelude module for convenient imports
pub mod prelude {
    // Re-export Bevy UI types for convenience
    pub use bevy::ui::{
        BackgroundGradient, BorderGradient, ColorStop, ConicGradient, Gradient, LinearGradient,
        RadialGradient,
    };
    pub use bevy::ui::{BoxShadow, Outline, ShadowStyle};

    // Core
    pub use crate::elevation::{Elevation, ElevationShadow};
    pub use crate::focus::{
        create_native_focus_outline, FocusGained, FocusLost, FocusPlugin, FocusRing, Focusable,
    };
    pub use crate::i18n::{
        LocalizedText, MaterialI18n, MaterialI18nPlugin, MaterialLanguage,
        MaterialLanguageOverride, MaterialTranslations,
    };
    pub use crate::ripple::{Ripple, RippleHost, RipplePlugin, SpawnRipple};
    pub use crate::telemetry::{
        test_id_if_enabled, ElementBounds, InsertTestId, TelemetryConfig, TelemetryPlugin, TestId,
    };
    pub use crate::theme::{ColorScheme, MaterialTheme};
    pub use crate::tokens::{CornerRadius, Duration, Easing, Spacing};
    pub use crate::typography::Typography;

    // Color System
    pub use crate::color::{Hct, MaterialColorScheme, TonalPalette};

    // Icons
    pub use crate::icons::{material_icons, MaterialIcon, MaterialIconsPlugin};

    // Button
    pub use crate::button::{
        material_button_bundle, spawn_material_button, ButtonClickEvent, ButtonLabel, ButtonPlugin,
        ButtonVariant, MaterialButton, MaterialButtonBuilder, SpawnButtonChild,
    };

    // Button Group
    pub use crate::button_group::{
        ButtonGroupBuilder, ButtonGroupOrientation, ButtonGroupPlugin, MaterialButtonGroup,
    };

    // Icon Button
    pub use crate::icon_button::{
        IconButtonBuilder, IconButtonClickEvent, IconButtonPlugin, IconButtonVariant,
        MaterialIconButton, SpawnIconButtonChild, ICON_BUTTON_SIZE, ICON_SIZE,
    };

    // FAB
    pub use crate::fab::{
        FabBuilder, FabClickEvent, FabColor, FabLabel, FabPlugin, FabSize, MaterialFab,
        SpawnFabChild,
    };

    // Card
    pub use crate::card::{
        CardBuilder, CardClickEvent, CardPlugin, CardVariant, MaterialCard, SpawnCardChild,
    };

    // Checkbox
    pub use crate::checkbox::{
        CheckboxBox, CheckboxBuilder, CheckboxChangeEvent, CheckboxIcon, CheckboxPlugin,
        CheckboxState, MaterialCheckbox, SpawnCheckbox, SpawnCheckboxChild, CHECKBOX_SIZE,
        CHECKBOX_TOUCH_TARGET,
    };

    // Radio
    pub use crate::radio::{
        MaterialRadio, RadioBuilder, RadioChangeEvent, RadioGroup, RadioInner, RadioOuter,
        RadioPlugin, RadioStateLayer, SpawnRadio, SpawnRadioChild, RADIO_DOT_SIZE, RADIO_SIZE,
        RADIO_TOUCH_TARGET,
    };

    // Switch
    pub use crate::switch::{
        MaterialSwitch, SpawnSwitch, SpawnSwitchChild, SwitchBuilder, SwitchChangeEvent,
        SwitchHandle, SwitchPlugin, SwitchStateLayer, SWITCH_HANDLE_SIZE_PRESSED,
        SWITCH_HANDLE_SIZE_SELECTED, SWITCH_HANDLE_SIZE_UNSELECTED, SWITCH_TRACK_HEIGHT,
        SWITCH_TRACK_WIDTH,
    };

    // Slider
    pub use crate::slider::{
        MaterialSlider, SliderActiveTrack, SliderBuilder, SliderChangeEvent, SliderHandle,
        SliderLabel, SliderPlugin, SliderTraceSettings, SliderTrack, SpawnSliderChild,
        SLIDER_HANDLE_SIZE, SLIDER_HANDLE_SIZE_PRESSED, SLIDER_LABEL_HEIGHT, SLIDER_TICK_SIZE,
        SLIDER_TRACK_HEIGHT, SLIDER_TRACK_HEIGHT_ACTIVE,
    };

    // Text Field
    pub use crate::text_field::{
        MaterialTextField, SpawnTextFieldChild, TextFieldBuilder, TextFieldChangeEvent,
        TextFieldFormatter, TextFieldInput, TextFieldLabel, TextFieldPlugin, TextFieldSubmitEvent,
        TextFieldSupportingText, TextFieldVariant, TEXT_FIELD_HEIGHT, TEXT_FIELD_MIN_WIDTH,
    };

    // Progress
    pub use crate::progress::{
        CircularProgressBuilder, LinearProgressBuilder, MaterialCircularProgress,
        MaterialLinearProgress, ProgressIndicator, ProgressMode, ProgressPlugin, ProgressTrack,
        ProgressVariant, SpawnProgressChild, CIRCULAR_PROGRESS_SIZE, CIRCULAR_PROGRESS_TRACK_WIDTH,
        LINEAR_PROGRESS_HEIGHT,
    };

    // Dialog
    pub use crate::dialog::{
        create_dialog_scrim, create_dialog_scrim_for, DialogActions, DialogBuilder,
        DialogCloseEvent, DialogConfirmEvent, DialogContent, DialogHeadline, DialogOpenEvent,
        DialogPlugin, DialogScrim, DialogType, MaterialDialog, MaterialDialogAnchor,
        MaterialDialogPlacement, SpawnDialogChild, DIALOG_MAX_WIDTH, DIALOG_MIN_WIDTH,
    };

    // Date Picker
    pub use crate::date_picker::{
        CalendarConstraints, Date, DateInputMode, DatePickerBuilder, DatePickerCancelEvent,
        DatePickerMode, DatePickerSubmitEvent, DateSelection, DateSelector, DateValidator,
        MaterialDatePicker, Month, RangeDateSelector, SingleDateSelector, SpawnDatePicker, Weekday,
    };

    // Time Picker
    pub use crate::time_picker::{
        MaterialTimePicker, SpawnTimePicker, TimeFormat, TimeInputMode, TimePeriod,
        TimePickerBuilder, TimePickerCancelEvent, TimePickerSubmitEvent,
    };

    // List
    pub use crate::list::{
        create_list_divider, ListBuilder, ListDivider, ListItemBody, ListItemBuilder,
        ListItemClickEvent, ListItemHeadline, ListItemLeading, ListItemSupportingText,
        ListItemTrailing, ListItemVariant, ListPlugin, ListSelectionMode, MaterialList,
        MaterialListItem, ScrollableList, SpawnListChild,
    };

    // Menu
    pub use crate::menu::{
        create_menu_divider, MaterialMenu, MaterialMenuItem, MenuAnchor, MenuBuilder,
        MenuCloseEvent, MenuDivider, MenuItemBuilder, MenuItemSelectEvent, MenuOpenEvent,
        MenuPlugin, SpawnMenuChild, MENU_ITEM_HEIGHT, MENU_MAX_WIDTH, MENU_MIN_WIDTH,
    };

    // Tabs
    pub use crate::tabs::{
        create_tab_indicator, MaterialTab, MaterialTabs, SpawnTabsChild, TabBuilder,
        TabChangeEvent, TabContent, TabIndicator, TabLabelText, TabVariant, TabsBuilder,
        TabsPlugin, TAB_HEIGHT_PRIMARY, TAB_HEIGHT_PRIMARY_ICON_ONLY, TAB_HEIGHT_SECONDARY,
        TAB_INDICATOR_HEIGHT,
    };

    // Divider
    pub use crate::divider::{
        horizontal_divider, inset_divider, vertical_divider, DividerBuilder, DividerVariant,
        MaterialDivider, SpawnDividerChild, DIVIDER_INSET, DIVIDER_THICKNESS,
    };

    // Select
    pub use crate::select::{
        MaterialSelect, SelectBuilder, SelectChangeEvent, SelectContainer, SelectDisplayText,
        SelectDropdown, SelectOption, SelectOptionItem, SelectPlugin, SelectTrigger, SelectVariant,
        SpawnSelectChild, SELECT_HEIGHT, SELECT_OPTION_HEIGHT,
    };

    // Adaptive Layout
    pub use crate::adaptive::{
        WindowHeightClass, WindowSizeClass, WindowSizeClassChanged, WindowSizeClassPlugin,
        WindowWidthClass,
    };

    // Layout
    pub use crate::layout::{
        spawn_adaptive_navigation_scaffold, spawn_bottom_navigation_scaffold,
        spawn_list_detail_scaffold, spawn_modal_drawer_scaffold,
        spawn_navigation_bar_scaffold, spawn_navigation_rail_scaffold,
        spawn_navigation_suite_scaffold, spawn_permanent_drawer_scaffold,
        spawn_standard_drawer_scaffold, spawn_supporting_panes_scaffold,
        AdaptiveNavigationScaffold, BottomNavigationScaffold, ListDetailScaffold,
        ModalDrawerScaffold, NavigationBarScaffold, NavigationRailScaffold,
        NavigationSuiteScaffold, PaneEntities, PaneTestIds, PermanentDrawerScaffold,
        ScaffoldEntities, ScaffoldTestIds, StandardDrawerScaffold, SupportingPanesScaffold,
    };

    // Search
    pub use crate::search::{
        MaterialSearchBar, SearchBarAction, SearchBarBuilder, SearchBarClickEvent,
        SearchBarNavigation, SearchPlugin, SearchQueryEvent, SpawnSearchBarChild,
        SEARCH_BAR_HEIGHT,
    };

    // Toolbar
    pub use crate::toolbar::{
        MaterialToolbar, SpawnToolbarChild, ToolbarAction, ToolbarActionEvent, ToolbarBuilder,
        ToolbarNavigationEvent, ToolbarPlugin, TOOLBAR_HEIGHT, TOOLBAR_ICON_SIZE,
    };

    // Loading Indicator
    pub use crate::loading_indicator::{
        LoadingIndicatorBuilder, LoadingIndicatorPlugin, LoadingShape, MaterialLoadingIndicator,
        ShapeMorphMaterial, SpawnLoadingIndicatorChild, LOADING_INDICATOR_SIZE,
    };

    // Motion
    pub use crate::motion::{
        ease_emphasized, ease_emphasized_accelerate, ease_emphasized_decelerate, ease_standard,
        ease_standard_accelerate, ease_standard_decelerate, AnimatedValue, MotionPlugin,
        SpringConfig, StateLayer,
    };

    // Snackbar
    pub use crate::snackbar::{
        spawn_snackbar, DismissSnackbar, ShowSnackbar, Snackbar, SnackbarActionEvent,
        SnackbarAnimationState, SnackbarBuilder, SnackbarHostBuilder, SnackbarPlugin,
        SnackbarPosition, SnackbarQueue, SpawnSnackbarChild, SNACKBAR_MAX_WIDTH,
    };

    // Chip
    pub use crate::chip::{
        ChipBuilder, ChipClickEvent, ChipDeleteButton, ChipDeleteEvent, ChipLabel, ChipLeadingIcon,
        ChipPlugin, ChipVariant, MaterialChip, SpawnChipChild, CHIP_HEIGHT,
    };

    // App Bar
    pub use crate::app_bar::{
        AppBarPlugin, BottomAppBar, BottomAppBarBuilder, SpawnAppBarChild, TopAppBar,
        TopAppBarBuilder, TopAppBarVariant, BOTTOM_APP_BAR_HEIGHT, TOP_APP_BAR_HEIGHT_LARGE,
        TOP_APP_BAR_HEIGHT_MEDIUM, TOP_APP_BAR_HEIGHT_SMALL,
    };

    // Badge
    pub use crate::badge::{
        BadgeBuilder, BadgeContent, BadgePlugin, MaterialBadge, SpawnBadgeChild, BADGE_SIZE_LARGE,
        BADGE_SIZE_SMALL,
    };

    // Tooltip
    pub use crate::tooltip::{
        spawn_rich_tooltip, spawn_tooltip, RichTooltip, SpawnTooltipChild, Tooltip,
        TooltipAnimationState, TooltipPlugin, TooltipPosition, TooltipText, TooltipTrigger,
        TooltipTriggerBuilder, TooltipVariant, TOOLTIP_DELAY_DEFAULT, TOOLTIP_DELAY_SHORT,
        TOOLTIP_HEIGHT_PLAIN, TOOLTIP_MAX_WIDTH, TOOLTIP_OFFSET,
    };

    // Scroll Container
    pub use crate::scroll::{
        spawn_scrollbars, ScrollContainer, ScrollContainerBuilder, ScrollContent, ScrollDirection,
        ScrollPlugin, ScrollbarThumbHorizontal, ScrollbarThumbVertical, ScrollbarTrackHorizontal,
        ScrollbarTrackVertical,
    };

    // Main plugin
    pub use crate::MaterialUiPlugin;
}

// ============================================================================
// Main Plugin
// ============================================================================

/// Main plugin that adds all Material UI functionality to your Bevy app.
///
/// This plugin will:
/// - Initialize the Material theme resource
/// - Add component plugins for all components
/// - Set up the focus and ripple systems
///
/// # Example
///
/// ```rust,no_run
/// use bevy::prelude::*;
/// use bevy_material_ui::MaterialUiPlugin;
///
/// App::new()
///     .add_plugins(DefaultPlugins)
///     .add_plugins(MaterialUiPlugin)
///     .run();
/// ```
pub struct MaterialUiPlugin;

impl Plugin for MaterialUiPlugin {
    fn build(&self, app: &mut App) {
        // Core systems (theme, icons, focus, ripple).
        app.add_plugins(MaterialUiCorePlugin);

        // Component plugins
        app.add_plugins((
            button::ButtonPlugin,
            icon_button::IconButtonPlugin,
            fab::FabPlugin,
            card::CardPlugin,
            checkbox::CheckboxPlugin,
            radio::RadioPlugin,
            switch::SwitchPlugin,
            slider::SliderPlugin,
            text_field::TextFieldPlugin,
            progress::ProgressPlugin,
            dialog::DialogPlugin,
            list::ListPlugin,
            menu::MenuPlugin,
            tabs::TabsPlugin,
            select::SelectPlugin,
        ));

        // Keep plugin tuples under Bevy's arity limit.
        app.add_plugins(button_group::ButtonGroupPlugin);

        // New component plugins
        app.add_plugins((
            motion::MotionPlugin,
            snackbar::SnackbarPlugin,
            chip::ChipPlugin,
            app_bar::AppBarPlugin,
            badge::BadgePlugin,
            tooltip::TooltipPlugin,
            scroll::ScrollPlugin,
            date_picker::DatePickerPlugin,
            time_picker::TimePickerPlugin,
            search::SearchPlugin,
            toolbar::ToolbarPlugin,
            loading_indicator::LoadingIndicatorPlugin,
        ));

        // Adaptive layout
        app.add_plugins(adaptive::WindowSizeClassPlugin);
    }
}

/// Core plugin that provides the shared foundations required by most components.
///
/// This is intended to be used as an internal dependency for component plugins
/// so downstream users can do either of:
/// - `app.add_plugins(MaterialUiPlugin)` (everything)
/// - `app.add_plugins(ButtonPlugin)` (single component; core dependencies auto-added)
pub struct MaterialUiCorePlugin;

impl Plugin for MaterialUiCorePlugin {
    fn build(&self, app: &mut App) {
        // Theme is a resource; initializing it is idempotent.
        app.init_resource::<theme::MaterialTheme>();

        // Locale is a resource; initializing it is idempotent.
        app.init_resource::<locale::MaterialLocale>();

        // i18n is a plugin (assets + systems), so guard it.
        if !app.is_plugin_added::<i18n::MaterialI18nPlugin>() {
            app.add_plugins(i18n::MaterialI18nPlugin);
        }

        // These are true plugins (adding twice panics), so guard them.
        if !app.is_plugin_added::<focus::FocusPlugin>() {
            app.add_plugins(focus::FocusPlugin);
        }
        if !app.is_plugin_added::<ripple::RipplePlugin>() {
            app.add_plugins(ripple::RipplePlugin);
        }
        if !app.is_plugin_added::<icons::MaterialIconsPlugin>() {
            app.add_plugins(icons::MaterialIconsPlugin);
        }
    }
}

/// A plugin group that adds Material UI plugins in stages.
/// Use this if you want more control over which plugins are added.
pub struct MaterialUiPlugins;

impl PluginGroup for MaterialUiPlugins {
    fn build(self) -> bevy::app::PluginGroupBuilder {
        bevy::app::PluginGroupBuilder::start::<Self>().add(MaterialUiPlugin)
    }
}