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.

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

[Doc] Add documentation for <CheckForApplicationUpdate onNewVersionAvailable> #9437

Merged
merged 4 commits into from
Nov 13, 2023

Conversation

smeng9
Copy link
Contributor

@smeng9 smeng9 commented Nov 9, 2023

Closes #9432

@fzaninotto
Copy link
Member

Thanks for the PR.

I think the hook should remain private - we just can't document all hooks, or the doc will become too large. As the component supports all the props of the hook, you should just document the onNewVersionAvailable prop in the <CheckForApplicationUpdate> component chapter.

@fzaninotto fzaninotto merged commit 9d42d92 into marmelab:master Nov 13, 2023
1 of 3 checks passed
@fzaninotto
Copy link
Member

Thanks!

@smeng9
Copy link
Contributor Author

smeng9 commented Nov 13, 2023

Hi @fzaninotto

The Props for typescript should probably be updated, we should no longer omit the callback in the props.
https://github.com/marmelab/react-admin/blob/master/packages/ra-ui-materialui/src/layout/CheckForApplicationUpdate.tsx#L88

Also there should be no space in the documentation for the prop https://github.com/marmelab/react-admin/blob/master/docs/CheckForApplicationUpdate.md?plain=1#L49

@slax57 slax57 changed the title Add documentation for useCheckForApplicationUpdate [Doc] Add documentation for <CheckForApplicationUpdate onNewVersionAvailable> Nov 14, 2023
@slax57
Copy link
Contributor

slax57 commented Nov 14, 2023

@smeng9 Thanks for your reply.

You are correct about the TS type, I'll open a quick PR. EDIT: #9444

Regarding the space in the prop's name in the documentation, this is intentional, to allow the table to break the word for a better layout.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Feature Request: Enhancing <CheckForApplicationUpdate> for module federation apps
3 participants