Document how to customize the Voila Preview widget shell area #1327
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
|
|
jtpio
commented
Jun 14, 2023
| @@ -193,7 +193,8 @@ const extension: JupyterFrontEndPlugin<IVoilaPreviewTracker> = { | |||
| path: context.path, | |||
| factory: 'Voila-preview', | |||
| options: { | |||
| mode: 'split-right' | |||
| mode: 'split-right', | |||
| type: 'Voila Preview' | |||
There was a problem hiding this comment.
TODO: Actually need to check if the factory is already enough.
There was a problem hiding this comment.
If so we can update this PR to provide documentation about widget positioning.
jtpio
changed the title
type option when opening the preview
jtpio
changed the title
|
Hi @jtpio, would you mind if I take over this PR? |
|
Thanks @trungleduc, yes feel free thanks! Happy to review afterwards. |
|
Failed CI test is not related. |
|
Thanks @trungleduc! |
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.
References
This should help address the point mentioned in #1304 (comment).
This will also help with jupyter/notebook#6386.
Code changes
Voila Previewfor consistency with theMarkdown Previewfactory in JupyterLabUser-facing changes
End users can configure the JupyterLab layout to open the Voila preview in a different area than
main.Backwards-incompatible changes
None