Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Trigger a CustomEvent on config load #60

Closed
humitos opened this issue Apr 24, 2023 · 1 comment · Fixed by #64
Closed

Trigger a CustomEvent on config load #60

humitos opened this issue Apr 24, 2023 · 1 comment · Fixed by #64
Assignees
@humitos

Comments

@humitos
Copy link
Member

humitos commented Apr 24, 2023

This would be useful for theme authors

https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent
@humitos humitos mentioned this issue Apr 24, 2023
Closed
@humitos
Copy link
Member Author

humitos commented Apr 26, 2023

The idea behind this is to communicate that the API call is done and the data is available for usage. This is, window.readthedocs object is ready.

This object will have the same data structure than the API response. This is on purpose to avoid maintaining multiple data structures. Authors will pin the version they are compatible with by using the meta tag: #61

humitos added a commit that referenced this issue Apr 27, 2023
@humitos
API: use <meta> to define supported API version
00120b5 
Let users to define `<meta name="readthedocs-api-version" content="1.0">` to
tell Read the Docs client what is the API scheme version supported by them.

When our client request the API data, if the `api_version` returned does not
match with the one expected by the user, another request is done to force a
particular API scheme version.

Then, we dispatch a `readthedocsdataready` custom event and expose
`window.readthedocs`, to let our users know this data is ready to be consumed by
their own integrations.

Closes #60
Closes #61
@humitos humitos mentioned this issue Apr 27, 2023
Merged
humitos added a commit that referenced this issue Apr 27, 2023
@humitos
API: use <meta> to define supported API version
f3eaa7a 
Let users to define `<meta name="readthedocs-api-version" content="1.0">` to
tell Read the Docs client what is the API scheme version supported by them.

When our client request the API data, if the `api_version` returned does not
match with the one expected by the user, another request is done to force a
particular API scheme version.

Then, we dispatch a `readthedocsdataready` custom event and expose
`window.readthedocs`, to let our users know this data is ready to be consumed by
their own integrations.

Closes #60
Closes #61
humitos added a commit that referenced this issue Apr 27, 2023
@humitos
API: use <meta> to define supported API version
2fdb6c8 
Let users to define `<meta name="readthedocs-api-version" content="1.0">` to
tell Read the Docs client what is the API scheme version supported by them.

When our client request the API data, if the `api_version` returned does not
match with the one expected by the user, another request is done to force a
particular API scheme version.

Then, we dispatch a `readthedocsdataready` custom event,
to let our users know this data is ready to be consumed by their own
integrations.

Closes #60
Closes #61
@humitos humitos mentioned this issue May 23, 2023
Closed
@humitos humitos mentioned this issue Aug 27, 2023
Closed
@humitos humitos mentioned this issue Sep 7, 2023
Closed
@humitos humitos self-assigned this Oct 19, 2023
@github-project-automation github-project-automation bot moved this to Planned in 📍Roadmap Oct 19, 2023
@humitos humitos moved this from Planned to In progress in 📍Roadmap Oct 19, 2023
@humitos humitos mentioned this issue Mar 27, 2024
Merged
@ericholscher ericholscher moved this from In progress to Needs review in 📍Roadmap Mar 27, 2024
@humitos humitos moved this from Needs review to In progress in 📍Roadmap Apr 8, 2024
@humitos humitos moved this from In progress to Needs review in 📍Roadmap Apr 9, 2024
humitos added a commit that referenced this issue Apr 15, 2024
@humitos
API: use <meta> to define supported API version and trigger `Custom…
0b06297 
…Event` (#64)

Let users to define `<meta name="readthedocs-api-version"
content="1.0">` to tell Read the Docs client what is the API scheme
version supported by them.

When our client request the API data, if the `api_version` returned does
not match with the one expected by the user, another request is done to
force a particular API scheme version.

Then, we dispatch a `readthedocsdataready` custom event ~~and expose
`window.readthedocs`~~, to let our users know this data is ready to be
consumed by their own integrations.

Closes #60
Closes #61
Closes #17 
Closes readthedocs/readthedocs.org#9957
Closes #250
@github-project-automation github-project-automation bot moved this from Needs review to Done in 📍Roadmap Apr 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@humitos humitos

Labels
None yet
Projects
📍Roadmap
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

API: use <meta> to define supported API version and trigger CustomEvent readthedocs/addons
1 participant
@humitos