ant-design-blazor/README.md
Benjamin Vertonghen afa9e5ba29 docs: Translate README.md | introduce.md to English (#25)
Co-authored-by: Benjamin Vertonghen <benjamin.vertonghen@apped.be>
2020-03-25 11:18:59 +08:00

6.9 KiB
Raw Blame History

Ant Design Blazor

An enterprise-class UI components based on Ant Design and Blazor.

AntBlazor AntBlazor AntBlazor

Characteristic

  • Distilled from the interactive language and visual style of back-end products in the enterprise.
  • Out-of-the-box, high-quality Razor components that can be shared in a variety of hosted ways.
  • Supports WebAssembly-based client-side and SignalR-based server-side UI event interaction.
  • Support for Progressive Web Applications (PWA)
  • Build in C#, a multi-paradigm static language for an efficient development experience.
  • NET Standard 2.1 based, with direct reference to the rich ecosystem of .NET
  • Seamless integration with existing ASP.NET Core MVC, Razor Pages projects.

🌈 Online examples

由 WebAssembly build, hosted on Gitee Pages http://ant-design-blazor.gitee.io/

🖥 Support

  • .NET Core 3.1
  • Blazor WebAssembly 3.2 Preview 2
  • Supports two-way binding on the server side
  • Support for WebAssembly static file deployment
  • Mainstream 4 modern browsers, and Internet Explorer 11+ usage Blazor Server
  • Can be run directly on Electron Web standards-based environments such as
IE / Edge
Edge / IE
Firefox
Firefox
Chrome
Chrome
Safari
Safari
Opera
Opera
Electron
Electron
Edge 16 / IE 11† 522 57 11 44 Chromium 57

Due to WebAssembly Blazor WebAssembly does not support the IE browser, but Blazor Server supports IE 11† for this reason. Official website description

💿 Current Version

  • Development and construction AntBlazor

  • 0.1.0Basic implementation of components after release

🎨 Design Specification

与 Regularly synced with the Ant Design specification, you can view the sync log online.

📦 Installation Guide

  • Install .NET Core SDK 3.1.102 or above
  • Install Blazor WebAssembly Templates
    $ dotnet new -i Microsoft.AspNetCore.Components.WebAssembly.Templates::3.2.0-preview2.20160.5
    
  • Create Blazor WebAssembly Project
    $ dotnet new blazorwasm -o MyAntBlazorApp
    
  • Go to the project folder of the application and install the Nuget package reference
    $ cd MyAntBlazorApp
    $ dotnet add package AntBlazor --version 0.0.1-nightly-55111624
    
  • Register the services:
    services.AddAntBlazor();
    
  • In wwwroot/index.html(WebAssembly) or Pages/_Host.razor(Server) link the static files:
      <link href="_content/AntBlazor/css/ant-design-blazor.css" rel="stylesheet">
      <script src="_content/AntBlazor/js/ant-design-blazor.js"></script>
    
  • In _Imports.razor add the namespace
    @using AntBlazor
    
  • Finally, it can be referenced in the `.razor' component!
    <AntButton type="primary">Hello World!</AntButton>
    

🔨 Local development

  • Install .NET Core SDK 3.1.102 or later.

  • Install Node.js (only for style file and interoperable TS file builds)

  • Cloning to local development

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

    Open your browser to https://localhost:5001 and refer to [local development documentation] (https://github.com/ElderJames/ant-design-blazor/wiki) for details.

    Visual Studio 2019 is recommended for development and currently requires the AntBlazor.Docs.ClientApp project to run for breakpoint debugging.

🗺 Roadmap

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

🤝 How to contribute

PRs Welcome

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

Community support

If you encounter any problems in the process, you can ask for help at Nailing Group, and we also encourage experienced users to help newcomers through the following channels

☀️ License agreement

AntBlazor