hypothesis / hypothesis/client

Mechanism for disabling creating annotations and displaying highlights on the host frame for enable-annotations iframe use cases

Open
#6,477 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Mustache
Stars
730
Forks
224
PR merge metrics
No merged PRs in 30d

Description

Whenever the `VitalSourceInjector` injector is used, a `Guest` is not instantiated in the Host window. As a result, annotating is only possible in the `VitalSource` viewer even though Hypothesis is loaded in the parent frame as well.

Whenever the `HypothesisInjector` is used, [annotations are always enabled](https://github.com/hypothesis/client/blob/main/src/annotator/index.ts#L139) in the Host window. It seems there are valid use cases where this is simply not necessary, for example an LMS UI loading a reader type viewer in an iframe.

Perhaps a configuration property can be introduced that determines whether the `Guest` gets initialised?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.