Skip to main content
Archived

This project has been archived by its maintainers, and is no longer receiving any updates.

Status

⚠️ Repository Migration Notice ⚠️

Image Modal XBlock

A full-screen image modal XBlock, for use within the Open edX platform.

badge-ci

The full-screen image tool is another way of enabling participants to see more detail in your provided images. This tool is useful for large images with lots of details. A re-sized version of the image displays in the page, but clicking on the image pops open a full-screen modal with the full-size version of the image.

image-lms-view-normal

Installation

System Administrator

To install the XBlock on your platform, add the following to your requirements.txt file:

xblock-image-modal

You’ll also need to add this to your INSTALLED_APPS:

imagemodal

Course Staff

To install the XBlock in your course, access your Advanced Module List:

Settings -> Advanced Settings -> Advanced Module List

image-cms-settings-menu

and add the following:

imagemodal

image-cms-advanced-module-list

Use

Course Staff

To add a full-screen image to your course:

  • upload the image file onto your course’s Files & Uploads page

    • note: you can skip this step if you’ve already uploaded the image elsewhere, e.g.: S3.

  • copy the URL on that page

  • go to a unit in Studio

  • select “Image Modal XBlock” from the Advanced Components menu

image-cms-add

You can now edit and preview the new component.

image-cms-view

Using the Studio editor, you can edit the following fields:

  • display name

  • image URL

  • thumbnail URL (defaults to image URL, if not specified)

  • description (useful for screen readers, longer descriptions)

  • alt text (useful for screen readers, captions, tags; displays when image does not)

image-cms-editor-1 image-cms-editor-2

Participants

image-lms-view-normal

Click on the image to zoom in full-screen.

image-lms-view-zoom

Click on the image again to zoom out.

Click and drag to pan around.

View a demo of the CMS

View a demo of the LMS

Metadata

Release files for openedx-xblock-image-modal 5.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openedx-xblock-image-modal 5.0.0
File Size Uploaded
openedx_xblock_image_modal-5.0.0.tar.gz 31.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for openedx-xblock-image-modal 5.0.0
File Interpreter ABI Platform
openedx_xblock_image_modal-5.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 63.1 kB

Release files / openedx_xblock_image_modal-5.0.0.tar.gz

Download URL openedx_xblock_image_modal-5.0.0.tar.gz
Size 31.2 kB
Tags Source
SHA-256 checksum
How to use checksums
18d08e38fc0012ab5fbb7b62a701382dc11a951f8366f36a674514fb49888776
BLAKE2b-256 checksum
How to use checksums
7cb1962996f32a0d23b6f15850dbbaff3482569bfe26cd476a4bcd19fa2c716b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.12

Release files / openedx_xblock_image_modal-5.0.0-py3-none-any.whl

Download URL openedx_xblock_image_modal-5.0.0-py3-none-any.whl
Size 31.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
47d4b57cbcb1aca3a9ce5e67dcc0274ebd188606136e40b3e551a261626ec7b1
BLAKE2b-256 checksum
How to use checksums
fd0c8a079fc4bec749f8c218cc6e29339e2b168af8c3dc3b7e813e46ed4c4818
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.12
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page