Tenekon.FluentValidation.Extensions.AspNetCore.Components 1.0.42-alpha-gf27ed5ad86

Tenekon.FluentValidation.Extensions

🚧 This is a new project. You are very welcome to participate in this project, help shape the public API and share ideas. The project is currently in alpha state, so the public API may change significantly.

Table of Contents

• Packages
  • Tenekon.FluentValidation.Extensions.AspNetCore.Components
  • Features
  • Quickstart
  • Documentation & Resources
  • Target Framework
  • Dependencies
• Development
• License

Packages

Package Description
Tenekon.FluentValidation.Extensions.AspNetCore.Components<br/>	Blazor integration for FluentValidation

Tenekon.FluentValidation.Extensions.AspNetCore.Components

An extension to integrate FluentValidation with ASP.NET Core Components (Blazor Components). This library enhances component-level validation in Blazor applications using FluentValidation.

📖 For usage examples, see the Validator Components Cookbook covering common and advanced scenarios.

Features

• 🌞 Seamless integration with Blazor forms¹
• :jigsaw: Validate not only top-level anymore – just wrap each edit model part by a validator component^2,4
• :jigsaw: Nestable edit model validators – nested child validator components² still hook into the validation of the main form³.
• 🔌 Component-region validation — plug validators² into forms or any part of a form or any nested region or subregion.³

<small>¹: Any form that provides a cascaded EditContext, even a plain CascadedValue Value="new EditContext(..)">..</CascadedValue> is sufficient.</small><br/> <small>²: Refers to the usage of validator components of this library.</small><br/> <small>³: Nested child edit model validators automatically receive the nearest EditContext, captured by the first validator component² higher in the hierarchy (usually from a form¹).</small><br/> <small>⁴: EditModelValidatorSubpath and EditModelScope have the capability to create an isolated EditContxt wired to the nearest EditContext³.

Quickstart

1. Install the NuGet package:

dotnet add package Tenekon.FluentValidation.Extensions.AspNetCore.Components

2. Define your validator using FluentValidation:

public class ModelValidator : AbstractValidator<MyModel>
{
    public ModelValidator()
    {
        RuleFor(x => x.Name).NotEmpty();
    }
}

Requires FluentValidation package to be installed.

3. Register the validator in your DI container:

builder.Services.AddValidatorsFromAssemblyContaining<ModelValidator>();

Requires FluentValidation.DependencyInjectionExtensions package to be installed.

4. Use the validator component(s) in your Blazor form:

@code {
    private Model _model = new Model {
        Name = default(string)
        Children = (List<SubModel>)[
            new SubModel {
                Name = default(string)
            }
        ]
    };
}
<EditForm Model="_model" OnValidSubmit="HandleValidSubmit">
    <EditModelValidatorRootpath ValidatorType="typeof(ModelValidator)" />
    <InputText @bind-Value="_model.Name" />
    <ValidationMessage For="() => _model.Name" />
    @foreach(var child in _model.Children) {
        <EditModelValidatorSubpath Model="child" ValidatorType="typeof(SubModelValidator)">
            <InputText @bind-Value="child.Name"/>
            <ValidationMessage For="() => child.Name"/>
            
            <button type="submit">Prematurely Submit</button>
        </EditModelValidatorSubpath>
    }
    <button type="submit">Submit</button>
</EditForm>

Documentation & Resources

• 📖 Cookbook: Validator Components Cookbook — Examples & use cases for all common and advanced scenarios.
• :bricks: Architecture Validator Components Architecture — Architectural approach of the components, and their integration with Blazor's EditContext.
• 🔬 Flow Logic: Validator Components Flow Logic — Visual guide to how edit model validators interact with each other and Blazor's EditContext.

Target Framework

• .NET 8.0

Dependencies

• FluentValidation 12.x
• Microsoft.AspNetCore.Components.Forms 8.x
• FastExpressionCompiler 5.x

Development

git clone https://github.com/tenekon/Tenekon.FluentValidation.Extensions.git
cd Tenekon.FluentValidation.Extensions
dotnet build

License

MIT License - see LICENSE for details.