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