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.
1---2name: syncfusion-react-license3description: 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.4---5
6# Syncfusion React Licensing
7
8This skill guides you through Syncfusion React licensing requirements, license key generation, registration methods, and troubleshooting validation errors.
9
10## Table of Contents
11
12- [Licensing Overview](#licensing-overview)
13- [Documentation and Navigation Guide](#documentation-and-navigation-guide)
14- [Quick Start](#quick-start)
15- [Common Registration Methods](#common-registration-methods)
16
17## Licensing Overview
18
19Syncfusion 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.
20
21### Key Licensing Details
22
23**License Key vs Unlock Key:**
24- **License Key:** String registered in application code to validate Syncfusion package usage
25- **Unlock Key:** Used only during Syncfusion installer process
26- **⚠️ Important:** License key is NOT the same as installer unlock key
27
28**Core Requirements:**
29- License key validation introduced in v20.1.0.47+ (2022 Volume 1)
30- License keys are **version and platform/edition specific**
31- Validation occurs **offline** (no internet required during runtime)
32- Required when using npm packages or trial installers
33- Not required when using licensed installers
34
35**License Types:**
36- **Trial license:** 30-day evaluation period, full functionality, generates trial key, displays warning after expiration
37- **Community license:** Free for qualifying individuals/organizations (<$1M USD revenue), same functionality as paid license, annual renewal required
38- **Paid license:** Commercial license for enterprise use, perpetual or subscription-based, technical support included
39
40**Edition-Based vs Platform-Based:**
41- **v31.1.17+ (Edition-based):** UI Edition, Document SDK, PDF Viewer SDK, DOCX Editor SDK, Spreadsheet Editor SDK, Enterprise Edition (all editions combined)
42- **v30.x.x and earlier (Platform-based):** React, Angular, Vue, JavaScript, Blazor, etc.
43
44**Build Server Scenarios:**
45- **Using npm packages:** License key required - register NPX command
46- **Using trial installer:** License key required - trial warnings appear after 30 days
47- **Using licensed installer:** License key NOT required - embedded license validation included
48
49**Offline Validation:**
50- No internet connection required during application runtime
51- License validated locally against package metadata at startup
52- Works in air-gapped environments and offline development
53- No external API calls or performance impact
54
55## Documentation and Navigation Guide
56
57### Generating License Keys
58📄 **Read:** [references/license-generation.md](references/license-generation.md)
59- **Edition-based licensing (v31.1.17+):** UI Edition, Document SDK, PDF Viewer SDK, DOCX Editor SDK, Spreadsheet Editor SDK, Enterprise Edition
60- **Platform-based licensing (v30.x.x and earlier):** React, JavaScript, Angular, etc.
61- Generating keys from License & Downloads page
62- Claim License Key page usage
63- Version and platform specific license key
64
65### Registering License Keys
66📄 **Read:** [references/license-registration.md](references/license-registration.md)
67- Environment variable method: `SYNCFUSION_LICENSE`
68- CI/CD integration: GitHub Actions, Azure Pipelines
69- Active license, active trial, expired license scenarios
70
71### Troubleshooting License Errors
72📄 **Read:** [references/licensing-errors.md](references/licensing-errors.md)
73- License key not registered error
74- Invalid key error
75- Trial expired error (30 days)
76- Platform mismatch error
77- Version mismatch error
78- NPX command validation errors
79
80## Quick Start
81
82### 1. Generate License Key
83
84Visit [License & Downloads](https://www.syncfusion.com/account/downloads) page:
85
86**For v31.1.17+ (Edition-based):**
87- Select version 31.x.x or higher
88- Select required editions: UI Edition, Document SDK, PDF Viewer SDK, DOCX Editor SDK, Spreadsheet Editor SDK
89- **Recommended:** Select all 5 editions for Enterprise Edition key
90- Click "Get License Key"
91
92**For v30.x.x and earlier (Platform-based):**
93- Select version 30.x.x or earlier
94- Select platforms: React, JavaScript, etc.
95- Click "Get License Key"
96
97### 2. Register License Key in Application
98
99**Recommended Method:** Use environment variables to register your license key. This prevents accidentally committing license keys to source control.
100
101**Step 1:** Set the environment variable:
102
103```bash
104# Windows
105setx SYNCFUSION_LICENSE "Your_License_Key_Here"
106
107# Mac/Linux
108export SYNCFUSION_LICENSE='Your_License_Key_Here'
109```
110
111**Step 2:** Activate the license using NPX command:
112
113```bash
114npx syncfusion-license activate
115```
116
117**Step 3:** Clear the cache:
118
119```bash
120# Windows PowerShell
121Remove-Item -Recurse -Force node_modules\.cache
122
123# macOS/Linux
124rm -rf node_modules/.cache
125```
126
127> **Note:** For alternative license registration methods, kindly refer to the [Syncfusion license key registration documentation](https://ej2.syncfusion.com/react/documentation/licensing/license-key-registration).
128
syncfusion