NUKnightLab / NUKnightLab/StoryMapJS

Support webp images

Open
#451 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
248
Forks
61
Avg merge
1m
Merged PRs (30d)
1

Description

Via Zendesk, we received this request:

could you please add a possibility to allow displaying WebP-Images for maps and content?
Ideally this is done via a wrapping -tag to enable downwards compatibility for browsers, who don’t support WebP yet.

It's reasonable to add support for uploading webp images and supporting them in the image mediatype (see also the media type identification process) and, perhaps, in custom map markers.

However, it is unlikely that StoryMapJS will support the <picture> element, as that would then involve also supporting upload of (or automated creation of) alternative sources. Supporting user upload of (or specification via URL of) multiple sources would add far too much complexity to the user experience, and the is no evidence of a community of users who would take advantage of multiple image support outside of the hosted experience.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with source/js/media/types/VCO.Media.Image.js and the media type identification process in source/js/media/VCO.MediaType.js. Check how image uploads and custom map markers are handled. Done means WebP images can be uploaded and displayed for maps and content, while the issue's requested picture-element fallback remains out of scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.