mirror of
https://gitee.com/ant-design-blazor/ant-design-blazor.git
synced 2024-11-29 10:38:18 +08:00
258 lines
14 KiB
Markdown
258 lines
14 KiB
Markdown
<p align="center">
|
||
<a href="https://yangshunjie.com/ant-design-blazor/">
|
||
<img src="https://raw.githubusercontent.com/ant-design-blazor/ant-design-blazor/master/logo.svg?sanitize=true">
|
||
</a>
|
||
</p>
|
||
|
||
<h1 align="center">Ant Design Blazor</h1>
|
||
|
||
<div align="center">
|
||
|
||
一套基于 Ant Design 和 Blazor 的企业级组件库
|
||
|
||
|
||
[](https://www.nuget.org/packages/AntDesign/)
|
||
[](https://www.nuget.org/packages/AntDesign/)
|
||
[](https://github.com/ant-design-blazor/ant-design-pro-blazor)
|
||
[](https://codecov.io/gh/ant-design-blazor/ant-design-blazor)
|
||
[](https://github.com/ant-design-blazor/ant-design-blazor/blob/master/LICENSE)
|
||
[](https://h5.dingtalk.com/circle/healthCheckin.html?corpId=dingf3df1949a4aa48627b0128d9a44ecb79&c5df5865-4f41-=be1b34c7-397b-&cbdbhh=qwertyuiop&origin=11)
|
||
[](https://discord.com/invite/jqu3Xeq)
|
||
|
||
</div>
|
||
|
||
[](https://ant-design-blazor.github.io)
|
||
|
||
[English](./README.md) | 简体中文
|
||
|
||
## ✨ 特性
|
||
|
||
- 🌈 提炼自企业级中后台产品的交互语言和视觉风格。
|
||
- 📦 开箱即用的高质量 Blazor 组件，可在多种托管方式共享。
|
||
- 💕 支持基于 WebAssembly 的前端和基于 SignalR 的服务端 UI 即时交互。
|
||
- 🎨 支持渐进式 Web 应用（PWA）
|
||
- 🛡 使用 C# 构建，多范式静态语言带来高效的开发体验。
|
||
- ⚙️ 支持 .NET Core 3.1 以上所有版本，可直接引用丰富的 .NET 类库。
|
||
- 🌍 数十个国际化语言支持。
|
||
- 💴 基于 MIT 开源协议，.NET 基金会项目，商业应用免费。
|
||
|
||
## 🌈 在线示例
|
||
|
||
WebAssembly 静态托管页面示例
|
||
|
||
- [文档站点](https://antblazor.com/)
|
||
- [企业级仪表板](https://pro.antblazor.com/)
|
||
|
||
## 🖥 支持环境
|
||
|
||
- 支持 .NET Core 3.1 / .NET 5 / .NET 6 / .NET 7 / .NET 8 / .NET 9。
|
||
- 支持 WebAssembly 静态文件部署。
|
||
- 支持主流 4 款现代浏览器，以及 Internet Explorer 11+（限 [Blazor Server](https://docs.microsoft.com/en-us/aspnet/core/blazor/supported-platforms?view=aspnetcore-3.1&WT.mc_id=DT-MVP-5003987)）。
|
||
- 支持 [.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) 等 Blazor 混合客户端环境中。
|
||
- 支持 [Electron](http://electron.atom.io/) 等基于 Web 标准的环境上。
|
||
|
||
> 由于 [WebAssembly](https://webassembly.org) 的限制，Blazor WebAssembly 不支持 IE 浏览器，但 Blazor Server 支持 IE 11†。 详见[官网说明](https://docs.microsoft.com/en-us/aspnet/core/blazor/supported-platforms?view=aspnetcore-3.1&WT.mc_id=DT-MVP-5003987)。
|
||
|
||
> 从 .NET 5 开始，Blazor 不再官方支持 IE 11。详见 [Blazor: Updated browser support](https://docs.microsoft.com/en-us/dotnet/core/compatibility/aspnet-core/5.0/blazor-browser-support-updated)。社区项目 [Blazor.Polyfill](https://github.com/Daddoon/Blazor.Polyfill) 提供了非官方支持。
|
||
|
||
## 💿 当前版本
|
||
|
||
- 正式发布： [](https://www.nuget.org/packages/AntDesign/)
|
||
- 每日构建: [](https://www.myget.org/feed/ant-design-blazor/package/nuget/AntDesign)
|
||
|
||
_[了解如何安装每日构建版本](docs/nightly-build.zh-CN.md)_
|
||
|
||
## 🎨 设计规范
|
||
|
||
与 Ant Design 设计规范定期同步，你可以在线查看[同步日志](https://github.com/ant-design-blazor/ant-design-blazor/actions?query=workflow%3A%22Style+sync+Bot%22)。
|
||
|
||
因此，你可以直接使用在 Ant Design 中的自定义主题样式。
|
||
|
||
**在 1.0 版本发布之前，我们将只同步 antd 4.x 的样式。**
|
||
|
||
## 📦 安装
|
||
|
||
### 先决条件
|
||
|
||
- 先安装 [.NET Core SDK](https://dotnet.microsoft.com/download/dotnet-core/3.1?WT.mc_id=DT-MVP-5003987) 3.1 以上版本，推荐 .NET 8。
|
||
|
||
### 选择一：从模板创建一个新项目 [](https://github.com/ant-design-blazor/ant-design-pro-blazor)
|
||
|
||
我们提供了 `dotnet new` 模板来创建一个开箱即用的 [Ant Design Pro](https://github.com/ant-design-blazor/ant-design-pro-blazor) 新项目：
|
||
|
||
|
||
|
||
- 安装模板
|
||
|
||
```bash
|
||
$ dotnet new --install AntDesign.Templates
|
||
```
|
||
|
||
- 从模板创建 Ant Design Blazor Pro 项目
|
||
|
||
```bash
|
||
$ dotnet new antdesign -o MyAntDesignApp
|
||
```
|
||
|
||
模板的参数：
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 |
|
||
| ----------------- | ------------------------------------------------ | ------------------------------ | ------ |
|
||
| `-f` \| `--full` | 如果设置这个参数，会生成所有 Ant Design Pro 页面 | bool | false |
|
||
| `-ho` \| `--host` | 指定托管模型 | 'webapp' \| 'wasm' \| 'server' | 'webapp' |
|
||
| `--styles` | 指定样式构建类型 | `css` \| `less` | `css` |
|
||
| `--no-restore` | 如果设置这个参数，就不会自动恢复包引用 | bool | false |
|
||
|
||
### 选择二：在已有项目中引入 Ant Design Blazor
|
||
|
||
- 进入应用的项目文件夹，安装 Nuget 包引用
|
||
|
||
```bash
|
||
$ dotnet add package AntDesign
|
||
```
|
||
|
||
- 在项目的 `Program.cs` 中注册相关服务：
|
||
|
||
```csharp
|
||
builder.Services.AddAntDesign();
|
||
```
|
||
|
||
或者在 `Startup.cs` 中：
|
||
|
||
```csharp
|
||
services.AddAntDesign();
|
||
```
|
||
|
||
- 在 `_Imports.razor` 中加入命名空间
|
||
|
||
```csharp
|
||
@using AntDesign
|
||
```
|
||
|
||
- 适当的位置引入 CSS 和 JS 文件。WebApp 项目在App.razor 中引入，WebAssembly 项目在 index.html 中引入
|
||
|
||
```html
|
||
<link href="_content/AntDesign/css/ant-design-blazor.css" rel="stylesheet">
|
||
< src="_content/AntDesign/js/ant-design-blazor.js"></ script>
|
||
```
|
||
|
||
- 为了动态地显示弹出组件，需要在 `App.razor` 中添加一个 `<AntContainer />` 组件。
|
||
|
||
- 对于 Blazor WebApp 项目，还需要为 `Routes` 指定渲染模式来支持交互性。
|
||
|
||
```diff
|
||
<Routes @rendermode="RenderMode.InteractiveAuto" /> <-- 指定渲染模式 ✨
|
||
+ <AntContainer @rendermode="RenderMode.InteractiveAuto" /> <-- 在这里添加容器 ✨
|
||
```
|
||
|
||
- 对于旧版本的项目，则只需加一行代码:
|
||
|
||
```diff
|
||
<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 /> <-- 在这里添加容器 ✨
|
||
```
|
||
|
||
- 最后就可以在`.razor`组件中引用啦！
|
||
|
||
```razor
|
||
<Button Type="primary">Hello World!</Button>
|
||
```
|
||
|
||
## 🔨 开发
|
||
|
||
### Gitpod
|
||
|
||
点击下方按钮，免费创建一个新的工作区用于开发。
|
||
|
||
[](https://gitpod.io/#https://github.com/ant-design-blazor/ant-design-blazor)
|
||
|
||
### 本地
|
||
|
||
- 先安装 [.NET Core SDK](https://dotnet.microsoft.com/download/dotnet/9.0?WT.mc_id=DT-MVP-5003987) 9.0.100 以上版本
|
||
- 安装 Node.js（只用于样式文件和互操作所需 TS 文件的构建）
|
||
- 克隆到本地开发
|
||
|
||
```bash
|
||
$ git clone git@github.com:ant-design-blazor/ant-design-blazor.git
|
||
$ cd ant-design-blazor
|
||
$ npm install
|
||
$ dotnet build ./site/AntDesign.Docs.Build/AntDesign.Docs.Build.csproj
|
||
$ npm start
|
||
```
|
||
|
||
- 打开浏览器访问 https://localhost:5001 ，详情参考[本地开发文档](https://github.com/ant-design-blazor/ant-design-blazor/wiki)。
|
||
|
||
> 推荐使用 Visual Studio 2022 开发。
|
||
|
||
## 🔗 链接
|
||
|
||
- [文档主页](https://antblazor.com)
|
||
- [Ant Design Blazor 商业应用调查](https://wj.qq.com/s2/10306537/c332/)
|
||
- [Blazor 官方文档](https://docs.microsoft.com/zh-cn/aspnet/core/blazor/?WT.mc_id=DT-MVP-5003987)
|
||
- [MS Learn 平台 Blazor 教程](https://docs.microsoft.com/zh-cn/learn/modules/build-blazor-webassembly-visual-studio-code/?WT.mc_id=DT-MVP-5003987)
|
||
|
||
## 🗺 开发路线
|
||
|
||
查看[这个 issue](https://github.com/ant-design-blazor/ant-design-blazor/issues/21) 来了解我们在 1.0 版本的开发计划。
|
||
|
||
另外也可以关注这个 [issue](https://github.com/ant-design-blazor/ant-design-blazor/issues/2870) 了解我们关于将来对 antd 5.0 适配的讨论和最新进展。
|
||
|
||
## 🤝 如何贡献
|
||
|
||
[](https://github.com/ant-design-blazor/ant-design-blazor/pulls)
|
||
|
||
如果你希望参与贡献，欢迎 [Pull Request](https://github.com/ant-design-blazor/ant-design-blazor/pulls)，或给我们 [报告 Bug](https://github.com/ant-design-blazor/ant-design-blazor/issues/new) 。
|
||
|
||
## 💕 支持本项目
|
||
|
||
本项目以 MIT 协议开源，为了能得到够更好的且可持续的发展，我们期望获得更多的支持者，我们将把所得款项用于社区活动和推广。你可以通过如下任何一种方式支持我们:
|
||
|
||
- [OpenCollective](https://opencollective.com/ant-design-blazor)
|
||
- [微信](https://jamesyeung.cn/qrcode/wepay.jpg)
|
||
- [支付宝](https://jamesyeung.cn/qrcode/alipay.jpg)
|
||
|
||
我们会把详细的捐赠记录登记在 [捐赠者名单](https://github.com/ant-design-blazor/ant-design-blazor/issues/62)。
|
||
|
||
## ❓ 社区互助
|
||
|
||
如果您在使用的过程中碰到问题，可以通过以下途径寻求帮助，同时我们也鼓励资深用户通过下面的途径给新人提供帮助。
|
||
|
||
- [](https://discord.com/invite/jqu3Xeq) (英文)
|
||
|
||
- [](https://h5.dingtalk.com/circle/joinCircle.html?corpId=ding82cf43d1ccc223faffe93478753d9884&token=872d544429893379155dfd32580ca02a&groupCode=v1,k1,OgitB0lpZuBX9trsVcblH+V+oKhafALwKQ6AmgviopA=&from=group&ext=%7B%22channel%22%3A%22QR_GROUP_NORMAL%22%2C%22extension%22%3A%7B%22groupCode%22%3A%22v1%2Ck1%2COgitB0lpZuBX9trsVcblH%2BV%2BoKhafALwKQ6AmgviopA%3D%22%2C%22groupFrom%22%3A%22group%22%7D%2C%22inviteId%22%3A137894871%2C%22orgId%22%3A163097163%2C%22shareType%22%3A%22GROUP%22%7D&origin=11) (中文)
|
||
|
||
<img src="/docs/assets/dingtalk.jpg" width="200">
|
||
|
||
- 另外，我还创立了面向中文开发者的 Blazor 中文社区，高手如云，只讨论技术，无卖课广告。可以加我微信（JamesYeungMVP）拉进微信群，另外也有一个 QQ 群 1012762441。广告勿扰。
|
||
|
||
## 贡献者
|
||
|
||
感谢所有为本项目做出过贡献的朋友。
|
||
|
||
<a href="https://github.com/ant-design-blazor/ant-design-blazor/graphs/contributors">
|
||
<img src="https://contrib.rocks/image?repo=ant-design-blazor/ant-design-blazor&max=1000&columns=15&anon=1" />
|
||
</a>
|
||
|
||
## 行为准则
|
||
|
||
本项目采用了《贡献者公约》所定义的行为准则，以明确我们社区的预期行为。
|
||
更多信息请见 [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).
|
||
|
||
## ☀️ 授权协议
|
||
|
||
[](https://github.com/ant-design-blazor/ant-design-blazor/blob/master/LICENSE)
|
||
|
||
## .NET Foundation
|
||
|
||
本项目由 [.NET Foundation](https://dotnetfoundation.org) 支持。
|