Ant Design Blazor

A set of enterprise-class UI components based on Ant Design and Blazor.

English | 简体中文

✨ Features

• 🌈 Enterprise-class UI designed for web applications.
• 📦 A set of high-quality Blazor components out of the box.
• 💕 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.
• ⚙️ .NET Standard 2.1/.NET 5 based, with direct reference to the rich .NET ecosystem.
• 🎁 Seamless integration with existing ASP.NET Core MVC and Razor Pages projects.

🌈 Online Examples

WebAssembly static hosting examples:

• GitHub
• Gitee

🖥 Environment Support

• .NET Core 3.1 / .NET 5
• Blazor WebAssembly 3.2/.NET 5 Release
• Supports two-way binding on the server side
• Supports WebAssembly static file deployment
• Support 4 major browsers engines, and Internet Explorer 11+ (Blazor Server only)
• Run directly on Electron and other Web standards-based environments

Edge / IE	Firefox	Chrome	Safari	Opera	Electron
Edge 16 / IE 11†	522	57	11	44	Chromium 57

Due to WebAssembly restriction, Blazor WebAssembly doesn't support IE browser, but Blazor Server supports IE 11† with additional polyfills. See official documentation

💿 Current Version

• Release:

• Nightly:

  Download our latest nightly builds

🎨 Design Specification

Regularly synchronize with Official Ant Design specifications, you can check the sync logs online.

Therefore, you can use the custom theme styles of Ant Design directly.

📦 Installation Guide

• Install .NET Core SDK 3.1.300 or later, .NET 5 is even better.

Create a new project from the dotnet new template

We have provided the dotnet new template to create a Boilerplate project out of the box：

• Install the template

  $ dotnet new --install AntDesign.Templates
  

• Create the Boilerplate project with the template

  $ dotnet new antdesign -o MyAntDesignApp
  

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'
--no-restore	If specified, skips the automatic restore of the project on create	bool	false

Import Ant Design Blazor into an existing project

• Go to the project folder of the application and install the Nuget package reference

  $ dotnet add package AntDesign
  

• Register the services in Program.cs (WebAssembly)

  builder.Services.AddAntDesign();
  

  or Startup.cs (Server)

  services.AddAntDesign();
  

• Link the static files in wwwroot/index.html (WebAssembly) or Pages/_Host.cshtml (Server)

  <link href="_content/AntDesign/css/ant-design-blazor.css" rel="stylesheet" />
  <script src="_content/AntDesign/js/ant-design-blazor.js"></script>
  

• Add namespace in _Imports.razor

  @using AntDesign
  

• To display the pop-up component dynamically, you need to add the <AntContainer /> component in App.razor.

  <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 ✨
  

• Finally, it can be referenced in the `.razor' component!

  <Button Type="primary">Hello World!</Button>
  

⌨️ Local Development

• Install .NET Core SDK 5.0.100 or later.

• Install Node.js (only for building style files and interoperable TypeScript files)

• Clone to local development

  $ git clone git@github.com:ant-design-blazor/ant-design-blazor.git
  $ cd ant-design-blazor
  $ npm install
  $ npm start
  

• Visit https://localhost:5001 in your supported browser and check local development documentation for details.

  Visual Studio 2019 is recommended for development.

🔗 Links

• Ant Design Blazor Documentation
• Official Blazor Documentation
• MS Learn for Blazor Tutorial

🗺 Roadmap

Check out this issue to learn about our development plans for 2020.

🤝 Contributing

If you would like to contribute, feel free to create a Pull Request, or give us Bug Report.

Contributors

This project exists thanks to all the people who contribute.

💕 Donation

This project is an MIT-licensed open source project. In order to achieve better and sustainable development of the project, we expect to gain more backers. We will use the proceeds for community operations and promotion. You can support us in any of the following ways:

• OpenCollective
• Wechat
• Alipay

We will put the detailed donation records on the backer list.

❓ 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.

• 

• 

  Scan QR Code with DingTalk

Code of Conduct

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information see the .NET Foundation Code of Conduct.

☀️ License

.NET Foundation

This project is supported by the .NET Foundation.