dive-custom-slideshow 0.1.3__tar.gz

dive_custom_slideshow-0.1.3/.copier-answers.yml

@@ -0,0 +1,14 @@
+# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
+_commit: v4.4.0
+_src_path: https://github.com/jupyterlab/extension-template
+author_email: ltshum6-c@my.cityu.edu.hk
+author_name: ltshum
+has_binder: false
+has_settings: true
+kind: frontend
+labextension_name: dive-custom-slideshow
+project_short_description: JupyterLab extension for animated slideshow.
+python_name: custom_slideshow
+repository: https://github.com/ltshum/fyp-dive-custom-slideshow
+test: true
+

dive_custom_slideshow-0.1.3/.devcontainer/Dockerfile

@@ -0,0 +1,17 @@
+FROM mcr.microsoft.com/devcontainers/miniconda:0-3
+
+# Copy environment.yml (if found) to a temp location so we update the environment.
+COPY environment.yml /tmp/conda-tmp/
+RUN /opt/conda/bin/conda config --add channels conda-forge \
+    && /opt/conda/bin/conda config --remove channels defaults \
+    && /opt/conda/bin/conda install -y mamba
+RUN umask 0002 && /opt/conda/bin/mamba env update -n base -f /tmp/conda-tmp/environment.yml
+
+# [Optional] Uncomment to install a different version of Python than the default
+# RUN mamba install -y python=3.6 \
+#     && pip install --no-cache-dir pipx \
+#     && pipx reinstall-all
+
+# [Optional] Uncomment this section to install additional OS packages.
+# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
+#     && apt-get -y install --no-install-recommends <your-package-list-here>

dive_custom_slideshow-0.1.3/.devcontainer/devcontainer.json

@@ -0,0 +1,33 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/miniconda
+{
+  "name": "Miniconda (Python 3)",
+  "build": {
+    "context": "..",
+    "dockerfile": "Dockerfile"
+  },
+
+  // Features to add to the dev container. More info: https://containers.dev/features.
+  // "features": {},
+
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  // "forwardPorts": [],
+
+  // Use 'postCreateCommand' to run commands after the container is created.
+  // "postCreateCommand": "python --version",
+
+  // Configure tool-specific properties.
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "dbaeumer.vscode-eslint",
+        "esbenp.prettier-vscode",
+        "meganrogge.template-string-converter",
+        "ms-python.python"
+      ]
+    }
+  }
+
+  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+  // "remoteUser": "root"
+}

dive_custom_slideshow-0.1.3/.gitignore

@@ -0,0 +1,129 @@
+*.bundle.*
+lib/
+node_modules/
+*.log
+.eslintcache
+.stylelintcache
+*.egg-info/
+.ipynb_checkpoints
+*.tsbuildinfo
+dive_custom_slideshow/labextension
+# Version file is handled by hatchling
+dive_custom_slideshow/_version.py
+
+# Integration tests
+ui-tests/test-results/
+ui-tests/playwright-report/
+
+# Created by https://www.gitignore.io/api/python
+# Edit at https://www.gitignore.io/?templates=python
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage/
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# End of https://www.gitignore.io/api/python
+
+# OSX files
+.DS_Store
+
+# Yarn cache
+.yarn/
+
+# VS Code
+.vscode/
+.copier-answer.vscode.yml

dive_custom_slideshow-0.1.3/.prettierignore

@@ -0,0 +1,6 @@
+node_modules
+**/node_modules
+**/lib
+**/package.json
+!/package.json
+custom_slideshow

dive_custom_slideshow-0.1.3/.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

