You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/general-development/client-side-web-parts-maintenance-mode.md
+15-18Lines changed: 15 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -1,46 +1,43 @@
1
1
---
2
2
title: Maintenance mode for client-side web parts
3
-
ms.date: 12/18/2017
3
+
ms.date: 10/21/2020
4
4
ms.prod: sharepoint
5
5
ms.assetid: 3ebd2a11-8291-4228-add0-9e0cd899dd3c
6
6
localization_priority: Normal
7
7
---
8
-
9
8
# Maintenance mode for client-side web parts
10
9
11
-
_**Applies to:** Office 365_
12
-
13
10
When working with client-side web parts, you can load them in maintenance mode. The maintenance mode can be helpful when trying to debug issues related to web parts placed on the page.
14
11
15
12
## Switch to maintenance mode
16
13
17
14
> [!NOTE]
18
15
> In order to load a page in the maintenance mode, you have to have edit permissions for that specific page.
19
16
20
-
To switch to the maintenance mode, navigate to the page and in the URL append `?maintenancemode=true`, for example:
17
+
To switch to the maintenance mode, navigate to the page and in the URL append **?maintenancemode=true**, for example:
To leave the maintenance mode, remove `?maintenancemode=true` from the URL and reload the page.
23
+
To leave the maintenance mode, remove **?maintenancemode=true** from the URL and reload the page.
27
24
28
25
## Available information
29
26
30
27
The maintenance mode shows various information about each web part on the page.
31
28
32
29
### Web part summary
33
30
34
-
When in maintenance mode, for each web part you will see the following summary information:
31
+
When in maintenance mode, for each web part you'll see the following summary information:
35
32
36
33

37
34
38
35
Property|Description
39
36
--------|-----------
40
37
Alias|Web part alias
41
-
Id|The unique ID of the web part
42
-
InstanceId|The ID of a specific instance of a web part (that is, if you have two more of the same web parts on a page, they will each have the same web part ID, but a different instance ID.
43
-
IsInternal|Indicates whether the web part was made by Microsoft or a third party. If `true`, it is made by Microsoft. If `false`, it is made by a third party.
38
+
ID|The unique ID of the web part
39
+
InstanceId|The ID of a specific instance of a web part (that is, if you have two more of the same web parts on a page, they'll each have the same web part ID, but a different instance ID.
40
+
IsInternal|Indicates whether the web part was made by Microsoft or a third party. If `true`, it's made by Microsoft. If `false`, it's made by a third party.
44
41
Version|The version number of the web part.
45
42
Environment|Enumeration indicating the environment on which the web part is running. Possible values: `1` - Local Workbench, `2` - SharePoint
46
43
UserAgent|A string that contains information about the device and software in use (such as browser type and version).
@@ -54,7 +51,7 @@ To get more information about the web part, switch to the **Manifest** tab.
54
51
By exploring the manifest information, you can learn details such as:
55
52
56
53
- where the web part bundle is hosted
57
-
- which external scripts is the web part loading and from where
54
+
- which external scripts are the web part loading and from where
58
55
- what version of the SharePoint Framework has the web part been built on
59
56
- which components of the SharePoint Framework does the web part use
60
57
@@ -66,18 +63,18 @@ Another piece of information available in the maintenance mode, is web part data
66
63
67
64

68
65
69
-
Using the information from the **Data** tab, you can see the configuration for each web part. This is helpful when trying to reproduce errors reported by users which could be caused by a specific web part configuration.
66
+
Using the information from the **Data** tab, you can see the configuration for each web part. This is helpful when trying to reproduce errors reported by users that could be caused by a specific web part configuration.
70
67
71
68
If the web part [integrates its properties with SharePoint](../spfx/web-parts/guidance/integrate-web-part-properties-with-sharepoint.md), the data section shows the types and values that are passed to SharePoint for further processing.
72
69
73
70
## Considerations
74
71
75
-
-the maintenance mode works for client-side web parts placed on both modern and classic SharePoint pages. See the [Open and use the web part maintenance page](https://support.office.com/article/Open-and-use-the-web-part-maintenance-page-eff9ce22-d04a-44dd-ae83-ac29a5e396c2#PickTab=2016,_2013) support article, to get more information about opening classic web parts in maintenance view
76
-
-to open page in maintenance mode, you have to have edit permissions for that page
77
-
-when in maintenance mode, web part code is not being executed and you cannot edit web part properties
78
-
-in maintenance mode, you can delete or move web parts on the page
79
-
-the maintenance mode shows only information about web parts. You cannot use it to show information about SharePoint Framework extensions that are executed on the page
80
-
-switching to maintenance mode only disables executing web part code. Any SharePoint Framework extensions registered on the page will still execute
72
+
-The maintenance mode works for client-side web parts placed on both modern and classic SharePoint pages. See the [Open and use the web part maintenance page](https://support.office.com/article/Open-and-use-the-web-part-maintenance-page-eff9ce22-d04a-44dd-ae83-ac29a5e396c2#PickTab=2016,_2013) support article, to get more information about opening classic web parts in maintenance view.
73
+
-To open page in maintenance mode, you have to have edit permissions for that page
74
+
-When in maintenance mode, web part code isn't being executed and you can't edit web part properties.
75
+
-In maintenance mode, you can delete or move web parts on the page.
76
+
-The maintenance mode shows only information about web parts. You can't use it to show information about SharePoint Framework extensions that are executed on the page.
77
+
-Switching to maintenance mode only disables executing web part code. Any SharePoint Framework extensions registered on the page will still execute.
0 commit comments