Skip to content

Commit fcf9ecb

Browse files
committed
Docs update: web part mapping details
1 parent 1fda6c5 commit fcf9ecb

File tree

2 files changed

+80
-0
lines changed

2 files changed

+80
-0
lines changed

docs/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1373,6 +1373,8 @@
13731373
href: transform/modernize-userinterface-site-pages-dotnet.md
13741374
- name: Page transformation configuration options
13751375
href: transform/modernize-userinterface-site-pages-configuration.md
1376+
- name: Classic web part to modern mapping
1377+
href: transform/modernize-userinterface-site-pages-webparts.md
13761378
- name: Page transformation security
13771379
href: transform/modernize-userinterface-site-pages-security.md
13781380
- name: Page transformation model
Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
title: Overview of the used web part mapping
3+
description: Explains which web parts are transformed and how
4+
ms.date: 02/19/2019
5+
ms.prod: sharepoint
6+
localization_priority: Priority
7+
---
8+
9+
# Overview of the used web part mapping
10+
11+
> [!IMPORTANT]
12+
> The SharePoint PnP Modernization framework is continuously evolving, checkout [the release notes](https://github.com/SharePoint/sp-dev-modernization/tree/master/Tools/SharePoint.Modernization/Modernization%20Framework%20release%20notes.md) to stay up to date on the latest changes. If you encounter problems please file an issue in the [sp-dev-modernization GitHub issue list](https://github.com/SharePoint/sp-dev-modernization/issues).
13+
14+
When a page is transformed from a classic page into a modern client side page then the most commonly used web parts are transformed as well. Classic web parts (e.g. XSLTListView) are replaced by their OOB modern counterparts (e.g. List web part) assuming there is a modern counterpart available. The next chapter provides an overview of which classic web parts are transformed and how.
15+
16+
## Web part transformation list (updated for Feb 2018 release)
17+
18+
Classic web part | Modern web part | Comments
19+
-----------------|-----------------|--------------------------------------
20+
Microsoft.SharePoint.WebPartPages.XsltListViewWebPart (viewing list data) | [List](https://support.office.com/en-us/article/use-the-list-and-other-web-parts-on-classic-pages-03044488-c0e4-4226-a8fb-4cd8364424fa), [Library](https://support.office.com/en-us/article/use-the-document-library-web-part-a9dfecc3-2050-4528-9f00-2c5afc5731b0) or [Events](https://support.office.com/en-us/article/use-the-events-web-part-5fe4da93-5fa9-4695-b1ee-b0ae4c981909) web part | See next chapter for more details
21+
Microsoft.SharePoint.WebPartPages.ListViewWebPart (legacy viewing of list data) | [List](https://support.office.com/en-us/article/use-the-list-and-other-web-parts-on-classic-pages-03044488-c0e4-4226-a8fb-4cd8364424fa), [Library](https://support.office.com/en-us/article/use-the-document-library-web-part-a9dfecc3-2050-4528-9f00-2c5afc5731b0) or [Events](https://support.office.com/en-us/article/use-the-events-web-part-5fe4da93-5fa9-4695-b1ee-b0ae4c981909) web part | See next chapter for more details
22+
Microsoft.SharePoint.Portal.WebControls.SiteFeedWebPart (Site feed on team sites) | [News](https://support.office.com/en-us/article/use-the-news-web-part-on-a-sharepoint-page-c2dcee50-f5d7-434b-8cb9-a7feefd9f165) web part | This web part typically is used to show news on a home page, hence it's replaced with the OOB news web part
23+
Microsoft.SharePoint.WebPartPages.ContentEditorWebPart (embedding content) | [Embed](https://support.office.com/en-us/article/add-content-to-your-page-using-the-embed-web-part-721f3b2f-437f-45ef-ac4e-df29dba74de8) web part, [3rd party script editor](https://github.com/SharePoint/sp-dev-modernization/blob/master/Solutions/PageTransformationUI/docs/modernization-ui-faq.md#my-script-editor-and-content-editor-web-parts-are-not-transformed) as optional target web part | See next chapter for more details
24+
Microsoft.SharePoint.WebPartPages.ScriptEditorWebPart (embedding script) | Not transformed OOB, [3rd party script editor](https://github.com/SharePoint/sp-dev-modernization/blob/master/Solutions/PageTransformationUI/docs/modernization-ui-faq.md#my-script-editor-and-content-editor-web-parts-are-not-transformed) as optional target web part | See next chapter for more details
25+
Microsoft.SharePoint.WebPartPages.ImageWebPart | [Image](https://support.office.com/en-us/article/use-the-image-web-part-a63b335b-ad0a-4954-a65d-33c6af68beb2) web part |
26+
Microsoft.SharePoint.WebPartPages.ClientSideWebPart (= modern SPFX based web part on classic page) | The same modern web part with it's configuration will be kept |
27+
Microsoft.SharePoint.WebPartPages.ClientWebPart (= SharePoint Add-In web part on classic page) | The same add-in can work on modern pages and will be taken over including it's configuration |
28+
Microsoft.SharePoint.Publishing.WebControls.MediaWebPart (embedding videos) | [File viewer](https://support.office.com/en-us/article/use-the-file-viewer-web-part-e53a9602-e7b3-4fff-9126-de2f18d1900c#bkmk_document) web part |
29+
Microsoft.SharePoint.Publishing.WebControls.ContentByQueryWebPart (querying data and presenting it) | [Highlighted content](https://support.office.com/en-us/article/use-the-highlighted-content-web-part-e34199b0-ff1a-47fb-8f4d-dbcaed329efd) web part |
30+
Microsoft.Office.Excel.WebUI.ExcelWebRenderer (embedding from Excel files) | [File viewer](https://support.office.com/en-us/article/use-the-file-viewer-web-part-e53a9602-e7b3-4fff-9126-de2f18d1900c#bkmk_document) web part |
31+
Microsoft.Office.Visio.Server.WebControls.VisioWebAccess (embedding from Visio files) | [File viewer](https://support.office.com/en-us/article/use-the-file-viewer-web-part-e53a9602-e7b3-4fff-9126-de2f18d1900c#bkmk_document) web part |
32+
Microsoft.SharePoint.WebPartPages.PageViewerWebPart (embedding from other pages) | [Embed](https://support.office.com/en-us/article/add-content-to-your-page-using-the-embed-web-part-721f3b2f-437f-45ef-ac4e-df29dba74de8) web part |
33+
Microsoft.SharePoint.WebPartPages.PictureLibrarySlideshowWebPart (picture slide show) | [Image gallery](https://support.office.com/en-us/article/use-the-image-gallery-web-part-bbcbe560-14a7-4369-8ef5-3255845e3bfd) web part |
34+
Microsoft.SharePoint.WebPartPages.SimpleFormWebPart (html form embedding) | Not transformed OOB, 3rd party script editor as optional target web part |
35+
Microsoft.SharePoint.Publishing.WebControls.SummaryLinkWebPart | [Text](https://support.office.com/en-us/article/add-text-and-tables-to-your-page-with-the-text-web-part-729c0aa1-bc0d-41e3-9cde-c60533f2c801) web part | Summary links html is transformed to html that be presented using the [Text](https://support.office.com/en-us/article/add-text-and-tables-to-your-page-with-the-text-web-part-729c0aa1-bc0d-41e3-9cde-c60533f2c801) web part
36+
Microsoft.Office.InfoPath.Server.Controls.WebUI.BrowserFormWebPart (InfoPath web part) | Removed |
37+
Microsoft.SharePoint.WebPartPages.XmlWebPart (using xml and xsl to produce html) | Removed ([Text](https://support.office.com/en-us/article/add-text-and-tables-to-your-page-with-the-text-web-part-729c0aa1-bc0d-41e3-9cde-c60533f2c801) web part added to explain why) |
38+
Microsoft.SharePoint.WebPartPages.DataFormWebPart (legacy viewing of list forms) | Removed ([Text](https://support.office.com/en-us/article/add-text-and-tables-to-your-page-with-the-text-web-part-729c0aa1-bc0d-41e3-9cde-c60533f2c801) web part added to explain why) |
39+
Microsoft.SharePoint.WebPartPages.WikiContentWebpart | Removed ([Text](https://support.office.com/en-us/article/add-text-and-tables-to-your-page-with-the-text-web-part-729c0aa1-bc0d-41e3-9cde-c60533f2c801) web part added to explain why) | Not relevant anymore in SPO
40+
Microsoft.SharePoint.WebPartPages.SilverlightWebPart (running Silverlight apps) | Removed ([Text](https://support.office.com/en-us/article/add-text-and-tables-to-your-page-with-the-text-web-part-729c0aa1-bc0d-41e3-9cde-c60533f2c801) web part added to explain why) | There's no modern replacement + Silverlight is not working anymore in modern browsers like Edge and Chrome
41+
Microsoft.SharePoint.WebPartPages.GettingStartedWebPart (getting started tiles) | Removed | No point in keeping a getting started for the classic team site experience
42+
Microsoft.SharePoint.WebPartPages.SPUserCodeWebPart (Sandbox web part)| Removed | Sandboxed web parts are possible anymore in SPO
43+
Microsoft.SharePoint.Publishing.WebControls.TableOfContentsWebPart | Removed | This data should be integrated into the site navigation if still relevant
44+
45+
> [!NOTE]
46+
> All other web parts not listed in the above table will get a "default" mapping being the [Text](https://support.office.com/en-us/article/add-text-and-tables-to-your-page-with-the-text-web-part-729c0aa1-bc0d-41e3-9cde-c60533f2c801) web part stating "Web part xxx was not transformed". See the [Classic and modern web part experiences article](https://support.office.com/en-us/article/classic-and-modern-web-part-experiences-3fdae6c3-8fc1-49ab-8708-8c104b882e64) to understand how classic web parts relate to modern at a functional level.
47+
48+
## Web part transformation details
49+
50+
### XsltListViewWebPart and ListViewWebPart web parts
51+
52+
These web parts are quite flexible in classic and therefore are replaced by more specific modern web parts. The replacement works as follows:
53+
54+
- Document library: [Library](https://support.office.com/en-us/article/use-the-document-library-web-part-a9dfecc3-2050-4528-9f00-2c5afc5731b0) web part
55+
- List: [List]([List](https://support.office.com/en-us/article/use-the-list-and-other-web-parts-on-classic-pages-03044488-c0e4-4226-a8fb-4cd8364424fa)) web part
56+
- Calendar: [Events](https://support.office.com/en-us/article/use-the-events-web-part-5fe4da93-5fa9-4695-b1ee-b0ae4c981909) web part
57+
- Issue list: [List]([List](https://support.office.com/en-us/article/use-the-list-and-other-web-parts-on-classic-pages-03044488-c0e4-4226-a8fb-4cd8364424fa)) web part
58+
- Task list: [Text](https://support.office.com/en-us/article/add-text-and-tables-to-your-page-with-the-text-web-part-729c0aa1-bc0d-41e3-9cde-c60533f2c801) web part explaining this could not be mapped
59+
- Discussion board: [Text](https://support.office.com/en-us/article/add-text-and-tables-to-your-page-with-the-text-web-part-729c0aa1-bc0d-41e3-9cde-c60533f2c801) web part explaining this could not be mapped
60+
- Survey list: [Text](https://support.office.com/en-us/article/add-text-and-tables-to-your-page-with-the-text-web-part-729c0aa1-bc0d-41e3-9cde-c60533f2c801) web part explaining this could not be mapped
61+
62+
During transformation to either a List or Library web part the transformation engine will try to detect the view used to configure the web part and configure the modern Library or List web part to show the same view.
63+
64+
### ContentEditorWebPart web part
65+
66+
The content editor web part can either be used by pointing to a file somewhere else in SharePoint or alternatively it can have embedded content. Depending on the used mode the following logic is applied:
67+
68+
- File Link:
69+
- When the file is an ASPX file then this can be shown via the [Embed](https://support.office.com/en-us/article/add-content-to-your-page-using-the-embed-web-part-721f3b2f-437f-45ef-ac4e-df29dba74de8) web part
70+
- When the content is another type of file a [Text](https://support.office.com/en-us/article/add-text-and-tables-to-your-page-with-the-text-web-part-729c0aa1-bc0d-41e3-9cde-c60533f2c801) web part is show to explain this that the content is not transformed
71+
- Embedded content: OOB a [Text](https://support.office.com/en-us/article/add-text-and-tables-to-your-page-with-the-text-web-part-729c0aa1-bc0d-41e3-9cde-c60533f2c801) web part is show to explain this that the content is not transformed, alternatively a [3rd party script editor](https://github.com/SharePoint/sp-dev-modernization/blob/master/Solutions/PageTransformationUI/docs/modernization-ui-faq.md#my-script-editor-and-content-editor-web-parts-are-not-transformed) web part can be configured
72+
73+
> [!NOTE]
74+
> The March release will contain improvements, more in particular for handling content (via file link or embedded) that does not contain script references.
75+
76+
### ScriptEditorWebPart web part
77+
78+
By default a [Text](https://support.office.com/en-us/article/add-text-and-tables-to-your-page-with-the-text-web-part-729c0aa1-bc0d-41e3-9cde-c60533f2c801) web part is show to explain this that the content is not transformed, alternatively a [3rd party script editor](https://github.com/SharePoint/sp-dev-modernization/blob/master/Solutions/PageTransformationUI/docs/modernization-ui-faq.md#my-script-editor-and-content-editor-web-parts-are-not-transformed) web part can be configured.

0 commit comments

Comments
 (0)