The "Load selected image" button

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

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale
Tech stack
javascript
Domain
frontend

Research direction

The issue names no files or tests; start by tracing the "Load selected image" button and the Exhibit Builder attachment flow. Review the stated event race condition and Annotorious's hidden-image limitation, then clarify the desired behavior and acceptance criteria before changing anything.

Written by the indexing model from the issue text.

Description

While the "Load selected image" button isn't ideal, it's the only guaranteed way to load an annotatable image. This is for several reasons:

  • The Exhibit Builder doesn't trigger an event after applying an attachment. If it triggered an exhibit-builder-apply-attachment event after adding the attachment to the DOM, there wouldn't be the race condition that's preventing us from getting the new attachment's file ID.
  • Even if the above event existed, Annotorious cannot make a hidden image annotatable. This means that every time the page loads or the user applies an attachment we'd need to open the "Annotate Image" drawer before loading the annotatable image. I don't think having a bunch of auto-opened fullsize images on the page is a good user experience.
Dominant language
JavaScript
Stars
4
Forks
1
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from omeka/plugin-ExhibitImageAnnotation

All issues in omeka/plugin-ExhibitImageAnnotation

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.