Mudblazor

MudBlazor - Consumer Usage Guide

MudBlazor is a Material Design component library for Blazor built entirely in pure C#/Razor with no web components or shadow DOM.

Version scope: Written for modern MudBlazor projects on .NET 8+ Blazor with interactive rendering.

Official docs: https://mudblazor.com/
Component demos: https://mudblazor.com/components/

Decision Order

When building or refactoring UI with MudBlazor, make decisions in this order:

1. Use an existing MudBlazor component and its parameters.
2. Compose MudBlazor layout primitives such as MudStack, MudGrid, MudItem, MudPaper, MudContainer, and MudSpacer.
3. Apply MudBlazor utility classes in the component Class attribute for spacing, alignment, display, and sizing.
4. Use theme configuration or built-in component properties such as Color, Variant, Typo, Elevation, Dense, and GutterSize.
5. Only then consider isolated .razor.css, and only when the requirement cannot be achieved by the options above.

Custom CSS is an exception, not a normal implementation tool. Raw HTML should be limited to framework-owned host elements or cases where MudBlazor genuinely has no suitable equivalent.

Setup

NuGet Package

<PackageReference Include="MudBlazor" />

If your repository uses Central Package Management, define or update the MudBlazor version in Directory.Packages.props via <PackageVersion Include="MudBlazor" Version="..." />.

Program.cs

builder.Services.AddMudServices();
// Or with configuration:
builder.Services.AddMudServices(config =>
{
    config.SnackbarConfiguration.PositionClass = Defaults.Classes.Position.BottomRight;
    config.SnackbarConfiguration.PreventDuplicates = false;
});

_Imports.razor

@using MudBlazor

MainLayout.razor - Required Providers

The following components MUST appear in MainLayout.razor for services to work:

<MudThemeProvider />
<MudPopoverProvider />   <!-- required for dropdowns, autocomplete, select -->
<MudDialogProvider />
<MudSnackbarProvider />

Without MudPopoverProvider, popup components (autocomplete, select) will render nothing.

Layout Structure

Use the official MudBlazor template shape as a starting point:

<MudLayout>
    <MudAppBar Elevation="1">
        <MudIconButton Icon="@Icons.Material.Filled.Menu" Color="Color.Inherit"
                       Edge="Edge.Start" />
        <MudText Typo="Typo.h6">Application</MudText>
        <MudSpacer />
    </MudAppBar>

    <MudDrawer @bind-Open="_drawerOpen" Elevation="2" ClipMode="DrawerClipMode.Always">
        <MudNavMenu>
            <MudNavLink Href="/" Match="NavLinkMatch.All"
                        Icon="@Icons.Material.Filled.Dashboard">Dashboard</MudNavLink>
            <MudNavLink Href="/items" Icon="@Icons.Material.Filled.Inventory2">Items</MudNavLink>
            <MudNavLink Href="/settings"
                        Icon="@Icons.Material.Filled.Settings">Settings</MudNavLink>
        </MudNavMenu>
    </MudDrawer>

    <MudMainContent Class="pt-16 pa-4">
        @Body
    </MudMainContent>
</MudLayout>

Use page-level MudContainer, MudPaper, MudStack, and MudGrid composition inside @Body rather than reworking MainLayout with bespoke wrappers or CSS.

Styling Guidance

• Prefer component parameters and composition over styling.
• Prefer MudBlazor utility classes such as pa-4, pt-16, mt-4, d-flex, justify-end, and align-center before writing CSS.
• Prefer MudStack or MudGrid over raw <div> elements used only for layout.
• Prefer MudText, MudAlert, MudChip, MudPaper, and MudDivider over styled HTML elements.
• Do not add <style> blocks to Razor files.
• Only create or extend .razor.css when the requirement cannot be met through components, parameters, theme settings, or utility classes. Keep the CSS isolated and minimal.

Component Quick Reference

See references/COMPONENT-CHOOSER.md for the full mapping.

Reference Map

Use these references after the chooser points you to a component family:

• references/INPUTS.md for text, selection, picker, upload, and validation-oriented input components.
• references/BUTTONS.md for action components, grouped actions, floating actions, and icon toggle actions.
• references/LAYOUT-NAVIGATION.md for shell structure, responsive layout, menus, and navigation components.
• references/DATA-DISPLAY.md for tabular, list, timeline, tree, card, and media display components.
• references/FEEDBACK-OVERLAYS.md for alerts, progress, dialogs, snackbars, overlays, and placeholders.
• references/DATAGRID.md for detailed MudDataGrid<T> usage patterns.
• references/KNOWN-PITFALLS.md for operational troubleshooting.
• references/THEMING.md for palette and typography customisation.
• references/BUNIT.md for component testing patterns when bUnit is already in use.

Text Input

<MudTextField @bind-Value="_value" Label="Name" Variant="Variant.Outlined" />
<MudTextField @bind-Value="_search" Label="Search" Adornment="Adornment.End"
              AdornmentIcon="@Icons.Material.Filled.Search" />
