Desktop: Multiple window support #11181
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Related to laurent22#10459, but needs more testing -- this change could cause regressions.
| const parentNode = loaded ? doc?.body : null; | ||
|
|
||
| // eslint-disable-next-line @typescript-eslint/no-explicit-any -- Needed to allow adding the portal to the DOM | ||
| const contentPortal = parentNode && createPortal(props.children, parentNode) as any; |
There was a problem hiding this comment.
Related documentation/explanation:
- React Portals documentation.
- StackOverflow thread with discussion on how to render React components to a new window.
- A blog post about using
createPortalwith new windows.
…me' into test/editor-in-iframe
…en and into separate directory This pull request previously moved the main window command registration logic from MainScreen.tsx to a different component that could manage showing dialogs, etc for different windows. This, however, could cause errors when closing settings (attempts to use commands with unregistered runtimes). This pull request ensures that command runtimes are registered by loading them in Root.tsx, rather than in MainScreen.tsx.
styled-components only works in the main window. See the related styled-components/styled-components#2620.
| return <> | ||
| <div ref={setDependencyStyleContainer}></div> | ||
| <StyleSheetManager target={dependencyStyleContainer}> | ||
| <CacheProvider value={cache}> |
There was a problem hiding this comment.
This code uses CacheProvider from @emotion/react to cause react-select to insert its styles into the new window (see comment). @emotion/react is a dependency of react-select and, at present, is not a direct dependency of Joplin.
Adding @emotion/react to app-desktop/package.json could be problematic if react-select is updated without also updating the @emotion/react version — having multiple versions of @emotion/react may cause styling issues (or perhaps break styling just in new windows).
See this unmerged upstream pull request for a possible future solution that doesn't involve importing transitive dependencies.
personalizedrefrigerator
changed the title
This commit converts the toggleEditors command to an editor command.
…me' into test/editor-in-iframe
to be restored By registering the toggleEditors runtime sooner, the `runtimeMustBeRegistered: true` assertion can be restored.
container window and fix tag display
personalizedrefrigerator
added
enhancement
This commit attempts to address what may be a race condition -- if commands aren't loaded by the time certain parts of the UI attempt to render, a "crashed" screen can be shown. This may be what is happening in CI.
background windows Previously, these buttons were enabled/disabled based on the state of whichever window had focus.
Previously, only the focused window's note history was updated.
Creates titles for background windows based on the current note ID.
There was a problem hiding this comment.
NoteEditor.tsx is a new file. The old NoteEditor.tsx was renamed to NoteEditorContent.tsx.
- To-do: Use a different name for the note editor wrapper so that it's marked as a rename by
git?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This pull request allows opening Joplin's editor in a new window using React's portal API. It still has a few issues and is thus a draft.
Known issues
selectedNoteIdalways act on the note displayed in the main window.selectedNoteIdfor their enabled condition can be incorrectly enabled/disabled in new windows.state.notesis refreshed unnecessarily when a window gains focus and it isn't a just-created window.all-windows-same-layout.webm
Screen recording
multi-window-demo-oct-15-2024.webm
Notes
documentandwindowvariables may no longer point to the current component's DOM.useDomhook has been added to get theDocumentfor a component.react-selectto be styled in new windows, it seems necessary to wrap the window's content in theCacheProvidercomponent from one of its dependencies.