README.md

Material Design components for Blazor

MudBlazor is an ambitious Material Design component framework for Blazor with an emphasis on ease of use and clear structure. It is perfect for .NET developers who want to rapidly build web applications without having to struggle with CSS and Javascript. MudBlazor, being written entirely in C#, empowers you to adapt, fix or extend the framework. There are plenty of examples in the documentation, which makes understanding and learning MudBlazor very easy.

Design goals:

• Clean and aesthetic graphic design based on Material Design.
• Clear and easy to understand structure.
• Good documentation with many examples and source snippets.
• All components are written entirely in C#, no JavaScript allowed (except where absolutely necessary).
• Users can make beautiful apps without needing CSS (but they can of course use CSS too)
• No dependencies on other component libraries, 100% control over components and features.
• Stability! We strive for a complete test coverage.
• Releasing often so developers can get their PRs and fixes in a timely fashion.

Documentation & Demo

• MudBlazor.com
• Try.MudBlazor.com

Prerequisites

• .NET 5.0 or .NET Core 3.1 (legacy)

Getting Started

• Full installation instructions can be found at mudblazor.com
• Alternatively use one of our templates from the MudBlazor.Templates repo.

Quick Installation Guide

Common Configuration (Client-Side or Server-Side)

Install Package

dotnet add package MudBlazor

Add the following to _Imports.razor

@using MudBlazor

Add the following to the MainLayout.razor or App.razor

<MudThemeProvider/>
<MudDialogProvider/>
<MudSnackbarProvider/>

Add the following to index.html (client-side) or _Host.cshtml (server-side) in the head

<link href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,700&display=swap" rel="stylesheet" />
<link href="_content/MudBlazor/MudBlazor.min.css" rel="stylesheet" />

Add the following to index.html or _Host.cshtml in the body

<script src="_content/MudBlazor/MudBlazor.min.js"></script>

Client-Side Configuration(WebAssembly)

Add the following to the relevant sections of Program.cs

using MudBlazor.Services;

builder.Services.AddMudServices();

Server-Side Configuration

Add the following to the relevant sections of Startup.cs

using MudBlazor.Services;

services.AddMudServices();

Usage

<Typography Typo="Typo.h6">MudBlazor is @Text</Typography>
<Button Variant="Variant.Contained" Color="Color.Primary" OnClick="ButtonOnClick">@ButtonText</Button>

@code {
  public string Text { get; set; } = "????";
  public string ButtonText { get; set; } = "Click Me";
  public int ButtonClicked { get; set; }
  
  void ButtonOnClick()
    {
        ButtonClicked += 1;
        Text = $"Awesome x {ButtonClicked}";
        ButtonText = "Click Me Again";
    }
}