Agent Skills

syncfusion-react-license

Use this skill when the user asks about Syncfusion React licensing, license keys, license registration, license validation errors, trial licenses, or license troubleshooting. This skill provides comprehensive guidance on generating, registering, and managing Syncfusion license keys for React applications, including edition-based and platform-based licensing models, registration methods, CI/CD integration, and resolving common licensing errors.

Install

npx skills add https://github.com/syncfusion/react-ui-components-skills --skill syncfusion-react-license
SKILL.md

Syncfusion React Licensing

This skill guides you through Syncfusion React licensing requirements, license key generation, registration methods, and troubleshooting validation errors.

Table of Contents

Licensing Overview

Syncfusion license key validation was introduced in the 2022 Volume 1 release (v20.1.0.47) for Essential JS2 platforms. All React applications referencing Syncfusion packages from npm, CDN, or build must register a valid license key to avoid validation warnings.

Key Licensing Details

License Key vs Unlock Key:

  • License Key: String registered in application code to validate Syncfusion package usage
  • Unlock Key: Used only during Syncfusion installer process
  • ⚠️ Important: License key is NOT the same as installer unlock key

Core Requirements:

  • License key validation introduced in v20.1.0.47+ (2022 Volume 1)
  • License keys are version and platform/edition specific
  • Validation occurs offline (no internet required during runtime)
  • Required when using npm packages or trial installers
  • Not required when using licensed installers

License Types:

  • Trial license: 30-day evaluation period, full functionality, generates trial key, displays warning after expiration
  • Community license: Free for qualifying individuals/organizations (<$1M USD revenue), same functionality as paid license, annual renewal required
  • Paid license: Commercial license for enterprise use, perpetual or subscription-based, technical support included

Edition-Based vs Platform-Based:

  • v31.1.17+ (Edition-based): UI Edition, Document SDK, PDF Viewer SDK, DOCX Editor SDK, Spreadsheet Editor SDK, Enterprise Edition (all editions combined)
  • v30.x.x and earlier (Platform-based): React, Angular, Vue, JavaScript, Blazor, etc.

Build Server Scenarios:

  • Using npm packages: License key required - register NPX command
  • Using trial installer: License key required - trial warnings appear after 30 days
  • Using licensed installer: License key NOT required - embedded license validation included

Offline Validation:

  • No internet connection required during application runtime
  • License validated locally against package metadata at startup
  • Works in air-gapped environments and offline development
  • No external API calls or performance impact

Documentation and Navigation Guide

Generating License Keys

📄 Read: references/license-generation.md

  • Edition-based licensing (v31.1.17+): UI Edition, Document SDK, PDF Viewer SDK, DOCX Editor SDK, Spreadsheet Editor SDK, Enterprise Edition
  • Platform-based licensing (v30.x.x and earlier): React, JavaScript, Angular, etc.
  • Generating keys from License & Downloads page
  • Claim License Key page usage
  • Version and platform specific license key

Registering License Keys

📄 Read: references/license-registration.md

  • Environment variable method: SYNCFUSION_LICENSE
  • CI/CD integration: GitHub Actions, Azure Pipelines
  • Active license, active trial, expired license scenarios

Troubleshooting License Errors

📄 Read: references/licensing-errors.md

  • License key not registered error
  • Invalid key error
  • Trial expired error (30 days)
  • Platform mismatch error
  • Version mismatch error
  • NPX command validation errors

Quick Start

1. Generate License Key

Visit License & Downloads page:

For v31.1.17+ (Edition-based):

  • Select version 31.x.x or higher
  • Select required editions: UI Edition, Document SDK, PDF Viewer SDK, DOCX Editor SDK, Spreadsheet Editor SDK
  • Recommended: Select all 5 editions for Enterprise Edition key
  • Click "Get License Key"

For v30.x.x and earlier (Platform-based):

  • Select version 30.x.x or earlier
  • Select platforms: React, JavaScript, etc.
  • Click "Get License Key"

2. Register License Key in Application

Recommended Method: Use environment variables to register your license key. This prevents accidentally committing license keys to source control.

Step 1: Set the environment variable:

# Windows
setx SYNCFUSION_LICENSE "Your_License_Key_Here"

# Mac/Linux
export SYNCFUSION_LICENSE='Your_License_Key_Here'

Step 2: Activate the license using NPX command:

npx syncfusion-license activate

Step 3: Clear the cache:

# Windows PowerShell
Remove-Item -Recurse -Force node_modules\.cache

# macOS/Linux
rm -rf node_modules/.cache

Note: For alternative license registration methods, kindly refer to the Syncfusion license key registration documentation.

Related skills

azure-diagnosticsmicrosoft608KDebug Azure production issues on Azure using AppLens, Azure Monitor, resource health, and safe triage. WHEN: debug production issues, troubleshoot app service, app service high CPU, app service deployment failure, troubleshoot container apps, troubleshoot functions, troubleshoot AKS, VM RDP, Linux SSH, VM black screen, can't connect to VM, reset VM password, NSG or firewall blocking, kubectl cannot connect, kube-system/CoreDNS failures, pod pending, crashloop, node not ready, upgrade failures, aazure-preparemicrosoft608KPrepare azd-based Azure projects for deployment: generates azure.yaml, infrastructure (Bicep/Terraform), and Dockerfiles for the Azure Developer CLI (azd) workflow. USE ONLY when the user explicitly wants to use azd as the deployment tool, or the project already has an azure.yaml file. DO NOT USE FOR: non-azd deployments, Python App Service code-only deploys (use python-appservice-deploy), or cross-cloud migration (use azure-cloud-migrate). WHEN: prepare app for azd, create azure.yaml, set up azazure-aimicrosoft608KUse for Azure AI: Search, Speech, OpenAI, Document Intelligence. Helps with search, vector/hybrid search, speech-to-text, text-to-speech, transcription, OCR. WHEN: AI Search, query search, vector search, hybrid search, semantic search, speech-to-text, text-to-speech, transcribe, OCR, convert text to speech.azure-deploymicrosoft607KExecute Azure deployments for ALREADY-PREPARED applications that have existing .azure/deployment-plan.md and infrastructure files. DO NOT use this skill when the user asks to CREATE a new application — use azure-prepare instead. This skill runs azd up, azd deploy, terraform apply, and az deployment commands with built-in error recovery. Requires .azure/deployment-plan.md from azure-prepare and validated status from azure-validate. WHEN: \"run azd up\", \"run azd deploy\", \"execute deployment\",

Search skills and MCP servers

Fuzzy search across 23,137 skills and servers