ant-design-blazor/docs/getting-started.en-US.md

order	title
1	Getting Started

Ant Design of Blazor is dedicated to providing a good development experience for programmers.

Before delving into Ant Design Blazor, a good knowledge of Blazor and .NET Core is needed.

First Local Development

During development, you may need to compile and debug .NET code, and even proxy some of the requests to mock data or other external services. All of these can be done with quick feedback provided through hot reloading of changes.

Such features, together with packaging the production version, are covered in this work flow.

Installation

We strongly recommend to develop Blazor with the .NET Core SDK. You can install it from https://dotnet.microsoft.com/download?WT.mc_id=DT-MVP-5003987.

Create a New Blazor WebAssembly Project

A new project can be created using .NET Core SDK.

$ dotnet new blazorwasm -o PROJECT-NAME

dotnet cli will run dotnet restore after a project is created. If it fails, you can run dotnet restore by yourself.

Development & Debugging

Run your project now.

$ dotnet run

Building & Deployment

$ dotnet publish -c release -o dist

Entry files will be built and generated in dist/wwwroot directory, where we can deploy it to different environments.

Install Ant Design Blazor

$ dotnet add package AntDesign

Register Dependencies

Add dependency registration in Startup.cs.

public void ConfigureServices(IServiceCollection services)
{
  ...
  services.AddAntDesign();
}

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

Specify the style/script auto-import location

After version 0.17.0, AntDesign Blazor component library utilizes JavaScript Initializers support automatic introduction of styles and scripts. CSS is introduced before the original <link> element of the page by default, and JS is introduced before all <script> elements by default. If you need to specify the location, simply add <link antblazor-css> or <script antblazor-js></script> to the specified location in index.html`` or App.razor`, and it will be automatically introduced before these two elements.

  ...
  <link href="_content/AntDesign/css/ant-design-blazor.css" rel="stylesheet"> <!-- introduced here automatically -->
  <link antblazor-css />

  ...

  <script src="_content/AntDesign/js/ant-design-blazor.js"></script> <!-- introduced here automatically -->
  <script antblazor-js></script>
  ...

Disable auto-import

If you do not want to import JS or styles automatically, you can choose to disable the import and import them manually.

Using [no-antblazor-js] attribute in any html element to disable automatic import of JS ，and using [no-antblazor-css] for CSS。

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