diff --git a/README.md b/README.md index 711f83c5e523..212327c5ef38 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ MudBlazor is an ambitious Material Design component framework for Blazor with an - [MudBlazor.com](https://mudblazor.com) - [Try.MudBlazor.com](https://try.mudblazor.com/) -### Why is MudBlazor so successful? +## Why is MudBlazor so successful? - Clean and aesthetic graphic design based on Material Design. - Clear and easy to understand structure. - Good documentation with many examples and source snippets. @@ -45,9 +45,9 @@ MudBlazor is an ambitious Material Design component framework for Blazor with an | 7.x.x | [.NET 7](https://dotnet.microsoft.com/download/dotnet/7.0), [.NET 8](https://dotnet.microsoft.com/download/dotnet/8.0) | :heavy_check_mark: | | 8.x.x | [.NET 8](https://dotnet.microsoft.com/download/dotnet/8.0), [.NET 9](https://dotnet.microsoft.com/download/dotnet/9.0) | :heavy_check_mark: | -\* Static rendering is not supported - [Learn more](https://learn.microsoft.com/aspnet/core/blazor/components/render-modes). - -\** We cannot guarantee compatibility with browsers no longer maintained by their publishers. +> [!WARNING] +> 1. Static rendering is not supported - [Learn more](https://learn.microsoft.com/aspnet/core/blazor/components/render-modes). +> 2. We cannot guarantee compatibility with browsers no longer maintained by their publishers. For the best experience, use an up-to-date browser - See [Blazor supported platforms](https://learn.microsoft.com/aspnet/core/blazor/supported-platforms). ## Stats @@ -64,8 +64,9 @@ Please note there is no guarantee your PR will be merged, so if you want to be s Check out the [contribution guidelines](/CONTRIBUTING.md) to understand our goals and learn more about the internals of the project. ## Getting Started -Full installation instructions can be found [on our website](https://mudblazor.com/getting-started/installation). -Alternatively use one of our templates from the [MudBlazor.Templates](https://github.com/mudblazor/Templates) repo. +We have premade templates available at the [MudBlazor.Templates](https://github.com/mudblazor/Templates) repository. + +Full installation instructions can be found [on our website](https://mudblazor.com/getting-started/installation). ### Quick Installation Guide Install Package @@ -103,19 +104,26 @@ builder.Services.AddMudServices(); ### Usage ```razor -MudBlazor is @Text -@ButtonText + + MudBlazor is @Text + + + + @ButtonText + @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"; - } + string Text { get; set; } = "????"; + string ButtonText { get; set; } = "Click Me"; + int ClickCount { get; set; } + + void ButtonOnClick() + { + ClickCount += 1; + Text = $"Awesome x {ClickCount}"; + ButtonText = "Click Me Again"; + } } ``` diff --git a/ROADMAP.md b/ROADMAP.md index 9863e1e0aaa5..8705b629917e 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -33,4 +33,4 @@ We appreciate your support as we continue to work on keeping MudBlazor the premi MudBlazor thrives thanks to the contributions of our amazing community. Whether you specialize in C#, Blazor, JavaScript, CSS, documentation, testing, or design, your help is always welcome in improving this project. -If you’re interested in contributing, please check out our [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines to get started. You can also open an issue, start a discussion, or tag a member of the team in relevant GitHub issues to collaborate with us. +If you’re interested in contributing, please check out [our contribution guidelines](https://github.com/MudBlazor/MudBlazor/blob/dev/CONTRIBUTING.md) to get started. You can also open an issue, start a discussion, or tag a member of the team in relevant GitHub issues to collaborate with us. diff --git a/src/.editorconfig b/src/.editorconfig index 3d8adfa4aabb..cc0c04c15397 100644 --- a/src/.editorconfig +++ b/src/.editorconfig @@ -244,52 +244,10 @@ csharp_prefer_braces = true:silent csharp_preserve_single_line_blocks = true csharp_preserve_single_line_statements = true -[src/CodeStyle/**.{cs,vb}] -# warning RS0005: Do not use generic CodeAction.Create to create CodeAction -dotnet_diagnostic.RS0005.severity = none - -[src/{Analyzers,CodeStyle,Features,Workspaces,EditorFeatures, VisualStudio}/**/*.{cs,vb}] - -# IDE0011: Add braces -csharp_prefer_braces = when_multiline:warning -# NOTE: We need the below severity entry for Add Braces due to https://github.com/dotnet/roslyn/issues/44201 -dotnet_diagnostic.IDE0011.severity = warning - -# IDE0040: Add accessibility modifiers -dotnet_diagnostic.IDE0040.severity = warning - -# CONSIDER: Are IDE0051 and IDE0052 too noisy to be warnings for IDE editing scenarios? Should they be made build-only warnings? -# IDE0051: Remove unused private member -dotnet_diagnostic.IDE0051.severity = warning - -# IDE0052: Remove unread private member -dotnet_diagnostic.IDE0052.severity = warning - -# IDE0059: Unnecessary assignment to a value -dotnet_diagnostic.IDE0059.severity = warning - -# IDE0060: Remove unused parameter -dotnet_diagnostic.IDE0060.severity = warning - -# CA1822: Make member static -dotnet_diagnostic.CA1822.severity = warning - -# Prefer "var" everywhere -dotnet_diagnostic.IDE0007.severity = warning -csharp_style_var_for_built_in_types = true:warning -csharp_style_var_when_type_is_apparent = true:warning -csharp_style_var_elsewhere = true:warning - -[src/{VisualStudio}/**/*.{cs,vb}] -# CA1822: Make member static -# Not enforced as a build 'warning' for 'VisualStudio' layer due to large number of false positives from https://github.com/dotnet/roslyn-analyzers/issues/3857 and https://github.com/dotnet/roslyn-analyzers/issues/3858 -# Additionally, there is a risk of accidentally breaking an internal API that partners rely on though IVT. -dotnet_diagnostic.CA1822.severity = suggestion - # MudBlazor Team Overrides # Settings in editorconfig are last in wins so add overrides here -[*.cs] +[*.{cs,razor}] # CS1591 Missing XML comment for publicly visible type or member # We should try and finish the documentation and remove this # For now its too noisy @@ -311,7 +269,7 @@ dotnet_diagnostic.BL0007.severity = suggestion # IDE0290 Use primary constructor dotnet_diagnostic.IDE0290.severity = none -[src/MudBlazor/**/*.{cs,razor}] +[MudBlazor/**/*.{cs,razor}] dotnet_style_namespace_match_folder = false resharper_check_namespace_highlighting = none diff --git a/src/MudBlazor.Docs/Components/ApiTypeHierarchy.razor b/src/MudBlazor.Docs/Components/ApiTypeHierarchy.razor index 2824e827ae1f..c9752dab5a48 100644 --- a/src/MudBlazor.Docs/Components/ApiTypeHierarchy.razor +++ b/src/MudBlazor.Docs/Components/ApiTypeHierarchy.razor @@ -16,6 +16,10 @@ @context.Text } + else if(context.Text == "Enum") + { + @context.Text + } else if (!string.IsNullOrEmpty(context.Value.ApiUrl)) { @context.Text diff --git a/src/MudBlazor.Docs/Components/DocsPageHeader.razor b/src/MudBlazor.Docs/Components/DocsPageHeader.razor index 196f25b54292..7aab6fe6d504 100644 --- a/src/MudBlazor.Docs/Components/DocsPageHeader.razor +++ b/src/MudBlazor.Docs/Components/DocsPageHeader.razor @@ -37,7 +37,7 @@ else diff --git a/src/MudBlazor.Docs/Shared/AppbarButtons.razor b/src/MudBlazor.Docs/Shared/AppbarButtons.razor index 9162e44fc7ec..e6f6b41ad76a 100644 --- a/src/MudBlazor.Docs/Shared/AppbarButtons.razor +++ b/src/MudBlazor.Docs/Shared/AppbarButtons.razor @@ -1,5 +1,5 @@ @using MudBlazor.Docs.Enums - +
@@ -27,9 +27,9 @@ - + - + \ No newline at end of file diff --git a/src/MudBlazor.Docs/Shared/MainLayout.razor.cs b/src/MudBlazor.Docs/Shared/MainLayout.razor.cs index cc136c066211..9636e38de85e 100644 --- a/src/MudBlazor.Docs/Shared/MainLayout.razor.cs +++ b/src/MudBlazor.Docs/Shared/MainLayout.razor.cs @@ -12,6 +12,11 @@ public partial class MainLayout : LayoutComponentBase, IDisposable private MudThemeProvider _mudThemeProvider; + static MainLayout() + { + MudGlobal.TooltipDefaults.Delay = TimeSpan.FromMilliseconds(500); + } + protected override void OnInitialized() { LayoutService.MajorUpdateOccurred += LayoutServiceOnMajorUpdateOccured; diff --git a/src/MudBlazor.UnitTests.Docs/MudBlazor.UnitTests.Docs.csproj b/src/MudBlazor.UnitTests.Docs/MudBlazor.UnitTests.Docs.csproj index 72ee3d2d81e6..0581ac127e12 100644 --- a/src/MudBlazor.UnitTests.Docs/MudBlazor.UnitTests.Docs.csproj +++ b/src/MudBlazor.UnitTests.Docs/MudBlazor.UnitTests.Docs.csproj @@ -67,7 +67,7 @@ - + diff --git a/src/MudBlazor.UnitTests.Shared/MudBlazor.UnitTests.Shared.csproj b/src/MudBlazor.UnitTests.Shared/MudBlazor.UnitTests.Shared.csproj index 5e3226a6bea7..38640a0ce53a 100644 --- a/src/MudBlazor.UnitTests.Shared/MudBlazor.UnitTests.Shared.csproj +++ b/src/MudBlazor.UnitTests.Shared/MudBlazor.UnitTests.Shared.csproj @@ -11,7 +11,7 @@ - + diff --git a/src/MudBlazor.UnitTests.Viewer/Pages/Index.razor b/src/MudBlazor.UnitTests.Viewer/Pages/Index.razor index 940af21bff28..55b12154aee0 100644 --- a/src/MudBlazor.UnitTests.Viewer/Pages/Index.razor +++ b/src/MudBlazor.UnitTests.Viewer/Pages/Index.razor @@ -4,7 +4,7 @@ - + @@ -14,7 +14,7 @@ - + @@ -40,7 +40,7 @@ - + @@ -99,10 +99,6 @@