Skip to content

Commit

Permalink
docs: improve README of secondary window package (#14691)
Browse files Browse the repository at this point in the history
Updates the outdated README of the `@theia/secondary-window` package.

Contributed on behalf of STMicroelectronics
  • Loading branch information
sdirix authored Jan 9, 2025
1 parent 6ea0f22 commit d8022a1
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions packages/secondary-window/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit d8022a1

Please sign in to comment.