Blazorise Documentation

The Blazorise.AntDesign provider is designed to provide the visual language and behavior of Ant Design v6 within the Blazorise component framework. It is not a literal port of Ant Design React, but rather a mapping that aims to reproduce rendered behavior and appearance.

It operates across three layers:

1. Blazorise component API: The standard Blazorise interface you interact with.
2. AntDesign provider mapping: The logic that maps Blazorise components to AntD structures.
3. Ant Design v6 visual language: The CSS and tokens that provide the look and feel.

Note that some components may use native browser controls under an AntD shell or require provider-specific Razor components to bridge the gap between Blazorise markup and AntD requirements.

Blazorise uses Fody for weaving logic, split into two components:

• Blazorise.Weavers (bw): A wrapper project that exists to create the necessary NuGet package (including Fody.Packaging) required for Fody to function. It is not intended to be used directly but acts as the packaging mechanism.
• Blazorise.Weavers.Fody (bwf): The core implementation containing the actual weaving logic. This project is not referenced directly by other projects to avoid Ambiguous package name errors, as the resulting NuGet package shares the same name as the project.

To debug the source generator, use a custom launch profile in your launchSettings.json with the DebugRoslynComponent command name.

{
  "$schema": "http://json.schemastore.org/launchsettings.json",
  "profiles": {
    "Generators": {
      "commandName": "DebugRoslynComponent",
      "targetProject": "../../Blazorise/Blazorise.csproj"
    }
  }
}

Use the following command to watch for changes in the Tailwind configuration or source files and automatically rebuild the CSS output during local development.

npm run watch:css

To generate the Lucide icon list and inline SVG table from the Lucide icons GitHub repository, you can use the GetIcons.csx script via dotnet-script.

First, install the dotnet-script tool globally:

dotnet tool install -g dotnet-script

Then, execute the script:

dotnet script GetIcons.csx

To update the icon set, follow these steps:

1. Run the GetIcons.csx script using one of the build methods.
2. Verify changes in LucideIcons.cs and LucideIconSvg.cs.
3. Check the generated file headers to ensure compatibility if upstream package metadata has changed.

To ensure the Chart.js Luxon adapter can access DateTime when luxon.js is loaded as a module, you must expose luxon on globalThis. Add the following code snippet to the bottom of your luxon.js file:

"undefined"!=typeof globalThis&&globalThis&&(globalThis.luxon=globalThis.luxon||luxon);

To build and publish the Blazorise NuGet packages, execute the following batch files in sequence from the repository root:

1. Run dotnet-pack.bat to pack the packages.
2. Run push.bat to publish the packed NuGet packages.

By default, source-generated files are held in memory. To write the generated files to a specific directory on your disk for inspection or use, configure the EmitCompilerGeneratedFiles and CompilerGeneratedFilesOutputPath properties in your .csproj file.

<PropertyGroup>
	<EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles>
	<CompilerGeneratedFilesOutputPath>__SOURCEGENERATED__</CompilerGeneratedFilesOutputPath>
</PropertyGroup>

To use the dotnet script command to run the icon generation script, you must first install the dotnet-script tool globally.

dotnet tool install -g dotnet-script