Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve README of secondary window package #14691

Merged
merged 1 commit into from
Jan 9, 2025
Merged

docs: improve README of secondary window package #14691

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions packages/secondary-window/README.md
View file
Open in desktop
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
Loading