Skip to content

Commit

Permalink
docs: Add comments to FragmentComponent class
Browse files Browse the repository at this point in the history
refactor: Change namespace of DataAnnotationsProcessor and RzFormContext classes
style: Rename Constants.cs file path
feat: Make PartialView method in RzController and RzControllerWithViews virtual
chore: Remove RzRazorComponentResult and RzRazorComponentResultOfT classes
  • Loading branch information
tanczosm committed Sep 26, 2024
1 parent bd13125 commit d1a6261
Show file tree
Hide file tree
Showing 56 changed files with 160 additions and 593 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
#### [Rizzy](index 'index')
### [Rizzy.Components](Rizzy.Components 'Rizzy.Components').[DataAnnotationsProcessor](Rizzy.Components.DataAnnotationsProcessor 'Rizzy.Components.DataAnnotationsProcessor')

## DataAnnotationsProcessor.AddAttributeHandler<TAttribute>(Action<TAttribute,IDictionary<string,object>,string>) Method

Adds a custom handler for a specific type of [System.ComponentModel.DataAnnotations.ValidationAttribute](https://docs.microsoft.com/en-us/dotnet/api/System.ComponentModel.DataAnnotations.ValidationAttribute 'System.ComponentModel.DataAnnotations.ValidationAttribute').

```csharp
public void AddAttributeHandler<TAttribute>(System.Action<TAttribute,System.Collections.Generic.IDictionary<string,object>,string> handler)
where TAttribute : System.ComponentModel.DataAnnotations.ValidationAttribute;
```
#### Type parameters

<a name='Rizzy.Components.DataAnnotationsProcessor.AddAttributeHandler_TAttribute_(System.Action_TAttribute,System.Collections.Generic.IDictionary_string,object_,string_).TAttribute'></a>

`TAttribute`

The type of the attribute to handle.
#### Parameters

<a name='Rizzy.Components.DataAnnotationsProcessor.AddAttributeHandler_TAttribute_(System.Action_TAttribute,System.Collections.Generic.IDictionary_string,object_,string_).handler'></a>

`handler` [System.Action&lt;](https://docs.microsoft.com/en-us/dotnet/api/System.Action-3 'System.Action`3')[TAttribute](Rizzy.Components.DataAnnotationsProcessor.AddAttributeHandler_TAttribute_(System.Action_TAttribute,System.Collections.Generic.IDictionary_string,object_,string_)#Rizzy.Components.DataAnnotationsProcessor.AddAttributeHandler_TAttribute_(System.Action_TAttribute,System.Collections.Generic.IDictionary_string,object_,string_).TAttribute 'Rizzy.Components.DataAnnotationsProcessor.AddAttributeHandler<TAttribute>(System.Action<TAttribute,System.Collections.Generic.IDictionary<string,object>,string>).TAttribute')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-3 'System.Action`3')[System.Collections.Generic.IDictionary&lt;](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')[System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object')[&gt;](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IDictionary-2 'System.Collections.Generic.IDictionary`2')[,](https://docs.microsoft.com/en-us/dotnet/api/System.Action-3 'System.Action`3')[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[&gt;](https://docs.microsoft.com/en-us/dotnet/api/System.Action-3 'System.Action`3')

The handler that processes the attribute.
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
#### [Rizzy](index 'index')
### [Rizzy.Components](Rizzy.Components 'Rizzy.Components').[DataAnnotationsProcessor](Rizzy.Components.DataAnnotationsProcessor 'Rizzy.Components.DataAnnotationsProcessor')

## DataAnnotationsProcessor(IServiceProvider) Constructor

Initializes a new instance of the [DataAnnotationsProcessor](Rizzy.Components.DataAnnotationsProcessor 'Rizzy.Components.DataAnnotationsProcessor') class.

```csharp
public DataAnnotationsProcessor(System.IServiceProvider provider);
```
#### Parameters

<a name='Rizzy.Components.DataAnnotationsProcessor.DataAnnotationsProcessor(System.IServiceProvider).provider'></a>

`provider` [System.IServiceProvider](https://docs.microsoft.com/en-us/dotnet/api/System.IServiceProvider 'System.IServiceProvider')
21 changes: 21 additions & 0 deletions docs/Rizzy.Components.DataAnnotationsProcessor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
#### [Rizzy](index 'index')
### [Rizzy.Components](Rizzy.Components 'Rizzy.Components')

## DataAnnotationsProcessor Class

Processes Data Annotations on model properties and converts them to HTML5 data attributes.
Registration Scope: Singleton

```csharp
public class DataAnnotationsProcessor
```

Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') &#129106; DataAnnotationsProcessor
| Constructors | |
| :--- | :--- |
| [DataAnnotationsProcessor(IServiceProvider)](Rizzy.Components.DataAnnotationsProcessor.DataAnnotationsProcessor(System.IServiceProvider) 'Rizzy.Components.DataAnnotationsProcessor.DataAnnotationsProcessor(System.IServiceProvider)') | Initializes a new instance of the [DataAnnotationsProcessor](Rizzy.Components.DataAnnotationsProcessor 'Rizzy.Components.DataAnnotationsProcessor') class. |

| Methods | |
| :--- | :--- |
| [AddAttributeHandler&lt;TAttribute&gt;(Action&lt;TAttribute,IDictionary&lt;string,object&gt;,string&gt;)](Rizzy.Components.DataAnnotationsProcessor.AddAttributeHandler_TAttribute_(System.Action_TAttribute,System.Collections.Generic.IDictionary_string,object_,string_) 'Rizzy.Components.DataAnnotationsProcessor.AddAttributeHandler<TAttribute>(System.Action<TAttribute,System.Collections.Generic.IDictionary<string,object>,string>)') | Adds a custom handler for a specific type of [System.ComponentModel.DataAnnotations.ValidationAttribute](https://docs.microsoft.com/en-us/dotnet/api/System.ComponentModel.DataAnnotations.ValidationAttribute 'System.ComponentModel.DataAnnotations.ValidationAttribute'). |

This file was deleted.

This file was deleted.

21 changes: 0 additions & 21 deletions docs/Rizzy.Components.Form.DataAnnotationsProcessor.md

This file was deleted.

33 changes: 0 additions & 33 deletions docs/Rizzy.Components.Form.RzFormContext.md

This file was deleted.

8 changes: 0 additions & 8 deletions docs/Rizzy.Components.Form.md

This file was deleted.

12 changes: 12 additions & 0 deletions docs/Rizzy.Components.FragmentComponent.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
#### [Rizzy](index 'index')
### [Rizzy.Components](Rizzy.Components 'Rizzy.Components')

## FragmentComponent Class

Component that encapsulates a RenderFragment for use as a partial or child component.

```csharp
public class FragmentComponent : Microsoft.AspNetCore.Components.ComponentBase
```

Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') &#129106; [Microsoft.AspNetCore.Components.ComponentBase](https://docs.microsoft.com/en-us/dotnet/api/Microsoft.AspNetCore.Components.ComponentBase 'Microsoft.AspNetCore.Components.ComponentBase') &#129106; FragmentComponent
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#### [Rizzy](index 'index')
### [Rizzy.Components.Form](Rizzy.Components.Form 'Rizzy.Components.Form').[RzFormContext](Rizzy.Components.Form.RzFormContext 'Rizzy.Components.Form.RzFormContext')
### [Rizzy.Components](Rizzy.Components 'Rizzy.Components').[RzFormContext](Rizzy.Components.RzFormContext 'Rizzy.Components.RzFormContext')

## RzFormContext.EditContext Property

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#### [Rizzy](index 'index')
### [Rizzy.Components.Form](Rizzy.Components.Form 'Rizzy.Components.Form').[RzFormContext](Rizzy.Components.Form.RzFormContext 'Rizzy.Components.Form.RzFormContext')
### [Rizzy.Components](Rizzy.Components 'Rizzy.Components').[RzFormContext](Rizzy.Components.RzFormContext 'Rizzy.Components.RzFormContext')

## RzFormContext.FormName Property

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#### [Rizzy](index 'index')
### [Rizzy.Components.Form](Rizzy.Components.Form 'Rizzy.Components.Form').[RzFormContext](Rizzy.Components.Form.RzFormContext 'Rizzy.Components.Form.RzFormContext')
### [Rizzy.Components](Rizzy.Components 'Rizzy.Components').[RzFormContext](Rizzy.Components.RzFormContext 'Rizzy.Components.RzFormContext')

## RzFormContext.FormUrl Property

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#### [Rizzy](index 'index')
### [Rizzy.Components.Form](Rizzy.Components.Form 'Rizzy.Components.Form').[RzFormContext](Rizzy.Components.Form.RzFormContext 'Rizzy.Components.Form.RzFormContext')
### [Rizzy.Components](Rizzy.Components 'Rizzy.Components').[RzFormContext](Rizzy.Components.RzFormContext 'Rizzy.Components.RzFormContext')

## RzFormContext.Id Property

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#### [Rizzy](index 'index')
### [Rizzy.Components.Form](Rizzy.Components.Form 'Rizzy.Components.Form').[RzFormContext](Rizzy.Components.Form.RzFormContext 'Rizzy.Components.Form.RzFormContext')
### [Rizzy.Components](Rizzy.Components 'Rizzy.Components').[RzFormContext](Rizzy.Components.RzFormContext 'Rizzy.Components.RzFormContext')

## RzFormContext.Model<TModel>() Method

Expand All @@ -12,12 +12,12 @@ public TModel Model<TModel>();
```
#### Type parameters

<a name='Rizzy.Components.Form.RzFormContext.Model_TModel_().TModel'></a>
<a name='Rizzy.Components.RzFormContext.Model_TModel_().TModel'></a>

`TModel`

#### Returns
[TModel](Rizzy.Components.Form.RzFormContext.Model_TModel_()#Rizzy.Components.Form.RzFormContext.Model_TModel_().TModel 'Rizzy.Components.Form.RzFormContext.Model<TModel>().TModel')
[TModel](Rizzy.Components.RzFormContext.Model_TModel_()#Rizzy.Components.RzFormContext.Model_TModel_().TModel 'Rizzy.Components.RzFormContext.Model<TModel>().TModel')

#### Exceptions

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#### [Rizzy](index 'index')
### [Rizzy.Components.Form](Rizzy.Components.Form 'Rizzy.Components.Form').[RzFormContext](Rizzy.Components.Form.RzFormContext 'Rizzy.Components.Form.RzFormContext')
### [Rizzy.Components](Rizzy.Components 'Rizzy.Components').[RzFormContext](Rizzy.Components.RzFormContext 'Rizzy.Components.RzFormContext')

## RzFormContext(string, object) Constructor

Expand All @@ -10,13 +10,13 @@ public RzFormContext(string formName, object model);
```
#### Parameters

<a name='Rizzy.Components.Form.RzFormContext.RzFormContext(string,object).formName'></a>
<a name='Rizzy.Components.RzFormContext.RzFormContext(string,object).formName'></a>

`formName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')

The name of the form.

<a name='Rizzy.Components.Form.RzFormContext.RzFormContext(string,object).model'></a>
<a name='Rizzy.Components.RzFormContext.RzFormContext(string,object).model'></a>

`model` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object')

Expand Down
Loading

0 comments on commit d1a6261

Please sign in to comment.