syncfusion-blazor-license

SKILL.md

Syncfusion Blazor License Configuration

Manage Syncfusion Blazor license keys across all project types — Server, WebAssembly, Auto, and Razor Class Libraries.

When to Use

Use this skill when you need to:

  • Generate a Syncfusion license key (paid, trial, or temporary)
  • Register a license key in any Blazor project type
  • Secure license keys in Blazor WebAssembly projects (avoid browser exposure)
  • Validate licenses in CI/CD pipelines (Azure Pipelines, GitHub Actions, Jenkins)
  • Troubleshoot license errors — trial banner, invalid key, platform or version mismatch

Do NOT use for:

  • Initial Blazor project setup → use syncfusion-blazor-common

Quick Reference

Topic Reference
Generate Key license-registration.md — Part 1
Register Key license-registration.md — Part 2
Razor Class Library license-registration.md — Part 3
WASM Security license-registration.md — Part 4
Troubleshooting license-registration.md — Part 5
FAQ license-registration.md — Part 6

Prerequisites

  • Syncfusion account (start a free trial if needed)
  • Syncfusion NuGet packages installed in the project
  • Access to Program.cs of the server and/or client project

Key rules: License keys are version-specific and platform-specific. Always generate a key for the Blazor platform that matches your installed NuGet package version.

NOTE: DON'T ask user to share their license key if they encounter errors. Instead, guide them to generate a new key and register it correctly. License keys are confidential and should never be shared publicly.

1. Generate a License Key

Detailed guide: license-registration.md — Part 1

Account Status Portal Key Type
Active paid License & Downloads Full, no expiry
Active trial Trial & Downloads 30-day trial
Expired License & Downloads Temporary 5-day
No account Register then Start Trial 30-day trial

2. Register the License Key

Detailed guide: license-registration.md — Part 2

Register before any Syncfusion component initializes in Program.cs:

Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR_LICENSE_KEY");

Registration by Project Type

Project Type Where to Register
Interactive Server Server Program.cs only
Interactive Auto Server and Client Program.cs
Interactive WASM Server and Client Program.cs
Standalone WASM Client Program.cs only
Razor Class Library Consuming app's Program.cs

3. WASM Security — Licensed NuGet Packages

Detailed guide: license-registration.md — Part 4

⚠️ Security Issue: Registering license keys in WASM Program.cs exposes them in browser-downloadable assemblies. Use licensed NuGet packages instead.

Recommended Solution

Use licensed NuGet packages (no key registration needed):

  1. Download from web installer
  2. Configure local/private NuGet source
  3. Verify DLL properties: No "LR" in file description = licensed

If trial assemblies persist:

dotnet nuget locals all --clear
# Delete bin/ and obj/, rebuild

Alternative: Azure Key Vault

Store keys in Azure Key Vault and retrieve at runtime

4. CI License Validation

Detailed guide: license-registration.md — Part 5

LicenseKeyValidator Tool

  1. Download LicenseKeyValidator.zip
  2. Edit LicenseKeyValidation.ps1:
    $result = & $PSScriptRoot"\LicenseKeyValidatorConsole.exe" /platform:"Blazor" /version:"26.2.4" /licensekey:"Your Key"
    Write-Host $result
    
  3. Integrate into Azure Pipelines, GitHub Actions, or other CI systems

Programmatic Validation

Syncfusion.Licensing.SyncfusionLicenseProvider.RegisterLicense("YOUR_KEY");
bool isValid = SyncfusionLicenseProvider.ValidateLicense(Platform.Blazor);

5. Troubleshooting License Errors

Detailed guide: license-registration.md — Part 6

Error Cause Fix
Trial banner Key not registered Register before component init
Invalid key Wrong version/platform Regenerate for Blazor + current NuGet version
Platform mismatch Non-Blazor key Generate Blazor-specific key
Version mismatch Key ≠ package version Clean bin/obj, clear NuGet cache, rebuild

Quick Checklist

  1. Syncfusion.Licensing version matches other packages
  2. ✓ Key registered before component initialization
  3. ✓ Key platform is Blazor
  4. ✓ Key version matches installed NuGet version
Weekly Installs
1
First Seen
1 day ago
Installed on
amp1
cline1
opencode1
cursor1
kimi-cli1
warp1