Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fgilde committed Sep 23, 2024
1 parent 230d79c commit 2deae63
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 24 deletions.
5 changes: 4 additions & 1 deletion MudBlazor.Extensions/Docs/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
## Change Log
- 2.0.6 > Add New Component `MudExFileDisplayOfficeLive` to support preview of any remote accessable office files in [MudExFileDisplay](https://www.mudex.org/file-display) and [MudExUploadEdit](https://www.mudex.org/upload-edit) .
- 2.0.6 > Use [MudExAdditionalAdornment](https://www.mudex.org/additional-adornments) for Theme edit buttons in [MudExThemeEdit](https://www.mudex.org/theme-edit)
- 2.0.6 > Fix some style bugs
- 2.0.6 > **_Breaking:_** Signature of [IMudExFileDisplay](https://www.mudex.org/api/IMudExFileDisplay) `CanHandleFile` changed to an async method. This allows to handle async file checks. The method now returns a Task<bool> instead of a bool.
- 2.0.5 > Update MudBlazor to 7.8.0
- 2.0.4 > The [MudExImageViewer](https://www.mudex.org/image-view) Now allows custom toolbar content and custom content for the new floating toolbar for the selected area.
Expand Down Expand Up @@ -115,7 +118,7 @@
- 1.7.64 > Remove need for `jsRuntime.InitializeMudBlazorExtensionsAsync()`
- 1.7.63 > Use MudMarkdown as IMudExFileDisplay to support markdown files in [MudExFileDisplay](https://www.mudex.org/file-display)
- 1.7.63 > Add new option to allow copy url to clipboard in [MudExFileDisplay](https://www.mudex.org/file-display)
- 1.7.63 > Fix bug in [MudExThemeEdit](https://www.mudex.org/theme-ed it) where component wasnt loaded if its rendered in a dialog.
- 1.7.63 > Fix bug in [MudExThemeEdit](https://www.mudex.org/theme-edit) where component wasnt loaded if its rendered in a dialog.
- 1.7.62 > Update all nuget packages to latest versions. Now using MudBlazor 6.7.0
- 1.7.61 > **_Breaking:_** Rename: Move namespace for Css enums like CssUnit, BorderStyle etc from MudBlazor.Extensions.Core to MudBlazor.Extensions.Core.Css
- 1.7.61 > new Component [MudExIconPicker](https://www.mudex.org/mud-ex-icon-picker) to select icons. Used in [API]((https://www.mudex.org/api)) overview and in ComponentGrid as MudExObjectedit config.
Expand Down
33 changes: 10 additions & 23 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 Down Expand Up @@ -109,7 +109,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 2024-06-28 13:18:32 -->
<!-- Copied from https://raw.githubusercontent.com/wiki/fgilde/MudBlazor.Extensions/Showcase.md on 2024-09-23 15:35:58 -->
## Showcase

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

### MudExObjectEdit
<!-- OBJECTEDIT:START -->
<!-- Copied from ObjectEdit.md on 2024-06-28 13:18:32 -->
<!-- Copied from ObjectEdit.md on 2024-09-23 15:35:55 -->
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 Down Expand Up @@ -204,7 +204,7 @@ You can find a running [Sample here](https://www.mudex.org/structured-data-edit)

### MudExFileDisplay
<!-- FILEDISPLAY:START -->
<!-- Copied from MudExFileDisplay.md on 2024-06-28 13:18:32 -->
<!-- Copied from MudExFileDisplay.md on 2024-09-23 15:35:55 -->
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 @@ -263,7 +263,7 @@ await dialogService.ShowEx<MudExFileDisplayDialog>(title, parameters, optionsEx)

### MudExUploadEdit
<!-- UPLOADEDIT:START -->
<!-- Copied from MudExUploadEdit.md on 2024-06-28 13:18:32 -->
<!-- Copied from MudExUploadEdit.md on 2024-09-23 15:35:55 -->

`MudExUploadEdit` is a versatile file upload component with a wide range of features such as MIME and extension whitelisting/blacklisting, folder upload, drag and drop, copy and paste, renaming, and integration with Dropbox, Google Drive, and OneDrive.

Expand All @@ -275,7 +275,7 @@ await dialogService.ShowEx<MudExFileDisplayDialog>(title, parameters, optionsEx)

## Extensions
<!-- DIALOG_EXT:START -->
<!-- Copied from DialogExtensions.md on 2024-06-28 13:18:32 -->
<!-- Copied from DialogExtensions.md on 2024-09-23 15:35:55 -->
### Resizable or Draggable Dialogs

You can make your dialogs resizable or draggable using the following code snippet:
Expand Down Expand Up @@ -386,12 +386,14 @@ MudBlazor.Extensions is released under the MIT License. See the bundled LICENSE
## Change Log
Latest Changes:
<!-- CHANGELOG:START -->
<!-- Copied from CHANGELOG.md on 2024-06-28 13:18:31 -->
<!-- Copied from CHANGELOG.md on 2024-09-23 15:35:55 -->
- 2.0.6 > Add New Component `MudExFileDisplayOfficeLive` to support preview of any remote accessable office files in [MudExFileDisplay](https://www.mudex.org/file-display) and [MudExUploadEdit](https://www.mudex.org/upload-edit) .
- 2.0.6 > Use [MudExAdditionalAdornment](https://www.mudex.org/additional-adornments) for Theme edit buttons in [MudExThemeEdit](https://www.mudex.org/theme-edit)
- 2.0.6 > Fix some style bugs
- 2.0.6 > **_Breaking:_** Signature of [IMudExFileDisplay](https://www.mudex.org/api/IMudExFileDisplay) `CanHandleFile` changed to an async method. This allows to handle async file checks. The method now returns a Task<bool> instead of a bool.
- 2.0.5 > Update MudBlazor to 7.8.0
- 2.0.4 > The [MudExImageViewer](https://www.mudex.org/image-view) Now allows custom toolbar content and custom content for the new floating toolbar for the selected area.
- 2.0.4 > The [MudExImageViewer](https://www.mudex.org/image-view) now has an option to allow a rubberband selection. The user can then open, download, print or directly switching the view to the selected area as an image.
Also an event is fired when the user selects an area where an blob url and the image bytes are provided in.
- 2.0.4 > All file viewers can now implement a method to return info like meta tags for the info dialog.
- 2.0.4 > New propertry in MudExFileDisplay "IgnoredRenderControls" here you can specify an arry of types to ignore as file renderer.
- 2.0.4 > Update MudBlazor to 7.6.0
Expand All @@ -400,21 +402,6 @@ Latest Changes:
- 2.0.0 > Update MudBlazor to 7.0.0
- 2.0.0 > **_Breaking:_** Rename: Many properties and behavoirs as MudBlazor does. Se migration guide from MudBlazor 6 to 7 [here](https://github.com/MudBlazor/MudBlazor/issues/8447)
- 1.7.89 > Fix bug that uploadable file is not updated in MudExObjectEditDialog
- 1.7.88 > Dialogs now supporting a can close event to allow canceling the close event [see sample](https://www.mudex.org/dialogs-closing-event)
- 1.7.88 > Add new Components [MudExTreeView](https://www.mudex.org/demos/TreeView).
- 1.7.88 > Update MudBlazor to 6.20.0
- 1.7.88 > New Component `MudExFileDisplayExcel` to support preview of Excel files in [MudExFileDisplay](https://www.mudex.org/file-display) and [MudExUploadEdit](https://www.mudex.org/upload-edit) .
- 1.7.88 > [MudExUploadEdit](https://www.mudex.org/upload-edit) now supports recording audio.
- 1.7.88 > New Component [MudExGravatar](https://www.mudex.org/gravatar).
- 1.7.88 > Dialogs now supporting CustomSize and CustomPostion to allow more flexibility.
- 1.7.88 > New service [IDialogEventService](https://www.mudex.org/a/IDialogEventService) to allow handling of dialog events
- 1.7.88 > Dialog supports now a CloseAnimation
- 1.7.88 > New Service [ISpeechRecognitionService](https://www.mudex.org/d/ISpeechRecognitionService/ISpeechRecognitionService) to allow easy speech to text conversion or audio recording without any UI
- 1.7.88 > New Component [MudExSpeechToTextButton](https://www.mudex.org/speech-to-text) to allow easy speech to text conversion or audio recording
- 1.7.87 > Small minor BugFixes
- 1.7.87 > Improve key navigation in MudExSelect and MudExList
- 1.7.87 > Update MudBlazor to 6.19.1
- 1.7.86 > Update MudBlazor to 6.18.0
<!-- 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 2deae63

Please sign in to comment.