Skip to main content

SharePoint Framework SPFx Node Version Compatibility

How to check the compatibility between the SPFx version and the Node.js version

The SharePoint Framework (SPFx) is a client-side development platform used to develop web parts and extensions for SharePoint. The SharePoint Framework (SPFx) is compatible with the Node.js versions. Existing SPFx solutions may have different SPFx versions as compared to the current solutions. To make the SPFx solution run, Node.js is required, and in this blog, I am sharing steps to check the compatible node module for SPFx. 

Find the SPFx version from the solution: 

  • Open the project solution and navigate to the "package.json" file.
  • In package.json file you will find "@microsoft/sp-core-library" key and value of this particular key is the version of the SPFx.

      Ex:  "@microsoft/sp-core-library": "1.14.0"

Another way to find the SPFx version is by command, open the command prompt and run the command mentioned below:

npm ls -g --depth=0 @microsoft/generator-sharepoint

Once you run this command, you will get the SPFx version in the response.
Now we have the SPFx version and using the SPFx version, we can quickly find the supported Node.js version. Microsoft provides us the list of compatible version of Node.js with the SPFx version. See the version compatibility matrix below:
SPFxNode.js (LTS)NPMTypeScriptReact
1.17.3v16.13+v5, v6, v7, v8v4.5v17.0.1
1.17.2v16.13+v5, v6, v7, v8v4.5v17.0.1
1.17.1v16.13+v5, v6, v7, v8v4.5v17.0.1
1.17.0v16.13+v5, v6, v7, v8v4.5v17.0.1
1.16.1v16.13+v5, v6, v7, v8v4.5v17.0.1
1.16.0v16.13+v5, v6, v7, v8v4.5v17.0.1
1.15.2v12, v14, v16v5, v6, v7, v8v4.5v16.13.1
1.15.0v12, v14, v16v5, v6, v7, v8v4.5v16.13.1
1.14.0v12, v14v5, v6v3.9v16.13.1
1.13.1v12, v14v5, v6v3.9v16.13.1
1.13.0v12, v14v5, v6v3.9v16.13.1
1.12.1v10, v12, v14v5, v6v3.7v16.9.0
1.12.0v12, v10v5, v6v3.7v16.9.0
1.11.0v10v5, v6v3.3v16.8.5
1.10.0v8, v10v5, v6v3.3v16.8.5
1.9.1v8, v10v5, v6v2.9v16.8.5
1.8.2v8, v10v5, v6v2.9v16.7.0
1.8.1v8v5, v6v2.7, v2.9, v3v16.7.0
1.8.0v8v5, v6v2.7, v2.9, v3v16.7.0
1.7.1v8v5, v6v2.4v16.3.2
1.7.0v8v5, v6v2.4v16.3.2
1.6.0v6, v8v3 (w/ Node.js 6),
v5 (w/ Node.js 8)
1.5.1v6, v8v3 (w/ Node.js 6),
v5 (w/ Node.js 8)
1.5.0v6, v8v3 (w/ Node.js 6),
v5 (w/ Node.js 8)
1.4.1v6, v8v3, v4v2.4v15
1.4.0v6v3, v4v2.4v15
1.3.0v6v3, v4v2.4v15
1.1.0v6v3, v4v2.4v15

Now using this information you can download compatible Node.js version and your solution will work.

Reference : SPFx compatibility

If you want to setup multiple node version with windows Setup multiple node versions on w

Sharing is caring.
Happy Coding.


Popular posts from this blog

SPFx Interview Questions With Answers

In this article, we are going to discuss interview questions related to the SPFx (SharePoint Framework Development ). It will help you to prepare for the interview and in getting clarity on the core concepts of SPFx development. What is SPFx? SPFx, short for SharePoint Framework,  SPFx  allows us for client-side SharePoint development, we can easily connect with SharePoint data and it also supports for open source tools. What is the major difference between SPFx web part and the SharePoint app? Both the development model supports client-side development but the major difference between these two is that the SharePoint app(add-in) runs on the iframe. What you can build with SPFx? Using SPFx framework we can customize the SharePoint pages. We can build things mentioned below using the SharePoint Framework(SPFx). Web parts, Extensions, Adaptive Card, Library Component How many types of extensions we can create using SPFx? SPFx has three extension types: Application Customizers: Using the

How to register an app in SharePoint

In this article, we are going to learn how to register an app/add-in in SharePoint online. If you have created a Sharepoint provider-hosted add-in or other SharePoint solution and to access the SharePoint site or list using the app/add-in you need to register the add-in on SharePoint and to grant permission. Register app in SharePoint 1. Login into SharePoint and Navigate to register an app page. Use the URL mentioned below:          [Sitecollection URL]/_layouts/15/appregnew.aspx 2.  Once you navigate to the Register app page, a form will open. You need to fill all the fields on the form. Client Id and Client Secret  generated when we click on the generate button available next to the fields.  Title : Name of the add-in which you want to give. App Domain : Where your domain is hosted, for the local environment you can place             "". Do not include HTTP or HTTPS in App Domain. Redirect URL :  Insert the redirect URL, for t

Permission XML for SharePoint Add-in

In this article, we will be discussing the permission XMLs, which are used to provide permission to SharePoint add-in. Permission XML for the SharePoint app. You can set the App only permission, by setting "true" or "false" in  AllowAppOnlyPolicy=“true” in these permission XMLs.   If add-in granted permission to tenant scope, It includes all children in scope. Before granting access to the app, need to register an app. Follow this link for step by step guide to  How to register an app/add-in in SharePoint   Providing access to add-in at tenant level: To provide access at tenant level user must have the tenant admin level permission. To grant this permission tenant admin can use this URL Search the App Id (Client ID) and it will fetch all the information which you provide at time of registration of app.   Assign full control at tenant level : <AppPermissionRequests AllowAppOnlyPolicy="true&quo