2020-05-10 15:42:02 +08:00
---
order: 0
title: Ant Design of Blazor
---
2020-03-30 14:33:39 +08:00
Following the Ant Design specification, we developed a Blazor Components library `ant-design-blazor` that contains a set of high quality components and demos for building rich, interactive user interfaces.
< div class = "pic-plus" >
< img width = "150" src = "https://gw.alipayobjects.com/zos/rmsportal/KDpgvguMpGfqaHPjicRK.svg" >
< span > +< / span >
2022-06-02 17:35:50 +08:00
< img height = "150" src = "https://raw.githubusercontent.com/ant-design-blazor/ant-design-blazor/master/docs/assets/blazor.svg" >
2020-03-30 14:33:39 +08:00
< / div >
< style >
.pic-plus > * {
display: inline-block !important;
vertical-align: middle;
}
.pic-plus span {
font-size: 30px;
color: #aaa ;
margin: 0 20px;
}
< / style >
## ✨ Features
2020-04-24 10:34:54 +08:00
- 🌈 Enterprise-class UI interactive language and visual style.
2022-11-22 23:57:53 +08:00
- 📦 A set of high-quality Blazor components out of the box.
2020-04-24 10:34:54 +08:00
- 💕 Supports WebAssembly-based client-side and SignalR-based server-side UI event interaction.
- 🎨 Supports Progressive Web Applications (PWA).
- 🛡 Build with C#, a multi-paradigm static language for an efficient development experience.
2022-11-22 23:57:53 +08:00
- 🌍 Internationalization support for dozens of languages.
2020-04-24 10:34:54 +08:00
- 🎁 Seamless integration with existing ASP.NET Core MVC and Razor Pages projects.
2020-03-30 14:33:39 +08:00
## 🌈 Online Examples
2023-11-30 12:34:26 +08:00
WebAssembly static hosting on:
2020-03-30 14:33:39 +08:00
2023-11-30 12:34:26 +08:00
- [Document site ](https://antblazor.com/ )
- [Enterprise system dashboard ](https://pro.antblazor.com/ )
2020-03-30 14:33:39 +08:00
## 🖥 Environment Support
2023-11-17 00:39:15 +08:00
- Supports .NET Core 3.1 / .NET 5 / .NET 6 / .Net 7 / .NET 8.
2022-11-22 23:57:53 +08:00
- Supports WebAssembly static file deployment.
- Supports 4 major browsers engines, and Internet Explorer 11+ ([Blazor Server](https://docs.microsoft.com/en-us/aspnet/core/blazor/supported-platforms?view=aspnetcore-6.0& WT.mc_id=DT-MVP-5003987) only)
- Supports [.NET MAUI ](https://dotnet.microsoft.com/zh-cn/apps/maui?WT.mc_id=DT-MVP-5003987 ) / [WPF ](https://docs.microsoft.com/en-us/aspnet/core/blazor/hybrid/tutorials/wpf?view=aspnetcore-6.0&WT.mc_id=DT-MVP-5003987 ) / [Windows Forms ](https://docs.microsoft.com/en-us/aspnet/core/blazor/hybrid/tutorials/windows-forms?view=aspnetcore-6.0 ) and other Blazor Hybrid workloads.
- Supports [Electron ](http://electron.atom.io/ ) and other Web standards-based environments.
2020-03-30 14:33:39 +08:00
2021-12-20 11:13:46 +08:00
> Due to [WebAssembly](https://webassembly.org) restriction, Blazor WebAssembly doesn't support IE browser, but Blazor Server supports IE 11† with additional polyfills. See [official documentation](https://docs.microsoft.com/en-us/aspnet/core/blazor/supported-platforms?view=aspnetcore-3.1&WT.mc_id=DT-MVP-5003987).
> From .NET 5, IE 11 is no longer officially supported. See [Blazor: Updated browser support](https://docs.microsoft.com/en-us/dotnet/core/compatibility/aspnet-core/5.0/blazor-browser-support-updated). Unofficial support is provided by [Blazor.Polyfill](https://github.com/Daddoon/Blazor.Polyfill) community project.
2020-03-30 14:33:39 +08:00
## 💿 Current Version
2020-07-01 10:24:37 +08:00
- Release: [![AntDesign ](https://img.shields.io/nuget/v/AntDesign.svg?color=red&style=flat-square )](https://www.nuget.org/packages/AntDesign/)
2023-11-30 12:34:26 +08:00
- Nightly: [![AntDesign ](https://img.shields.io/myget/ant-design-blazor/vpre/AntDesign?style=flat-square )](https://www.myget.org/feed/ant-design-blazor/package/nuget/AntDesign)
_[Download our latest nightly builds](docs/nightly-build.en-US.md)_
2020-03-30 14:33:39 +08:00
## 🎨 Design Specification
2020-04-28 00:13:43 +08:00
Regularly synchronize with Official Ant Design specifications, you can check the [sync logs ](https://github.com/ant-design-blazor/ant-design-blazor/actions?query=workflow%3A%22Style+sync+Bot%22 ) online.
2020-03-30 14:33:39 +08:00
2023-06-18 19:43:40 +08:00
**Before the 1.0 release, we will only sync antd 4.x styles.**
2020-03-30 14:33:39 +08:00
## 📦 Installation Guide
2023-11-30 12:34:26 +08:00
### Prerequirement
2023-11-17 00:39:15 +08:00
- Install [.NET Core SDK ](https://dotnet.microsoft.com/download/dotnet-core/3.1?WT.mc_id=DT-MVP-5003987 ) 3.1.300 or later, .NET 8 is even better.
2020-03-30 14:33:39 +08:00
2023-11-30 12:34:26 +08:00
### Option 1: Create a new project from the dotnet new template [![AntDesign.Templates](https://img.shields.io/nuget/v/AntDesign.Templates?color=%23512bd4&label=Templates&style=flat-square)](https://github.com/ant-design-blazor/ant-design-pro-blazor)
2020-08-25 12:42:02 +08:00
We have provided the `dotnet new` template to create a [Boilerplate ](https://github.com/ant-design-blazor/ant-design-pro-blazor ) project out of the box:
- Install the template
```bash
2022-06-16 00:31:53 +08:00
$ dotnet new --install AntDesign.Templates
2020-08-25 12:42:02 +08:00
```
- Create the Boilerplate project with the template
2020-03-30 14:33:39 +08:00
```bash
2020-08-25 12:42:02 +08:00
$ dotnet new antdesign -o MyAntDesignApp
2020-03-30 14:33:39 +08:00
```
2020-04-28 00:13:43 +08:00
2020-08-25 12:42:02 +08:00
Options for the template:
| Options | Description | Type | Default |
| ---------------- | -------------------------------------------- | ------ | --------- |
| `-f` \| `--full` | If specified, generates all pages of ant design pro | bool | false |
| `-ho` \| `--host` | Specify the hosting model | 'wasm' \| 'server' \| 'hosted' |'wasm' |
2023-11-30 12:34:26 +08:00
| `--styles` | Whether use NodeJS and Less to compile your custom themes. | `css` \| `less` | `css` |
2020-08-25 12:42:02 +08:00
| `--no-restore` | If specified, skips the automatic restore of the project on create | bool | false |
2023-11-30 12:34:26 +08:00
### Option 2: Import Ant Design Blazor into an existing project
2020-08-25 12:42:02 +08:00
2020-03-30 14:33:39 +08:00
- Go to the project folder of the application and install the Nuget package reference
```bash
2022-06-16 00:31:53 +08:00
$ dotnet add package AntDesign
2020-03-30 14:33:39 +08:00
```
2023-11-30 12:34:26 +08:00
- Register the services in `Program.cs`
```csharp
builder.Services.AddAntDesign();
```
or `Startup.cs`
2020-03-30 14:33:39 +08:00
```csharp
2020-05-29 00:33:49 +08:00
services.AddAntDesign();
2020-03-30 14:33:39 +08:00
```
- Add namespace in `_Imports.razor`
```csharp
2020-05-29 00:33:49 +08:00
@using AntDesign
2020-03-30 14:33:39 +08:00
```
2020-06-20 01:03:06 +08:00
- To display the pop-up component dynamically, you need to add the `<AntContainer />` component in `App.razor` .
2023-11-30 12:34:26 +08:00
- For Blazor WebApp, you also need to specify render mode to `<Routes />` for interactivity.
```diff
< Routes @rendermode =" RenderMode . InteractiveAuto " /> < -- specify the rendermode ✨
+ < AntContainer @rendermode =" RenderMode . InteractiveAuto " /> < -- add this component ✨
```
- For legacy blazor apps just add a line of code:
2020-06-20 01:03:06 +08:00
```
< Router AppAssembly = "@typeof(MainLayout).Assembly" >
< Found Context = "routeData" >
< RouteView RouteData = "routeData" DefaultLayout = "@typeof(MainLayout)" / >
< / Found >
< NotFound >
< LayoutView Layout = "@typeof(MainLayout)" >
< Result Status = "404" / >
< / LayoutView >
< / NotFound >
< / Router >
< AntContainer / > < -- add this component ✨
```
2020-03-30 14:33:39 +08:00
- Finally, it can be referenced in the `.razor' component!
```html
2020-05-29 12:55:15 +08:00
< Button Type = "primary" > Hello World!< / Button >
2020-03-30 14:33:39 +08:00
```
2023-11-30 12:34:26 +08:00
## 🔨 Development
### Gitpod
Click the button below to start a new workspace for development for free.
[![Open in Gitpod ](https://gitpod.io/button/open-in-gitpod.svg )](https://gitpod.io/#https://github.com/ant-design-blazor/ant-design-blazor)
### Local
2020-03-30 14:33:39 +08:00
2023-11-30 12:34:26 +08:00
- Install [.NET Core SDK ](https://dotnet.microsoft.com/download/dotnet/8.0?WT.mc_id=DT-MVP-5003987 ) 8.0.100 or later.
2020-03-30 14:33:39 +08:00
- Install Node.js (only for building style files and interoperable TypeScript files)
- Clone to local development
```bash
2020-04-28 00:13:43 +08:00
$ git clone git@github.com:ant-design-blazor/ant-design-blazor.git
2020-03-30 14:33:39 +08:00
$ cd ant-design-blazor
$ npm install
2023-06-18 19:43:40 +08:00
$ dotnet build ./site/AntDesign.Docs.Build/AntDesign.Docs.Build.csproj
2020-03-30 14:33:39 +08:00
$ npm start
```
2020-04-28 00:13:43 +08:00
- Visit https://localhost:5001 in your supported browser and check [local development documentation ](https://github.com/ant-design-blazor/ant-design-blazor/wiki ) for details.
2022-06-16 00:31:53 +08:00
> Visual Studio 2022 is recommended for development.
2020-03-30 14:33:39 +08:00
## 🔗 Links
2020-11-03 00:49:13 +08:00
- [Official Blazor Documentation ](https://docs.microsoft.com/en-us/aspnet/core/blazor/?WT.mc_id=DT-MVP-5003987 )
- [MS Learn for Blazor Tutorial ](https://docs.microsoft.com/en-us/learn/modules/build-blazor-webassembly-visual-studio-code/?WT.mc_id=DT-MVP-5003987 )
2020-03-30 14:33:39 +08:00
## 🤝 Contributing
2020-04-28 00:13:43 +08:00
[![PRs Welcome ](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square )](https://github.com/ant-design-blazor/ant-design-blazor/pulls)
2020-03-30 14:33:39 +08:00
2020-04-28 00:13:43 +08:00
If you would like to contribute, feel free to create a [Pull Request ](https://github.com/ant-design-blazor/ant-design-blazor/pulls ), or give us [Bug Report ](https://github.com/ant-design-blazor/ant-design-blazor/issues/new ).
2020-03-30 14:33:39 +08:00
## ❓ Community Support
If you encounter any problems in the process, feel free to ask for help via following channels. We also encourage experienced users to help newcomers.
2022-04-22 20:00:48 +08:00
- [![Discord Server ](https://img.shields.io/discord/753358910341251182?color=%237289DA&label=AntBlazor&logo=discord&logoColor=white&style=flat-square )](https://discord.com/invite/jqu3Xeq)
2020-03-30 14:33:39 +08:00
## ☀️ License
2020-05-29 00:33:49 +08:00
[![AntDesign ](https://img.shields.io/badge/License-MIT-blue?style=flat-square )](https://github.com/ant-design-blazor/ant-design-blazor/blob/master/LICENSE)