Skip to main content

Detecting SharePoint environment from an SPFX.

Detecting SharePoint environment from an SPFX.

SPFX web parts can be added to modern and classic SharePoint pages and we might need to load different resources depending of the environment type.
The environment type can be detected using the EnvironmentType enumeration, directly from your SPFX code.
Member Description
ClasicSharePoint Indicates that the framework was loaded from a classic SharePoint page
Local Indicates that the framework was loaded from the workbench
SharePoint Indicates that the framework was loaded by a client-rendered SharePoint page
Test Represents the scenario of the framework hosted in a unit/integration test
To detect the environment type start by importing the enumeration from the sp-core-library:
import { Environment, EnvironmentType} from '@microsoft/sp-core-library';
Use the code below to target a specific environment.
if(Environment.type == EnvironmentType.ClassicSharePoint){ //Classic SharePoint page }else if(Environment.type === EnvironmentType.Local){ //Workbenck page }else if(Environment.type === EnvironmentType.SharePoint){ //Modern SharePoint page }else if(Environment.type === EnvironmentType.Test){ //Running on Unit test enveironment }
Labels:

Comments

  1. Nanfor IbéricaSeptember 27, 2020 at 8:35 AM

    Thank you very much for sharing such a useful article. Will definitely saved and revisit your site best MS-101T01: Microsoft 365 Security Management

    ReplyDelete

Post a Comment

Popular posts from this blog

How to get SPUser or SPGroup from Person or Group field

You have person or group field in SharePoint list and you want to programmatically get the user or person. The below code to gets SPUser from User or Group field in the list when multiple choice and Groups are not allowed in the field: //get SPUser SPFieldUser userField = (SPFieldUser)item.Fields.GetField("Users"); SPFieldUserValue userFieldValue = (SPFieldUserValue)userField.GetFieldValue(item["Users"].ToString()); SPUser user = userFieldValue.User; This part of code would help you to get SPUser when multiple choice is allowed and groups are not allowed: //Multiple choices are allowed SPFieldUser userField = (SPFieldUser)item.Fields.GetField("Users"); SPFieldUserValueCollection userFieldValueCollection = (SPFieldUserValueCollection)userField.GetFieldValue(item["Users"].ToString()); foreach (SPFieldUserValue userFieldValue in userFieldValueCollection) {     Console.WriteLine("     " + userFieldValue.User.LoginName); } And when group...
1 comment
Read more

SharePoint publishing page scheduling

In SharePoint 2010 publishing enabled team site collection is not showing schedule button in publish ribbon. Solution: Here is how to enable it  though the UI: Locate the SharePoint Server Web site on which you want to enable content approval and item scheduling. Click  Site Actions , click  Site Settings , and then click  Modify Pages Library Settings . Under  General Settings , click  Versioning Settings . Click  Yes  next to  Content Approval , and then click  OK . Click  Manage item scheduling .   Click to enable the  Enable scheduling of items in this list  check box, and then click  OK .
2 comments
Read more

Changing Content Type Hub URL

Change the Hub URL through powershell by using: Set-SPMetadataServiceApplication -Identity " " -HubURI " " For Ex: Set-SPMetadataServiceApplication -Identity "Managed Metadata Service" -HubURI "http://contenttype.Domain.Com" When you try to do this you get this rather scary message: This is SharePoint telling you that this is a major thing so be careful! Essentially all your content types that you have published out will be removed if they can, and you have to republish all of your content types out again which can cause some issue.
1 comment
Read more