Skip to content

Commit 35b2a29

Browse files
Update README.md (#251)
formatting & small fixes
1 parent 53efdd0 commit 35b2a29

File tree

1 file changed

+26
-15
lines changed

1 file changed

+26
-15
lines changed

README.md

Lines changed: 26 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# CodeBeam.MudExtensions
2+
23
#### Useful third party extension components for MudBlazor, from the community contributors.
4+
35
##### `TheMudSecondary`
46

57
[![GitHub Repo stars](https://img.shields.io/github/stars/codebeamorg/codebeam.mudblazor.extensions?color=594ae2&style=flat-square&logo=github)](https://github.com/codebeamorg/codebeam.mudblazor.extensions/stargazers)
68
[![GitHub last commit](https://img.shields.io/github/last-commit/codebeamorg/codebeam.mudblazor.extensions?color=594ae2&style=flat-square&logo=github)](https://github.com/codebeamorg/codebeam.mudblazor.extensions)
79
[![Contributors](https://img.shields.io/github/contributors/codebeamorg/codebeam.mudblazor.extensions?color=594ae2&style=flat-square&logo=github)](https://github.com/codebeamorg/codebeam.mudblazor.extensions/graphs/contributors)
8-
[![Nuget version](https://img.shields.io/nuget/v/CodeBeam.mudblazor.extensions?color=ff4081&label=nuget%20version&logo=nuget&style=flat-square)](https://www.nuget.org/packages/CodeBeam.MudBlazor.Extensions)
9-
[![Nuget downloads](https://img.shields.io/nuget/dt/CodeBeam.mudblazor.extensions?color=ff4081&label=nuget%20downloads&logo=nuget&style=flat-square)](https://www.nuget.org/packages/CodeBeam.MudBlazor.Extensions)
10+
[![NuGet version](https://img.shields.io/nuget/v/CodeBeam.mudblazor.extensions?color=ff4081&label=nuget%20version&logo=nuget&style=flat-square)](https://www.nuget.org/packages/CodeBeam.MudBlazor.Extensions)
11+
[![NuGet downloads](https://img.shields.io/nuget/dt/CodeBeam.mudblazor.extensions?color=ff4081&label=nuget%20downloads&logo=nuget&style=flat-square)](https://www.nuget.org/packages/CodeBeam.MudBlazor.Extensions)
1012

1113
## Utilities
1214

@@ -49,54 +51,63 @@
4951
- MudSelectExtended
5052
- MudTextFieldExtended
5153

52-
5354
## Playground
55+
5456
- **Docs**
5557
https://codebeam-mudextensions.pages.dev/
5658
- **Try MudExtensions**
5759
https://trymudextensions.pages.dev/
5860

5961
## Breaking Changes
62+
6063
Look at the [Breaking Changes](https://github.com/CodeBeamOrg/CodeBeam.MudBlazor.Extensions/blob/dev/BreakingChanges.md)
6164

6265
## API
66+
6367
https://codebeam-mudextensions.pages.dev/api
6468

6569
## Supported MudBlazor Versions
66-
| MudExtensions | MudBlazor | .Net |
67-
| :--- | :----: | :---: |
68-
| 6.0.0 - 6.0.3 | 6.0.16 | .Net 6 |
69-
| 6.0.4 - 6.0.12 | 6.0.17 - 6.0.18 | .Net 6 |
70-
| 6.1.0 - 6.1.4 | 6.1.0 - 6.1.2 | .Net 6 & .Net 7 |
71-
| 6.1.5 - 6.1.9 | 6.1.4 - 6.1.7 | .Net 6 & .Net 7 |
72-
| 6.2.0 - 6.2.5 | 6.1.8 | .Net 6 & .Net 7 |
73-
| 6.2.6 - 6.4.8 | 6.1.9 - 6.2.0 | .Net 6 & .Net 7 |
74-
| 6.4.9 - 6.5.5 | 6.2.1 - 6.7.0 | .Net 6 & .Net 7 |
70+
71+
| MudExtensions | MudBlazor | .NET |
72+
| :------------- | :-------------: | :-------------: |
73+
| 6.0.0 - 6.0.3 | 6.0.16 | .NET 6 |
74+
| 6.0.4 - 6.0.12 | 6.0.17 - 6.0.18 | .NET 6 |
75+
| 6.1.0 - 6.1.4 | 6.1.0 - 6.1.2 | .NET 6 & .NET 7 |
76+
| 6.1.5 - 6.1.9 | 6.1.4 - 6.1.7 | .NET 6 & .NET 7 |
77+
| 6.2.0 - 6.2.5 | 6.1.8 | .NET 6 & .NET 7 |
78+
| 6.2.6 - 6.4.8 | 6.1.9 - 6.2.0 | .NET 6 & .NET 7 |
79+
| 6.4.9 - 6.5.5 | 6.2.1 - 6.7.0 | .NET 6 & .NET 7 |
7580

7681
## Installation
82+
7783
This extension uses MudBlazor features (need to set up MudBlazor if you didn't before), so only need to add this line described below:<br /><br />
7884
Add the following to your HTML **head** section, it's either `index.html` or `_Layout.cshtml`/`_Host.cshtml` depending on whether you're running Server-Side or WASM.
85+
7986
```html
8087
<link href="_content/CodeBeam.MudBlazor.Extensions/MudExtensions.min.css" rel="stylesheet" />
8188
```
8289

8390
Add the following to your HTML **body** section
91+
8492
```html
8593
<script src="_content/CodeBeam.MudBlazor.Extensions/MudExtensions.min.js"></script>
8694
```
8795

88-
Add the extension services into program.cs
89-
```razor
96+
Add the extension services into `Program.cs`
97+
98+
```cs
9099
using MudExtensions.Services;
91100
builder.Services.AddMudExtensions();
92101
```
93102

94103
Adding namespace to `_Imports.razor` is not obligatory, but useful.
104+
95105
```razor
96106
@using MudExtensions
97107
```
98108

99109
## Examples
110+
100111
Each example is recorded in the playground website.
101112

102113
### MudAnimate
@@ -139,6 +150,6 @@ https://user-images.githubusercontent.com/78308169/195593490-6fd8d5fe-0472-4b9b-
139150

140151
https://user-images.githubusercontent.com/78308169/195979884-7cf1698c-ce0a-400f-83a7-2accf6fff8c5.mp4
141152

142-
143153
## Contribution
154+
144155
Feel free to contribute.

0 commit comments

Comments
 (0)