hypothesis / client

The Hypothesis web-based annotation client.
Other
641 stars 197 forks source link

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

Open jwgmeligmeyling opened 3 months ago

jwgmeligmeyling commented 3 months ago

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 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?

robertknight commented 3 months ago

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

This makes sense. Maybe something like enableAnnotation: boolean to control whether annotation is enabled in the current frame?