<MudTextField @bind-Value="_multi" Label="Description" Lines="4" />

Select

<MudSelect @bind-Value="_selected" Label="Category" Variant="Variant.Outlined">
    @foreach (var option in _options)
    {
        <MudSelectItem Value="@option">@option.Name</MudSelectItem>
    }
</MudSelect>

Autocomplete (multi-select)

<MudAutocomplete T="string" Label="Items" @bind-Value="_item"
                 SearchFunc="@SearchItems" Variant="Variant.Outlined" />

Checkbox

<MudCheckBox @bind-Value="_checked" Label="Apply to all items" />

Button

<MudButton Variant="Variant.Filled" Color="Color.Primary"
<MudButton Variant="Variant.Text" Color="Color.Secondary"
<MudIconButton Icon="@Icons.Material.Filled.Delete" Color="Color.Error" />

Colour Picker

<MudColorPicker @bind-Text="_colour" Label="Accent colour"
                ColorPickerMode="ColorPickerMode.HEX"
                Variant="Variant.Outlined" />

@bind-Text binds to a hex string (e.g. "#d73a4a"). Use @bind-Value to bind to a MudColor value object instead.

Data Grid

See references/DATAGRID.md for full grid patterns.

<MudDataGrid Items="@_items" Filterable="true" SortMode="SortMode.Multiple"
             Hover="true" Striped="true" Dense="true">
    <Columns>
        <PropertyColumn Property="x => x.Name" Title="Name" />
        <PropertyColumn Property="x => x.Status" Title="Status" />
        <TemplateColumn Title="Actions" CellClass="d-flex justify-end">
            <CellTemplate>
                <MudIconButton Size="Size.Small" Icon="@Icons.Material.Filled.Edit"
                               => Edit(context.Item))" />
            </CellTemplate>
        </TemplateColumn>
    </Columns>
</MudDataGrid>

Dialog Service Pattern

Service injection

[Inject] private IDialogService DialogService { get; set; } = default!;

Opening a dialog

var parameters = new DialogParameters<MyDialog>
{
    { x => x.Item, _selectedItem }
};
var options = new DialogOptions { MaxWidth = MaxWidth.Small, FullWidth = true };
var dialog = await DialogService.ShowAsync<MyDialog>("Edit Item", parameters, options);
var result = await dialog.Result;

if (!result.Canceled)
{
    // handle confirmed result
}

Dialog component

@* MyDialog.razor *@
<MudDialog>
    <TitleContent>Edit Item</TitleContent>
    <DialogContent>
        <MudTextField @bind-Value="_name" Label="Name" />
    </DialogContent>
    <DialogActions>
        <MudButton
        <MudButton Color="Color.Primary"
    </DialogActions>
</MudDialog>

@code {
    [CascadingParameter] private IMudDialogInstance MudDialog { get; set; } = default!;
    [Parameter] public ItemDto Item { get; set; } = default!;

    private string _name = string.Empty;

    protected override void OnParametersSet() => _name = Item.Name;

    private void Cancel() => MudDialog.Cancel();
    private void Submit() => MudDialog.Close(DialogResult.Ok(_name));
}

Snackbar / Notification Pattern

[Inject] private ISnackbar Snackbar { get; set; } = default!;

// Usage:
Snackbar.Add("Item created successfully.", Severity.Success);
Snackbar.Add("Failed to create item.", Severity.Error);
Snackbar.Add("No items selected.", Severity.Warning);

Loading State Pattern

@if (_loading)
{
    <MudProgressCircular Color="Color.Primary" Indeterminate="true" />
}
else
{
    @* content *@
}

Icons

MudBlazor includes Material Icons:

Icon="@Icons.Material.Filled.Inventory2"   @* filled variant *@
Icon="@Icons.Material.Outlined.Delete"     @* outlined variant *@
Icon="@Icons.Material.TwoTone.Settings"    @* two-tone variant *@

Theming

See references/THEMING.md for custom palette setup.

@* MainLayout.razor *@
<MudThemeProvider Theme="_theme" />

@code {
    private MudTheme _theme = new()
    {
        PaletteLight = new PaletteLight
        {
            Primary = "#1976D2",
            Secondary = "#424242",
            AppbarBackground = "#1976D2"
        }
    };
}

Known Pitfalls

See references/KNOWN-PITFALLS.md for full details and troubleshooting steps.

Quick checks:

• Provider components missing in MainLayout.razor (MudPopoverProvider, MudDialogProvider, MudSnackbarProvider) cause silent UI failures.
• Two-way binding on MudColorPicker should use @bind-Text for hex strings.
• Custom CSS should remain a fallback after components, parameters, theme settings, and utility classes.

Optional bUnit Testing

Use the test framework already present in the repository. If bUnit is already in use, see references/BUNIT.md for setup patterns and examples.

// Register MudBlazor services in the test context
ctx.Services.AddMudServices();

// Suppress MudBlazor JS interop calls that surface in unit tests
ctx.JSInterop.Mode = JSRuntimeMode.Loose;