Skip to content

Commit e687631

Browse files
authored
Update isolated-web-parts.md
Additional clarification on property pane and isolated web parts disposal
1 parent 4503ea9 commit e687631

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/spfx/web-parts/isolated-web-parts.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,14 @@ API permissions granted on the tenant-level can be used by any SharePoint Framew
5858

5959
When added to the page, isolated web parts are displayed using an iframe. This iframe points to a unique ___domain assigned to the SharePoint Framework solution where the web part is located. This ___domain is also referenced in the return URL of the Azure AD application created to host the isolated permissions for the particular SharePoint Framework solution. Using the unique ___domain allows to ensure, that only web parts from the particular SharePoint Framework solution can obtain an access token for the isolated set of permissions.
6060

61+
### Property pane for isolated web parts
62+
Property pane for isolated web parts is rendered as a separate iframe with _additional_ instance of the same web part. It brings some specifics that developers should be aware of:
63+
- Isolated web part's lifecycle events such as `render` will be called twice: once for the web part itself and once for the property pane.
64+
- The property pane's iframe size is limited to the panel's dimensions. Take it into consideration if you plan to use modals or any wide controls in your property pane.
65+
66+
### Disposal of isolated web parts
67+
`onDispose` method for isolated web parts _may not be called_ as iframe removal from DOM automatically cleans all the resources, including socket connections, associated with the iframe's document.
68+
6169
### Upgrading existing project to use isolated permissions
6270

6371
If you're upgrading an existing SharePoint Framework project to v1.8.0 and want to use the isolated permissions capability, you can do it, by setting in the **config/package-solution.json** file, the `isDomainIsolated` property to `true`. You should ensure, that your project contains only web parts.

0 commit comments

Comments
 (0)