dive_custom_slideshow-0.1.3/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+<!-- <START NEW CHANGELOG ENTRY> -->
+
+<!-- <END NEW CHANGELOG ENTRY> -->
+
+## 0.1.3 - 2026/5/14
+
+- Compile with jupyterlab 4.5.x to make it work with xeus kernel that requires 4.5.x.
+
+## 0.1.2 - 2026/4/22
+
+### Added
+
+- Add class labelling for MathJax expressions (Details: [MathJax html extension](https://docs.mathjax.org/en/latest/input/tex/extensions/html.html))
+
+### Fixed
+
+- Fix SVG reset error when no animation is created
+- Fix error initializing multiple SVG images in the same cell
+
+## 0.1.1 - 2026/3/27
+
+### Fixed
+
+- Fix MathJax selector for "animation" object in SVG animations
+- Fix README.md image links
+
+## 0.1.0 - 2026/3/22
+
+- Initial release

dive_custom_slideshow-0.1.3/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, ltshum
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

dive_custom_slideshow-0.1.3/PKG-INFO

@@ -0,0 +1,198 @@
+Metadata-Version: 2.4
+Name: dive-custom-slideshow
+Version: 0.1.3
+Summary: JupyterLab extension for animated slideshow.
+Project-URL: Homepage, https://github.com/ccha23/fyp-custom-slideshow
+Project-URL: Bug Tracker, https://github.com/ccha23/fyp-custom-slideshow/issues
+Project-URL: Repository, https://github.com/ccha23/fyp-custom-slideshow.git
+Author-email: ltshum <ltshum6-c@my.cityu.edu.hk>
+License: BSD 3-Clause License
+        
+        Copyright (c) 2025, ltshum
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice, this
+           list of conditions and the following disclaimer.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice,
+           this list of conditions and the following disclaimer in the documentation
+           and/or other materials provided with the distribution.
+        
+        3. Neither the name of the copyright holder nor the names of its
+           contributors may be used to endorse or promote products derived from
+           this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+License-File: LICENSE
+Keywords: jupyter,jupyterlab,jupyterlab-extension
+Classifier: Framework :: Jupyter
+Classifier: Framework :: Jupyter :: JupyterLab
+Classifier: Framework :: Jupyter :: JupyterLab :: 4
+Classifier: Framework :: Jupyter :: JupyterLab :: Extensions
+Classifier: Framework :: Jupyter :: JupyterLab :: Extensions :: Prebuilt
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# dive_custom_slideshow
+
+[![Github Actions Status](https://github.com/ltshum/fyp-custom-slideshow/workflows/Build/badge.svg)](https://github.com/ltshum/fyp-custom-slideshow/actions/workflows/build.yml)
+
+JupyterLab extension for animated slideshow.
+
+Demo: https://ltshum.github.io/jupyterlite/lab/index.html
+<br>(Please run all cells before initializing slideshow to correctly display animations.)
+
+## Requirements
+
+- JupyterLab >= 4.0.0
+
+## Install
+
+To install the extension, execute:
+
+```bash
+pip install dive_custom_slideshow
+```
+
+## Uninstall
+
+To remove the extension, execute:
+
+```bash
+pip uninstall dive_custom_slideshow
+```
+
+## Usage
+
+### Slideshow
+
+The slideshow follows the Reveal.js framework. The slide type of a cell can be changed in `COMMON TOOLS > Slide Type`. Available slide types include **Slide**, **Sub-Slide**, **Fragment**, **Skip**.
+
+![Image](https://github.com/ltshum/fyp-custom-slideshow/blob/main/Demo/common_tools.png?raw=true)
+
+The transition type and duration of a cell can be changed in `SLIDESHOW TOOLS`. Available transition types include **Slide**, **Fade**, **Zoom**. The default transition type can be changed in Settings. Transition-out type inherits the transition type by default.
+
+For transition type of **Slide**, the slide direction can be either **Horizontal** or **Vertical**. By default, Slides have horizontal transitions, and Sub-Slides have vertical transitions.
+
+![Image](https://github.com/ltshum/fyp-custom-slideshow/blob/main/Demo/transition.png?raw=true)
+
+For code cells, the input of the cell can be hidden by checking `Hide Code Cell`, leaving only the output visible.
+
+![Image](https://github.com/ltshum/fyp-custom-slideshow/blob/main/Demo/code_cell.png?raw=true)
+
+To start a slideshow, select `Slideshow` in the main menu and select either `Start from first cell` or `Start from current cell`. `Start from first cell` starts the slideshow from the beginning. `Start from current cell` starts the slideshow at the selected cell.
+
+To exit a slideshow, exit fullscreen. The `Exit slideshow` option is an alternative for when exiting fullscreen does not exit the slideshow successfully.
+
+![Image](https://github.com/ltshum/fyp-custom-slideshow/blob/main/Demo/start_slideshow.png?raw=true)
+
+### SVG Animation
+
+The SVG animation feature uses the [Reveal.js Animate and LoadContent plugins by Asvin Goel](https://github.com/rajgoel/reveal.js-plugins). Animations are loaded after starting a slideshow.
+
+To add an SVG image for animating, add `%%markdown` at the start of a code cell, and create a `<div>` block with attribute `data-animate`. Either add the SVG data inside the block, or use the [`data-load` attribute from the LoadContent plugin](https://github.com/rajgoel/reveal.js-plugins/blob/master/loadcontent/README.md).
+
+![Image](https://github.com/ltshum/fyp-custom-slideshow/blob/main/Demo/SVG.png?raw=true)
+
+To animate the SVG image, add a comment block with a JSON string. The `setup` object controls the images after loading. The `animation` object controls the images on each fragment. To successfully set up the animation, the corresponding number of fragments must be added in the cell. More details can be viewed in the [README of the Animate plugin](https://github.com/rajgoel/reveal.js-plugins/blob/master/animate/README.md).
+
+![Image](https://github.com/ltshum/fyp-custom-slideshow/blob/main/Demo/SVG_anim.png?raw=true)
+
+### MathJax SVG
+
+MathJax 4 is installed to convert math expressions into SVG images, which can be used for animations. Components in the SVG image can be selected with selector `g[data-latex='x']`, which is simplified into `mj['x']`.
+
+![Image](https://github.com/ltshum/fyp-custom-slideshow/blob/main/Demo/mathjax.png?raw=true)
+
+## Contributing
+
+### Development install
+
+Note: You will need NodeJS to build the extension package.
+
+The `jlpm` command is JupyterLab's pinned version of
+[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
+`yarn` or `npm` in lieu of `jlpm` below.
+
+```bash
+# Clone the repo to your local environment
+# Change directory to the dive_custom_slideshow directory
+# Install package in development mode
+pip install -e "."
+# Link your development version of the extension with JupyterLab
+jupyter labextension develop . --overwrite
+# Rebuild extension Typescript source after making changes
+jlpm build
+```
+
+You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
+
+```bash
+# Watch the source directory in one terminal, automatically rebuilding when needed
+jlpm watch
+# Run JupyterLab in another terminal
+jupyter lab
+```
+
+With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
+
+By default, the `jlpm build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
+
+```bash
+jupyter lab build --minimize=False
+```
+
+### Development uninstall
+
+```bash
+pip uninstall dive_custom_slideshow
+```
+
+In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
+command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
+folder is located. Then you can remove the symlink named `custom-slideshow` within that folder.
+
+### Testing the extension
+
+#### Frontend tests
+
+This extension is using [Jest](https://jestjs.io/) for JavaScript code testing.
+
+To execute them, execute:
+
+```sh
+jlpm
+jlpm test
+```
+
+#### Integration tests
+
+This extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).
+More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.
+
+More information are provided within the [ui-tests](./ui-tests/README.md) README.
+
+### Packaging the extension
+
+See [RELEASE](RELEASE.md)

dive_custom_slideshow-0.1.3/README.md

@@ -0,0 +1,142 @@
+# dive_custom_slideshow
+
+[![Github Actions Status](https://github.com/ltshum/fyp-custom-slideshow/workflows/Build/badge.svg)](https://github.com/ltshum/fyp-custom-slideshow/actions/workflows/build.yml)
+
+JupyterLab extension for animated slideshow.
+
+Demo: https://ltshum.github.io/jupyterlite/lab/index.html
+<br>(Please run all cells before initializing slideshow to correctly display animations.)
+
+## Requirements
+
+- JupyterLab >= 4.0.0
+
+## Install
+
+To install the extension, execute:
+
+```bash
+pip install dive_custom_slideshow
+```
+
+## Uninstall
+
+To remove the extension, execute:
+
+```bash
+pip uninstall dive_custom_slideshow
+```
+
+## Usage
+
+### Slideshow
+
+The slideshow follows the Reveal.js framework. The slide type of a cell can be changed in `COMMON TOOLS > Slide Type`. Available slide types include **Slide**, **Sub-Slide**, **Fragment**, **Skip**.
+
+![Image](https://github.com/ltshum/fyp-custom-slideshow/blob/main/Demo/common_tools.png?raw=true)
+
+The transition type and duration of a cell can be changed in `SLIDESHOW TOOLS`. Available transition types include **Slide**, **Fade**, **Zoom**. The default transition type can be changed in Settings. Transition-out type inherits the transition type by default.
+
+For transition type of **Slide**, the slide direction can be either **Horizontal** or **Vertical**. By default, Slides have horizontal transitions, and Sub-Slides have vertical transitions.
+
+![Image](https://github.com/ltshum/fyp-custom-slideshow/blob/main/Demo/transition.png?raw=true)
+
+For code cells, the input of the cell can be hidden by checking `Hide Code Cell`, leaving only the output visible.
+
+![Image](https://github.com/ltshum/fyp-custom-slideshow/blob/main/Demo/code_cell.png?raw=true)
+
+To start a slideshow, select `Slideshow` in the main menu and select either `Start from first cell` or `Start from current cell`. `Start from first cell` starts the slideshow from the beginning. `Start from current cell` starts the slideshow at the selected cell.
+
+To exit a slideshow, exit fullscreen. The `Exit slideshow` option is an alternative for when exiting fullscreen does not exit the slideshow successfully.
+
+![Image](https://github.com/ltshum/fyp-custom-slideshow/blob/main/Demo/start_slideshow.png?raw=true)
+
+### SVG Animation
+
+The SVG animation feature uses the [Reveal.js Animate and LoadContent plugins by Asvin Goel](https://github.com/rajgoel/reveal.js-plugins). Animations are loaded after starting a slideshow.
+
+To add an SVG image for animating, add `%%markdown` at the start of a code cell, and create a `<div>` block with attribute `data-animate`. Either add the SVG data inside the block, or use the [`data-load` attribute from the LoadContent plugin](https://github.com/rajgoel/reveal.js-plugins/blob/master/loadcontent/README.md).
+
+![Image](https://github.com/ltshum/fyp-custom-slideshow/blob/main/Demo/SVG.png?raw=true)
+
+To animate the SVG image, add a comment block with a JSON string. The `setup` object controls the images after loading. The `animation` object controls the images on each fragment. To successfully set up the animation, the corresponding number of fragments must be added in the cell. More details can be viewed in the [README of the Animate plugin](https://github.com/rajgoel/reveal.js-plugins/blob/master/animate/README.md).
+
+![Image](https://github.com/ltshum/fyp-custom-slideshow/blob/main/Demo/SVG_anim.png?raw=true)
+
+### MathJax SVG
+
+MathJax 4 is installed to convert math expressions into SVG images, which can be used for animations. Components in the SVG image can be selected with selector `g[data-latex='x']`, which is simplified into `mj['x']`.
+
+![Image](https://github.com/ltshum/fyp-custom-slideshow/blob/main/Demo/mathjax.png?raw=true)
+
+## Contributing
+
+### Development install
+
+Note: You will need NodeJS to build the extension package.
+
+The `jlpm` command is JupyterLab's pinned version of
+[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use
+`yarn` or `npm` in lieu of `jlpm` below.
+
+```bash
+# Clone the repo to your local environment
+# Change directory to the dive_custom_slideshow directory
+# Install package in development mode
+pip install -e "."
+# Link your development version of the extension with JupyterLab
+jupyter labextension develop . --overwrite
+# Rebuild extension Typescript source after making changes
+jlpm build
+```
+
+You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
+
+```bash
+# Watch the source directory in one terminal, automatically rebuilding when needed
+jlpm watch
+# Run JupyterLab in another terminal
+jupyter lab
+```
+
+With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).
+
+By default, the `jlpm build` command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:
+
+```bash
+jupyter lab build --minimize=False
+```
+
+### Development uninstall
+
+```bash
+pip uninstall dive_custom_slideshow
+```
+
+In development mode, you will also need to remove the symlink created by `jupyter labextension develop`
+command. To find its location, you can run `jupyter labextension list` to figure out where the `labextensions`
+folder is located. Then you can remove the symlink named `custom-slideshow` within that folder.
+
+### Testing the extension
+
+#### Frontend tests
+
+This extension is using [Jest](https://jestjs.io/) for JavaScript code testing.
+
+To execute them, execute:
+
+```sh
+jlpm
+jlpm test
+```
+
+#### Integration tests
+
+This extension uses [Playwright](https://playwright.dev/docs/intro) for the integration tests (aka user level tests).
+More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab.
+
+More information are provided within the [ui-tests](./ui-tests/README.md) README.
+
+### Packaging the extension
+
+See [RELEASE](RELEASE.md)