KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #developer-tools #ai-agent #claude-code #codex #typescript #ai-agents #deepseek-harness #mcp #cli #rust

BlazorWebFormsComponents

★ 450 Open GitHub ↗

A collection of Blazor components that emulate the ASP.NET Web Forms controls of the same name

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# BlazorWebFormsComponents

A collection of Blazor components that are drop-in replacements for the ASP.NET Web Forms control of the same name.  The library also includes some other shims and modules that make migrating to Blazor a smooth experience

[![AI Ready](https://img.shields.io/badge/AI--Ready-yes-brightgreen?style=flat)](https://github.com/johnpapa/ai-ready)  [![Build and Test](https://github.com/FritzAndFriends/BlazorWebFormsComponents/actions/workflows/build.yml/badge.svg)](https://github.com/FritzAndFriends/BlazorWebFormsComponents/actions/workflows/build.yml)  [![Integration Tests](https://github.com/FritzAndFriends/BlazorWebFormsComponents/actions/workflows/integration-tests.yml/badge.svg)](https://github.com/FritzAndFriends/BlazorWebFormsComponents/actions/workflows/integration-tests.yml)  [![Join the chat at https://gitter.im/BlazorWebFormsComponents/community](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/BlazorWebFormsComponents/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)  [![docs](https://github.com/FritzAndFriends/BlazorWebFormsComponents/workflows/docs/badge.svg)](https://fritzandfriends.github.io/BlazorWebFormsComponents/)

[![Nuget](https://img.shields.io/nuget/v/Fritz.BlazorWebFormsComponents?color=violet)](https://www.nuget.org/packages/Fritz.BlazorWebFormsComponents/)  [![Nuget (with prereleases)](https://img.shields.io/nuget/vpre/Fritz.BlazorWebFormsComponents)](https://www.nuget.org/packages/Fritz.BlazorWebFormsComponents/)  [![Live Sample](https://img.shields.io/badge/-Live%20Sample-purple)](https://blazorwebformscomponents.azurewebsites.net)

[Live Samples running on Azure](https://blazorwebformscomponents.azurewebsites.net)

## Documentation Site

The [documentation site](https://fritzandfriends.github.io/BlazorWebFormsComponents/) covers every component, migration guides, and the Three-Layer Methodology for moving Web Forms apps to Blazor.

### Docs Homepage
![Docs Site Homepage](https://raw.githubusercontent.com/FritzAndFriends/BlazorWebFormsComponents/dev/docs/images/docs-site-homepage.png)

### Migration Methodology with Mermaid Diagrams
![Migration Methodology](https://raw.githubusercontent.com/FritzAndFriends/BlazorWebFormsComponents/dev/docs/images/docs-site-migration.png)

## Sample Site

The [live sample site](https://blazorwebformscomponents.azurewebsites.net) showcases all components with interactive examples, code snippets, and a searchable catalog.

### Homepage & Component Catalog
![Sample Site Homepage](https://raw.githubusercontent.com/FritzAndFriends/BlazorWebFormsComponents/dev/docs/images/sample-site-homepage.png)

### GridView with Paging
![GridView Sample](https://raw.githubusercontent.com/FritzAndFriends/BlazorWebFormsComponents/dev/docs/images/sample-site-gridview.png)

### Chart Component with Chart.js
![Chart Sample](https://raw.githubusercontent.com/FritzAndFriends/BlazorWebFormsComponents/dev/docs/images/sample-site-chart.png)

### Fuzzy Search
![Search Feature](https://raw.githubusercontent.com/FritzAndFriends/BlazorWebFormsComponents/dev/docs/images/sample-site-search.png)

## Approach + Considerations

We believe that Web Forms applications that have been well maintained and provide value should have a path forward to the new user-interface frameworks with minimal changes.  This is not an application converted nor is it a patch that can be applied to your project that magically makes it work with ASP<span></span>.NET Core.  This repository contains a library and series of strategies that will allow you to re-use much of your markup, much of your business code and help shorten your application re-write process.

This is not for everyone, not everyone needs to migrate their application.  They can continue being supported as Web Forms for a very long time (2029 EOL at the time of this writing) and the applications that are considered for migration to Blazor may be better suited with a complete re-write.  For those applications that need to be migrated, this library should help make that process simpler by providing components with the same names, markup, and functionality as previously available.

[Documentation is available online](https://fritzandfriends.github.io/BlazorWebFormsComponents/).  [Get started with your migration, steps ahead, and strategy documentation](docs/Migration/readme.md) for various controls and tools used are available.  Live versions of these components are availalbe on the [Live Samples website](https://blazorwebformscomponents.azurewebsites.net)

Portions of the [original .NET Framework](https://github.com/microsoft/referencesource) are contributed to this project under their MIT license.

## Custom Controls: Change One Line, Keep Your Code

For applications with custom server controls that inherit `WebControl` and render via `HtmlTextWriter`, migration is as simple as changing a single `using` statement:

```csharp
// Before (Web Forms)
using System.Web.UI.WebControls;

// After (Blazor + BWFC)
using BlazorWebFormsComponents.CustomControls;
```

Your `RenderContents`, `TagKey`, and `AddAttributesToRender` overrides work **unchanged**. The BWFC `WebControl` class provides a full `HtmlTextWriter` shim that captures your imperative rendering calls and emits them as HTML in Blazor's render tree — same output, zero rewrite.

```csharp
// This code works identically in Web Forms AND Blazor with BWFC
public class StatusBadge : WebControl
{
    [Parameter] // Only addition: Blazor requires this attribute
    public string Status { get; set; }

protected override HtmlTextWriterTag TagKey => HtmlTextWriterTag.Span;

protected override void RenderContents(HtmlTextWriter writer)
    {
        writer.RenderBeginTag(HtmlTextWriterTag.Strong);
        writer.Write(Status);
        writer.RenderEndTag();
    }
}
```

This same principle applies across the library: **developers rewrite as little code as possible.** Page lifecycle methods (`Page_Load`, `Page_Init`), `FindControl()` calls, `Request`/`Response`/`Session` access — they all work through runtime shims rather than requiring code transformation.

📖 [Full Custom WebControl Migration Guide](docs/Migration/CustomWebControl.md)

## Migration CLI Tool

The **`webforms-to-blazor` CLI tool** automates the first phase of Web Forms to Blazor migration. It applies deterministic transforms to your markup and code-behind, removing boilerplate and converting patterns into a **.NET 10 Blazor Web App scaffolded for static server-side rendering (SSR)**:

```bash
# Full project migration
dotnet tool install --global Fritz.WebFormsToBlazor
webforms-to-blazor migrate --input ./MyWebFormsProject --output ./MyBlazorProject

# Or convert individual files
webforms-to-blazor convert --input ProductCard.ascx --output ProductCard.razor
```

**What it does:**
- Converts directives: `<%@ Page %>` → `@page`, `<%@ Control %>` → `@inherits`
- Removes `asp:` prefixes: `<asp:Button>` → `<Button>`
- Converts expressions: `<%: Model.Name %>` → `@(Model.Name)`
- Detects patterns: Injects TODO comments for Copilot L2 automation
- Scaffolds projects: Generates a .NET 10 Blazor SSR Program.cs, App.razor, shims, and services

**See the [CLI Tool Documentation](docs/cli/index.md) for:**
- [Transform Reference](docs/cli/transforms.md) — All 33 transforms with before/after examples
- [TODO Categories](docs/cli/todo-conventions.md) — Understand migration guidance comments
- [Report Schema](docs/cli/report.md) — Interpret the migration report

## JavaScript Migration & ClientScript Support

Migrating JavaScript from Web Forms' `Page.ClientScript` and `ScriptManager` to Blazor's `IJSRuntime` is crucial for any real Web Forms application. **[ClientScript Migration Guide](docs/Migration/ClientScriptMigrationGuide.md)** covers:

- Converting `RegisterStartupScript()` to `OnAfterRenderAsync()`
- Migrating script includes and inline blocks
- Replacing postback event patterns with Blazor events
- Handling form validation with `EditContext`
- ScriptManager patterns and their Blazor equivalents

**Diagnostic Rules** help identify patterns that need migration:
- **[BWFC022](docs/Analyzers/BWFC022.md)** — Page.ClientScript usage
- **[BWFC023](docs/Analyzers/BWFC023.md)** — IPostBackEventHandler implementation
- **[BWFC024](docs/Analyzers/BWFC024.md)** — ScriptManager code-behind methods

## Blazor Components for Controls

There are a significant number of controls in ASP.NET Web Forms, and we will focus on creating components in the following order:

- Editor Controls
    - [AdRotator](docs/EditorControls/AdRotator.md)
    - [BulletedList](docs/EditorControls/BulletedList.md)
    - [Button](docs/EditorControls/Button.md)
    - [Calendar](docs/EditorControls/Calendar.md)
    - [CheckBox](docs/EditorControls/CheckBox.md)
    - [CheckBoxList](docs/EditorControls/CheckBoxList.md)
    - [Content](docs/EditorControls/Content.md)
    - [ContentPlaceHolder](docs/EditorControls/ContentPlaceHolder.md)
    - [DropDownList](docs/EditorControls/DropDownList.md)
    - [FileUpload](docs/EditorControls/FileUpload.md)
    - [HiddenField](docs/EditorControls/HiddenField.md)
    - [Image](docs/EditorControls/Image.md)
    - [ImageButton](docs/EditorControls/ImageButton.md)
    - [ImageMap](docs/NavigationControls/ImageMap.md)
    - [Label](docs/EditorControls/Label.md)
    - [LinkButton](docs/EditorControls/LinkButton.md)
    - [ListBox](docs/EditorControls/ListBox.md)
    - [Literal](docs/EditorControls/Literal.md)
    - [Localize](docs/EditorControls/Localize.md)
    - [MasterPage](docs/EditorControls/MasterPage.md)
    - [MultiView](docs/EditorControls/MultiView.md)
    - [Panel](docs/EditorControls/Panel.md)
    - [PlaceHolder](docs/EditorControls/PlaceHolder.md)
    - [RadioButton](docs/EditorControls/RadioButton.md)
    - [RadioButtonList](docs/EditorControls/RadioButtonList.md)
    - [Table](docs/EditorControls/Table.md)
    - [TextBox](docs/EditorControls/TextBox.md)
    - [View](docs/EditorControls/View.md)
    - ~~Xml~~ — *Deferred ([details](docs/Migration/DeferredControls.md))*
  - Data Controls
    - [Chart](docs/DataControls/Chart.md)
    - [DataGrid](docs/DataControls/DataGrid.md)
    - [DataList](docs/DataControls/DataList.md)
    - [DataPager](docs/DataControls/DataPager.md)
    - [DetailsView](docs/DataControls/DetailsView.md)
    - [FormView](docs/DataControls/FormView.md)
    - [GridView](docs/DataControls/GridView.md)
    - [ListView](docs/DataControls/ListView.md)
    - [Repeater](docs/DataControls/Repeater.md)
  - Validation Controls
    - [BaseCompareValidator](docs/ValidationControls/BaseCompareValidator.md)
    - [BaseValidator](docs/ValidationControls/BaseValidator.md)
    - [CompareValidator](docs/ValidationControls/CompareValidator.md)
    - [CustomValidator](docs/ValidationControls/CustomValidator.md)
    - [RangeValidator](docs/ValidationControls/RangeValidator.md)
    - [RegularExpressionValidator](docs/ValidationControls/RegularExpressionValidator.md)
    - [RequiredFieldValidator](docs/ValidationControls/RequiredFieldValidator.md)
    - [ValidationSummary](docs/ValidationControls/ValidationSummary.md)
  - Navigation Controls
    - [HyperLink](docs/NavigationControls/HyperLink.md)
    - [Menu](docs/NavigationControls/Menu.md)
    - [SiteMapPath](docs/NavigationControls/SiteMapPath.md)
    - [TreeView](docs/NavigationControls/TreeView.md)
    - [Wizard](docs/NavigationControls/Wizard.md)
  - Login Controls
    - [ChangePassword](docs/LoginControls/ChangePassword.md)
    - [CreateUserWizard](docs/LoginControls/CreateUserWizard.md)
    - [Login](docs/LoginControls/Login.md)
    - [LoginName](docs/LoginControls/LoginName.md)
    - [LoginStatus](docs/LoginControls/LoginStatus.md)
    - [LoginView](docs/LoginControls/LoginView.md)
    - [PasswordRecovery](docs/LoginControls/PasswordRecovery.md)
  - AJAX Controls
    - [ScriptManager](docs/EditorControls/ScriptManager.md)
    - [ScriptManagerProxy](docs/EditorControls/ScriptManagerProxy.md)
    - [Substitution](docs/EditorControls/Substitution.md)
    - [Timer](docs/EditorControls/Timer.md)
    - [UpdatePanel](docs/EditorControls/UpdatePanel.md)
    - [UpdateProgress](docs/EditorControls/UpdateProgress.md)
  - Utility Components
    - [NamingContainer](docs/UtilityFeatures/NamingContainer.md)

## Ajax Control Toolkit Components

The **Ajax Control Toolkit** extender components are available in a separate NuGet package:

[![Nuget](https://img.shields.io/nuget/v/BlazorAjaxToolkitComponents?color=blue)](https://www.nuget.org/packages/BlazorAjaxToolkitComponents/)  [![Nuget (with prereleases)](https://img.shields.io/nuget/vpre/BlazorAjaxToolkitComponents)](https://www.nuget.org/packages/BlazorAjaxToolkitComponents/)

These components enable seamless migration of Ajax Control Toolkit extenders to Blazor with minimal markup changes. Simply remove the `ajaxToolkit:` prefix and you're ready to go!

Supported extender and container components:

- [Accordion](docs/AjaxToolkit/Accordion.md) — Collapsible content panes
- [AutoCompleteExtender](docs/AjaxToolkit/AutoCompleteExtender.md) — Typeahead suggestions
- [CalendarExtender](docs/AjaxToolkit/CalendarExtender.md) — Popup date picker
- [CollapsiblePanelExtender](docs/AjaxToolkit/CollapsiblePanelExtender.md) — Panel collapse/expand
- [ConfirmButtonExtender](docs/AjaxToolkit/ConfirmButtonExtender.md) — Browser confirmation dialogs
- [FilteredTextBoxExtender](docs/AjaxToolkit/FilteredTextBoxExtender.md) — Character filtering
- [HoverMenuExtender](docs/AjaxToolkit/HoverMenuExtender.md) — Hover-triggered popups
- [MaskedEditExtender](docs/AjaxToolkit/MaskedEditExtender.md) — Input mask formatting
- [ModalPopupExtender](docs/AjaxToolkit/ModalPopupExtender.md) — Modal popup dialogs
- [NumericUpDownExtender](docs/AjaxToolkit/NumericUpDownExtender.md) — Numeric spinner
- [PopupControlExtender](docs/AjaxToolkit/PopupControlExtender.md) — Click-triggered popups
- [SliderExtender](docs/AjaxToolkit/SliderExtender.md) — Range slider
- [TabContainer](docs/AjaxToolkit/TabContainer.md) — Tabbed content panels
- [ToggleButtonExtender](docs/AjaxToolkit/ToggleButtonExtender.md) — Image toggle for checkboxes

See the [full documentation](docs/AjaxToolkit/index.md) for detailed examples, migration guidance, and render mode requirements.

We will NOT be convertingany DataSource objects (SqlDataSource, ObjectDataSource, EntityDataSource, LinqDataSource, XmlDataSource, SiteMapDataSource, AccessDataSource), Wizard components, skins or themes.  Once this first collection of controls is written, we can consider additional features like modern tag formatting.

## Utility Features

There are a handful of features that augment the ASP<span></span>.NET development experience that are made available as part of this project in order to support migration efforts.  Importantly, these features are NOT implemented the same way that they are in Web Forms, but rather have the same API and behave in a proper Blazor fashion.  These features include:

- [DataBinder](docs/UtilityFeatures/Databinder.md)
  - [ID Rendering](docs/UtilityFeatures/IDRendering.md) - Render HTML IDs for JavaScript integration
  - [JavaScript Setup](docs/UtilityFeatures/JavaScriptSetup.md) - Options for auto-loading required JavaScript
  - [Page System](docs/UtilityFeatures/PageService.md) - WebFormsPageBase, IPageService, and Page renderer (Page.Title, IsPostBack equivalents)
  - [ViewState](docs/UtilityFeatures/ViewState.md)

### Custom Control Migration Support

For applications with custom controls inheriting from `WebControl` or `CompositeControl`, the library provides:

- **Adapter Classes**: `WebControl`, `CompositeControl`, and `HtmlTextWriter` classes that enable minimal-change migration
  - Base attributes (ID, CssClass, Style) are automatically applied - no manual intervention needed
- **Roslyn Analyzers**: The `BlazorWebFormsComponents.Analyzers` NuGet package provides automated code analysis and fixes:
  - **BWFC001**: Detects public properties missing `[Parameter]` attributes with automatic fix

See the [Custom Controls Migration Guide](docs/Migration/Custom-Controls.md) for details.

## Compiling the project

There are three different types of .NET projects in this repository:  .NET Framework, .NET Core, and .NET Standard.  The sample projects are in the `/samples` folder, while the unit test project is next to the component library in the `/src` folder.  From the root of the repository, you should be able to execute:

`dotnet restore` to restore packages

`dotnet run --project samples/AfterBlazorServerSide` to start the Blazor Server-Side samples

## Testing

The project includes two types of tests:

### Unit Tests
Unit tests for the component library are located in `src/BlazorWebFormsComponents.Test/` and use xUnit with bUnit for component testing.

Run unit tests with:
```bash
dotnet test src/BlazorWebFormsComponents.Test
```

### Integration Tests
Integration tests using Playwright validate the sample application pages. These tests are located in `samples/AfterBlazorServerSide.Tests/`.

To run integration tests locally:
1. Install Playwright browsers (first time only):
   ```bash
   pwsh samples/AfterBlazorServerSide.Tests/bin/Debug/net10.0/playwright.ps1 install
   ```
2. Run the tests:
   ```bash
   dotnet test samples/AfterBlazorServerSide.Tests
   ```

See [samples/AfterBlazorServerSide.Tests/README.md](samples/AfterBlazorServerSide.Tests/README.md) for more details.

## Releasing

This project uses automated scripts with Nerdbank.GitVersioning to help with version publishing and release management. See the [scripts/README.md](scripts/README.md) for detailed documentation on:

- **prepare-release.sh** - Uses `nbgv` to update version.json and generates release notes
- **generate-release-notes.sh** - Creates formatted release notes from git commits
- **publish-release.sh** - Uses `nbgv tag` to create and publish release tags

Quick workflow:
1. On `dev` branch: `./scripts/prepare-release.sh 0.14`
2. Merge `dev` to `main`
3. On `main` branch: `./scripts/publish-release.sh`

The NuGet package is automatically published via GitHub Actions when a version tag is pushed.

## Contributing

We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for the full guide on how to contribute code, documentation, and use cases.

**Quick start with Copilot CLI:**
```
Add a new Blazor component called XyzControl that emulates the Web Forms XyzControl with the same attributes and identical HTML output
```

**Local development:**
```bash
dotnet restore
dotnet build
dotnet test src/BlazorWebFormsComponents.Test
```

Every PR needs unit tests (bUnit), a sample page, and documentation. See [AGENTS.md](AGENTS.md) for the full contributor guide including the complete registration chain for new components.

BlazorWebFormsComponents

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README