Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
fgilde committed Oct 1, 2023
1 parent 3f89cfe commit 4d6f225
Showing 1 changed file with 14 additions and 10 deletions.
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![GitHub Repo stars](https://img.shields.io/github/stars/fgilde/mudblazor.extensions?color=594ae2&style=flat-square&logo=github)](https://github.com/fgilde/mudblazor.extensions/stargazers)
[![GitHub Repo stars](https://img.shields.io/github/stars/fgilde/mudblazor.extensions?color=594ae2&style=flat-square&logo=github)](https://github.com/fgilde/mudblazor.extensions/stargazers)
[![GitHub](https://img.shields.io/github/license/garderoben/mudblazor?color=594ae2&style=flat-square&logo=github)](https://github.com/fgilde/MudBlazor.Extensions/blob/master/LICENSE)
[![GitHub last commit](https://img.shields.io/github/last-commit/fgilde/MudBlazor.Extensions?color=594ae2&style=flat-square&logo=github)](https://github.com/fgilde/MudBlazor.Extensions)
[![Nuget version](https://img.shields.io/nuget/v/MudBlazor.Extensions?color=ff4081&label=nuget%20version&logo=nuget&style=flat-square)](https://www.nuget.org/packages/MudBlazor.Extensions/)
Expand All @@ -8,6 +8,7 @@
#### CI Stats
[![Publish Nuget Preview Package and deploy Test App](https://github.com/fgilde/MudBlazor.Extensions/actions/workflows/nuget_preview_publish_and_app_deploy.yml/badge.svg)](https://github.com/fgilde/MudBlazor.Extensions/actions/workflows/nuget_preview_publish_and_app_deploy.yml)
[![Publish Nuget Release Package](https://github.com/fgilde/MudBlazor.Extensions/actions/workflows/nuget_release_publish.yml/badge.svg)](https://github.com/fgilde/MudBlazor.Extensions/actions/workflows/nuget_release_publish.yml)
[![Deploy TryMudEx](https://github.com/fgilde/MudBlazor.Extensions/actions/workflows/TryMudEx.yml/badge.svg)](https://github.com/fgilde/MudBlazor.Extensions/actions/workflows/TryMudEx.yml)

# MudBlazor.Extensions
MudBlazor.Extensions is a extension library for MudBlazor Component library from https://mudblazor.com
Expand All @@ -17,6 +18,10 @@ MudBlazor.Extensions is a extension library for MudBlazor Component library from
[![Cloudflare](https://img.shields.io/badge/Cloudflare-Demo-blue)](https://mudblazor-extensions.pages.dev)
#

## Try Online
[![TryMudEx](https://img.shields.io/badge/Azure-Demo-blue)](https://trymudex.azurewebsites.net/)
#

<!---
[Running Sample Application (Github Pages)](https://fgilde.github.io/MudBlazor.Extensions/sample/wwwroot/)
-->
Expand Down Expand Up @@ -111,7 +116,7 @@ builder.Services.AddMudServicesWithExtensions(c => c.WithoutAutomaticCssLoading(
<summary>Expand videos</summary>

<!-- WIKI:START -->
<!-- Copied from https://raw.githubusercontent.com/wiki/fgilde/MudBlazor.Extensions/Showcase.md on 2023-09-15 10:38:31 -->
<!-- Copied from https://raw.githubusercontent.com/wiki/fgilde/MudBlazor.Extensions/Showcase.md on 2023-10-01 15:32:38 -->
## Showcase

https://github.com/fgilde/MudBlazor.Extensions/assets/11070717/39e06d88-a947-43cd-9151-a7cf96bcd849
Expand Down Expand Up @@ -166,7 +171,7 @@ This section introduces you to the various components provided by the MudBlazor.

### MudExObjectEdit
<!-- OBJECTEDIT:START -->
<!-- Copied from ObjectEdit.md on 2023-09-15 10:38:30 -->
<!-- Copied from ObjectEdit.md on 2023-10-01 15:32:38 -->
The `MudExObjectEdit` is a robust component that allows for object editing and automatically generates the corresponding UI. This component supports automatic validation for DataAnnotation Validations or fluent registered validations for your model.

To use `MudExObjectEdit`, you can simply use the `MudExObjectEditForm` and pass your model to it as shown below:
Expand All @@ -182,7 +187,6 @@ dialogService.EditObject(User, "Dialog Title", dialogOptionsEx);
```

[More](https://github.com/fgilde/MudBlazor.Extensions/blob/main/MudBlazor.Extensions/Docs/ObjectEdit.md)

<!-- OBJECTEDIT:END -->

### MudExStructuredDataEditor
Expand All @@ -207,7 +211,7 @@ You can find a running [Sample here](https://www.mudex.org/structured-data-edit)

### MudExFileDisplay
<!-- FILEDISPLAY:START -->
<!-- Copied from MudExFileDisplay.md on 2023-09-20 13:17:34 -->
<!-- Copied from MudExFileDisplay.md on 2023-10-01 15:32:38 -->
The `MudExFileDisplay` component is designed to display file contents, such as a preview before uploading or for referenced files.
This component can automatically handle URLs or streams and deliver the best possible display.
Additionally, you can implement `IMudExFileDisplay` in your own component to register a custom file display.
Expand Down Expand Up @@ -266,7 +270,7 @@ await dialogService.ShowEx<MudExFileDisplayDialog>(title, parameters, optionsEx)

### MudExUploadEdit
<!-- UPLOADEDIT:START -->
<!-- Copied from MudExUploadEdit.md on 2023-09-20 13:17:34 -->
<!-- Copied from MudExUploadEdit.md on 2023-10-01 15:32:38 -->

This component provides multi-file upload functionality, with features like duplicate checks, max size, specific allowed content types, max items, zip auto-extract, and many more.

Expand All @@ -279,7 +283,7 @@ This component provides multi-file upload functionality, with features like dupl

## Extensions
<!-- DIALOG_EXT:START -->
<!-- Copied from DialogExtensions.md on 2023-09-20 13:17:34 -->
<!-- Copied from DialogExtensions.md on 2023-10-01 15:32:38 -->
### Resizable or Draggable Dialogs

You can make your dialogs resizable or draggable using the following code snippet:
Expand Down Expand Up @@ -390,7 +394,9 @@ MudBlazor.Extensions is released under the MIT License. See the bundled LICENSE
## Change Log
Latest Changes:
<!-- CHANGELOG:START -->
<!-- Copied from CHANGELOG.md on 2023-09-20 13:17:33 -->
<!-- Copied from CHANGELOG.md on 2023-10-01 15:32:38 -->
- 1.7.69 > Adapt TryMudblazor for MudEx with better autocompletion, import and export as [TryMudEx](https://trymudex.azurewebsites.net)
- 1.7.69 > Create MudExFileDisplayCode as file viewer for [MudExFileDisplay](https://www.mudex.org/file-display)
- 1.7.68 > Fix memoryleak for streams in [MudExFileDisplay](https://www.mudex.org/file-display)
- 1.7.68 > Add new Parameter "ColorizeIcons" to [MudExUploadEdit](https://www.mudex.org/upload-edit) if true the icons will be colored
- 1.7.68 > **_Breaking:_** Add new Parameter "StreamUrlHandling" to [MudExUploadEdit](https://www.mudex.org/upload-edit) this can have the value `StreamUrlHandling.BlobUrl` or `StreamUrlHandling.DataUrl` this always was earlier handled as DataUrl what now changed as default to handle as BlobUrl to allow preview of bigger files as well
Expand All @@ -399,8 +405,6 @@ Latest Changes:
- 1.7.68 > New small component [MudExIcon](https://www.mudex.org/mud-ex-icon) default as MudIcon with the benefit of having [MudExColor](https://www.mudex.org/d/MudExColor) as ColorType that allows Theme and Customcolors in one type
- 1.7.68 > [MudExFileDisplayZip](https://www.mudex.org/file-display) now nativly supports Tar, Tar+Gzip, 7zip and Rar archives
- 1.7.68 > Update MudBlazor to 6.10.0
- 1.7.68 > Add Dense Parameter to [MudExFileDisplay](https://www.mudex.org/file-display)
- 1.7.68 > Add multi tag search in [MudExFileDisplay](https://www.mudex.org/file-display)
<!-- CHANGELOG:END -->
Full change log can be found [here](https://github.com/fgilde/MudBlazor.Extensions/blob/main/MudBlazor.Extensions/Docs/CHANGELOG.md)

Expand Down

0 comments on commit 4d6f225

Please sign in to comment.