From d8022a16ffa6d6305a655f86b46b989c89b58f16 Mon Sep 17 00:00:00 2001 From: Stefan Dirix Date: Thu, 9 Jan 2025 13:48:16 +0100 Subject: [PATCH] docs: improve README of secondary window package (#14691) Updates the outdated README of the `@theia/secondary-window` package. Contributed on behalf of STMicroelectronics --- packages/secondary-window/README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/packages/secondary-window/README.md b/packages/secondary-window/README.md index 6cfb92c619a21..1cb40e013b547 100644 --- a/packages/secondary-window/README.md +++ b/packages/secondary-window/README.md @@ -12,12 +12,18 @@ ## Description -The `@theia/secondary-window` extension contributes UI integration that allows moving widgets to secondary windows. +The `@theia/secondary-window` extension contributes the extract command and toolbar item to move extractable widgets to secondary windows. + +To mark a widget to be extractable, implement the `ExtractableWidget` interface from `@theia/core`. ### Limitations -- **The extension is currently only suitable for use in browser applications** because there are some unresolved issues with *Electron*. -- Currently, only webview widgets can be moved to secondary windows. +For the extraction to work we require changes in upstream libraries. +Theia offers the `theia-patch` CLI command to apply these patches. + +Recommendation: Execute `theia-patch` in the `postinstall` script of your root npm package to automatically apply the patches. + +If the patches are not applied, the secondary window will show empty. ## Additional Information