Skip to content

Commit 4b38c60

Browse files
committed
Refresh SPFx content
- fix typos - improve readability score - fix markdown issues - update images to meet MSDOCS req's
1 parent 6afce0b commit 4b38c60

28 files changed

+323
-225
lines changed

docs/general-development/client-side-web-parts-maintenance-mode.md

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,43 @@
11
---
22
title: Maintenance mode for client-side web parts
3-
ms.date: 12/18/2017
3+
ms.date: 10/21/2020
44
ms.prod: sharepoint
55
ms.assetid: 3ebd2a11-8291-4228-add0-9e0cd899dd3c
66
localization_priority: Normal
77
---
8-
98
# Maintenance mode for client-side web parts
109

11-
_**Applies to:** Office 365_
12-
1310
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.
1411

1512
## Switch to maintenance mode
1613

1714
> [!NOTE]
1815
> In order to load a page in the maintenance mode, you have to have edit permissions for that specific page.
1916
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:
2118

2219
```text
2320
https://contoso.sharepoint.com/sites/team?maintenancemode=true
2421
```
2522

26-
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.
2724

2825
## Available information
2926

3027
The maintenance mode shows various information about each web part on the page.
3128

3229
### Web part summary
3330

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:
3532

3633
![Web part summary information displayed in maintenance mode](../images/maintenance-mode-summary.png)
3734

3835
Property|Description
3936
--------|-----------
4037
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.
4441
Version|The version number of the web part.
4542
Environment|Enumeration indicating the environment on which the web part is running. Possible values: `1` - Local Workbench, `2` - SharePoint
4643
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.
5451
By exploring the manifest information, you can learn details such as:
5552

5653
- 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
5855
- what version of the SharePoint Framework has the web part been built on
5956
- which components of the SharePoint Framework does the web part use
6057

@@ -66,18 +63,18 @@ Another piece of information available in the maintenance mode, is web part data
6663

6764
![Web part data information displayed in maintenance mode](../images/maintenance-mode-data.png)
6865

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.
7067

7168
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.
7269

7370
## Considerations
7471

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.
8178

8279
## See also
8380

54.5 KB
Loading
63.4 KB
Loading
Loading
-31 KB
Loading
-51.8 KB
Loading
-42.6 KB
Loading
Loading
-643 Bytes
Loading
-650 Bytes
Loading

0 commit comments

Comments
 (0)