jupyterlab_markdown_switch_tab_scrolling_fix
JupyterLab extension that prevents markdown files from scrolling uncontrollably when switching tabs while images load.
The Problem
When you switch back to a markdown tab in JupyterLab, images reload and cause the viewport to jump as they render. This creates disorienting scroll drift that moves you away from where you were reading.
Key observations:
- Issue only occurs with markdown files containing images
- Triggered by tab switching (deactivate then reactivate)
- Browser recalculates layout as each image loads, causing cumulative scroll displacement
- Native JupyterLab has no scroll position protection during image rendering
The Fix
This extension locks scroll position when you switch to a markdown tab until all images finish loading.
How it works:
- Detects when markdown widgets become active via JupyterLab's shell signals
- Captures initial scroll position immediately on tab activation
- Monitors all image load events in the markdown
- Actively corrects any scroll drift (checks every 100ms)
- Releases lock after all images load and position stabilizes for 300ms
- User scroll (wheel or touch) immediately overrides the lock
- While the lock is live the widget node carries
data-jp-scroll-guard="active"; other extensions read it to hold their own scroll restores until the lock releases
Implementation details:
- Maximum lock duration: 3 seconds
- Handles cached images that load instantly
- Uses WeakMap to prevent multiple guards on same widget
- Passive event listeners for performance
Technical Implementation
The extension hooks into JupyterLab's shell lifecycle using the ILabShell.currentChanged signal to detect tab switches. When a markdown widget activates, the handler searches for .jp-RenderedMarkdown containers and queries all image elements. It captures the initial scroll position (scrollTop/scrollLeft), then attaches load event listeners to track completion of image rendering.
A guard interval runs every 100ms, comparing current scroll position against the saved position. Any drift exceeding 1 pixel triggers immediate correction by resetting scrollTop/scrollLeft. The guard tracks stability (position unchanged for 300ms) and image load completion. Once all images finish loading and position remains stable, the guard releases. User scroll events (wheel or touchstart) immediately abort the guard to preserve manual navigation.
Core components:
ILabShell.currentChangedsignal handler detects widget activation- DOM query selects
.jp-RenderedMarkdown imgelements for monitoring addEventListener('load', handler, { once: true })tracks image completionwindow.setInterval()guard runs drift correction every 100ms- WeakMap associates guard interval IDs with widget instances
- Passive event listeners detect user scroll intent without blocking
Requirements
- JupyterLab >= 4.0.0
Install
To install the extension, execute:
pip install jupyterlab_markdown_switch_tab_scrolling_fix
Uninstall
To remove the extension, execute:
pip uninstall jupyterlab_markdown_switch_tab_scrolling_fix
Contributing
If you would like to contribute to this extension, please refer to the Contributing Guide.
Metadata
Release files for jupyterlab-markdown-switch-tab-scrolling-fix 1.0.18
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| jupyterlab_markdown_switch_tab_scrolling_fix-1.0.18.tar.gz | 223.0 kB | Without provenance | Details for jupyterlab_markdown_switch_tab_scrolling_fix-1.0.18.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| jupyterlab_markdown_switch_tab_scrolling_fix-1.0.18-py3-none-any.whl | Python 3 | none | any | Details for jupyterlab_markdown_switch_tab_scrolling_fix-1.0.18-py3-none-any.whl |
Total release size: 241.1 kB
Release files / jupyterlab_markdown_switch_tab_scrolling_fix-1.0.18.tar.gz
| Download URL | jupyterlab_markdown_switch_tab_scrolling_fix-1.0.18.tar.gz |
|---|---|
| Size | 223.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0e371c83764adda2a912d5334bac9be9c08db9fc3a1b4f26302ff5cfbc3af766
|
|
BLAKE2b-256 checksum How to use checksums |
7291861124c5d525c3d7b0792876cb9a2c01c749fbcabe8190669af193c4de30
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.15
|
Release files / jupyterlab_markdown_switch_tab_scrolling_fix-1.0.18-py3-none-any.whl
| Download URL | jupyterlab_markdown_switch_tab_scrolling_fix-1.0.18-py3-none-any.whl |
|---|---|
| Size | 18.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bdf5c40464bc6be68c69f0a03c94c1362e2b895ec145f402e1d0c0e2a5c89796
|
|
BLAKE2b-256 checksum How to use checksums |
41540248c07bdd9e9cbd946040fca6fb1a652fea9913d3a4c9c03f5eafbd6dd4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.15
|
Security for jupyterlab-markdown-switch-tab-scrolling-fix 1.0.18
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.