API: save a "flag" on window object
#474
Conversation
We need to find a way for people subscribing to the Read the Docs data ready event _after_ it was triggered. This is an idea about how to solve this use case. It adds a "flag" in the `window` object that users can check _before_ subscribing to that event to make usage of the data if the event was triggered already. * Reference: readthedocs/readthedocs.org#10648 (comment) * Example: https://github.com/readthedocs/test-builds/blob/full-feature/docs/static/readthedocs.js
| @@ -114,6 +114,10 @@ export function getReadTheDocsConfig(sendUrlParam) { | |||
| // Expose `dataUser` if available or the `data` already requested. | |||
| const dataEvent = dataUser !== undefined ? dataUser : data; | |||
|
|
|||
| // Add the data to the window so scripts loaded after the initial | |||
| // event was fired can still get access to the data | |||
| window.ReadTheDocsEventData = new ReadTheDocsEventData(dataEvent); | |||
There was a problem hiding this comment.
Avoid using window as this isn't usable in tests/Node. Use globalThis to always reference the correct global.
|
Hi @humitos, @agjohnson, |
|
@DimedS We are still experimenting with a different, and more generic approach. I want to continue testing that, before moving forward here since it may replace the idea from this branch. I will let you know when I have some progress on this. |
Thanks, @humitos! Appreciate the update and your efforts! |
We need to find a way for people subscribing to the Read the Docs data ready event after it was triggered. This is an idea about how to solve this use case.
It adds a "flag" in the
windowobject that users can check before subscribing to that event to make usage of the data if the event was triggered already.