Skip to content

Commit

Permalink
Document contentReady configuration setting
Browse files Browse the repository at this point in the history
  • Loading branch information
robertknight committed Jul 19, 2023
1 parent 38b13e8 commit 682c542
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/publishers/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,14 @@ loads.
of that text when it is being viewed as well as the font-family of the
editor as the annotation is being written.

.. option:: contentReady

``Promise``. A promise that signals to Hypothesis when the document's content
is ready. In web applications where the content loads asynchronously, this
allows Hypothesis to be loaded concurrently with the content, while making
sure that Hypothesis waits for the content to be ready before attempting to
locate annotated content in the document.

.. option:: onLayoutChange

``function``. This function will be a registered callback to be invoked when the sidebar
Expand Down

0 comments on commit 682c542

Please sign in to comment.