ComponentBuilder 0.2.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package ComponentBuilder --version 0.2.0                
NuGet\Install-Package ComponentBuilder -Version 0.2.0                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="ComponentBuilder" Version="0.2.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ComponentBuilder --version 0.2.0                
#r "nuget: ComponentBuilder, 0.2.0"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install ComponentBuilder as a Cake Addin
#addin nuget:?package=ComponentBuilder&version=0.2.0

// Install ComponentBuilder as a Cake Tool
#tool nuget:?package=ComponentBuilder&version=0.2.0                

ComponentBuilder

A framework can easily help you to create blazor component from code behind.

QuickStart

1. Install package

> Install-Package ComponentBuilder

2. Add Service

service.AddComponentBuilder();

3. Define your component in behind code

[ElementTag("button")]
[CssClass("btn")]
public class Button : BlazorComponentBase, IHasChildContent
{
    [Parameter] [CssClass("btn-")] public Color? Color { get; set; }
    [Parameter] public RenderFragment ChildContent { get; set; }
}

public enum Color
{
    Primary,
    Secondary,
    Danger,
    Warning,
    Info,
    Dark,
    Light,
    Success
}

4. Use your component in razor

<Button Color="Color.Primary">Primary</Button>
<Button Color="Color.Danger">Danger</Button>

alternate text is missing from this package README image

Html display

<button class="btn btn-primary">Primary</button>
<button class="btn btn-danger">Danger</button>

Razor file VS Code behind

In Button.razor

<button class="@(GetCssClass())" @attributes="Attributes">@ChildContent</button>


@code {
    [Parameter] public RenderFragment ChildContent { get; set; }

    [Parameter(CaptureUnmatchedValues = true)] public IDictionary<string, object> Attributes { get; set; }

    [Parameter] public Color? Color { get; set; }

    [Parameter] public bool Active { get; set; }


    string GetCssClass()
    {
        var cssList = new List<string>();

        if (Active)
        {
            cssList.Add("active");
        }
        if (Color.HasValue)
        {
            cssList.Add($"btn-{Color.Value.ToString().ToLower()}");
        }
        return string.Join(" ", cssList);
    }
}

In Button.cs

[ElementTag("button")]
[CssClass("btn")]
public class Button : BlazorComponentBase, IHasChildContent
{
    [Parameter] public RenderFragment ChildContent { get; set; }

    [Parameter] [CssClass("btn-")] public Color? Color { get; set; }

    [Parameter] [CssClass("active")] public bool Active { get; set; }
}

Customization

Conditional building css class

Overrides BuildCssClass method to build css by logical code

[ElementTag("button")]
[CssClass("btn")]
public class Button : BlazorComponentBase, IHasChildContent
{
    [Parameter] public RenderFragment ChildContent { get; set; }

    [Parameter] [CssClass("btn-")] public Color? Color { get; set; }

    [Parameter] [CssClass("active")] public bool Active { get; set; }

    [Inject]IHostingEnvironment Env { get; set; }

    protected override void BuildCssClass(ICssClassBuilder builder)
    {
        if(Env.IsDevelopment())
        {
            builder.Append("container-sm");
        }
    }
}

Element attribute by parameter

Set ElementAttribute for pameters to create attribute of element

[ElementTag("a")]
public class Anchor : BlazorChildContentComponentBase
{
    [ElementAttribute("name")][Parameter]public string Alias { get; set; }
    [ElementAttribute("href")][Parameter]public string Link { get; set; }

    //build same name of parameter with lowercase
    [ElementAttribute][Parameter]public string Title { get; set; } 
}

<Anchor Link="www.bing.com" Alias="link" Title="Go To Bing">Click Here</Anchor>

<a href="www.bing.com" name="link" title="Go To Bing">Click Here</a>

Additional attributes captured

[ElementTag("a")]
public class LinkButton : BlazorChildContentComponentBase
{
}

<Button data-toggle="modal">Link</Button>


<a data-toggle="modal">Link</a>

Support

  • .NET 5
  • .NET 6
Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (5)

Showing the top 5 NuGet packages that depend on ComponentBuilder:

Package Downloads
TDesign

基于腾讯 TDesign 的 Blazor 企业级组件库。腾讯 TDesign 官方地址:https://tdesign.tencent.com/

BlamanticUI

The css framework from Semantic-UI for blazor without jQuery.

ComponentBuilder.FluentRenderTree

用链式编程的方式简化 RenderTreeBuilder 的操作。 示例: builder.Element("div").Content("hello").Close(); builder.Component<Button>().Content("Button").Close(); builder.Div(Id is not null).Content(content => content.Component<Icon>().Attribute(m => m.Name, "user").Close()).Close();

ComponentBuilder.Interceptors.Diagnostics.Console

在控制台中用于组件生命周期诊断的拦截器,该拦截器可以用于调试阶段的生命周期运行的输出。

ComponentBuilder.Resolvers.FluentClass

组件参数支持 IFluentClassProvider 自动解析成 CSS 类。 [Parameter]public IFluentClassProvider Parameter{ get; set; } <Component Parameter="Provider.Is3.FromTop.HasSmall" />

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on ComponentBuilder:

Repository Stars
tdesign-blazor/TDesignBlazor
基于腾讯 TDesign 的 Blazor 组件库
Version Downloads Last updated
5.1.0 129 3/7/2024
5.0.0 186 12/21/2023
5.0.0-beta-1 155 11/16/2023
4.1.2 1,004 7/17/2023
4.1.1 200 7/17/2023
4.1.0 743 6/4/2023
4.0.0 479 5/30/2023
4.0.0-beta-3 257 5/22/2023
4.0.0-beta-2 138 5/19/2023
4.0.0-beta-1 143 5/17/2023
3.1.4 529 3/17/2023
3.1.3 196 3/16/2023
3.1.0 213 3/10/2023
3.0.0 737 2/24/2023
3.0.0-beta-0217 100 2/16/2023
3.0.0-beta-0206 183 2/6/2023
3.0.0-beta-0130 110 1/30/2023
3.0.0-beta-0114 117 1/13/2023
2.3.0 297 12/28/2022
2.2.0 293 12/13/2022
2.1.0 1,450 11/24/2022
2.0.0 361 10/28/2022
1.5.0.4 373 10/18/2022
1.5.0.3 391 10/13/2022
1.5.0.2 1,219 10/5/2022
1.5.0.1 393 10/3/2022
1.5.0 400 10/1/2022
1.4.1.1 664 9/19/2022
1.4.1 404 9/16/2022
1.4.0 418 9/15/2022
1.3.0 413 8/29/2022
1.2.1 575 7/12/2022
1.2.0 411 7/11/2022
1.1.0 555 5/22/2022
1.0.0 610 3/23/2022
0.7.0 438 3/11/2022
0.6.0 436 2/9/2022
0.5.0 270 1/6/2022
0.4.0 280 12/23/2021
0.3.0 293 12/16/2021
0.2.0 300 12/7/2021
0.1.0 6,146 11/24/2021