Skip to main content

A full-screen image modal XBlock

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openedx_xblock_image_modal-4.1.0.tar.gz (30.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

openedx_xblock_image_modal-4.1.0-py3-none-any.whl (31.6 kB view details)

Uploaded Python 3

File details

Details for the file openedx_xblock_image_modal-4.1.0.tar.gz.

File metadata

File hashes

Hashes for openedx_xblock_image_modal-4.1.0.tar.gz
Algorithm Hash digest
SHA256 56cd56a279a16a5d9c453ed859a1a29b8ed4f72e589431d86330811338f2b398
MD5 0d13219cb2d280fe0bad57a41ec1bc13
BLAKE2b-256 23300313267e7d1bf3e94c0cd4c23f965c3435a086642e3699c04a776fbf5e72

See more details on using hashes here.

File details

Details for the file openedx_xblock_image_modal-4.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for openedx_xblock_image_modal-4.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 22bdf8a8e1591a667e20ad182d7d49a28c28ded77ea3a40f6be2ca7eb614ed57
MD5 3a6186ccc898efae5428ec7f9fbad9ef
BLAKE2b-256 b030165d706903c7b88c639f060f836bf4efc76eea64a1c19285d91c0297f615

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page