Added a note about using suspension #3410
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ranile
reviewed
Sep 23, 2023
website/docs/concepts/suspense.mdx
Outdated
| The latter is the one responsible for signaling when to re-render the suspended components, it provides 2 interchangable ways to do so: | ||
| 1. Calling its [`resume`](https://docs.rs/yew/latest/yew/suspense/struct.SuspensionHandle.html#method.resume) method. | ||
| 2. Dropping the handle. | ||
| If the handle isn't stored for longer than the hook's scope, the suspended components will be constantly re-rendered as often as possible, thus hampering performance. |
There was a problem hiding this comment.
I would highlight the infinite loop possibility in :::danger.
Danger
The handle must be stored until it's time to render the component. Not doing so could lead to infinite loops
You can word it better for it to go along with the rest of the section
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
Visit the preview URL for this PR (updated for commit 0de5e3a): https://yew-rs--pr3410-fix-suspense-docs-51br2ehe.web.app (expires Sat, 30 Sep 2023 13:37:52 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 |
cecton
previously approved these changes
Sep 23, 2023
futursolo
reviewed
Sep 23, 2023
| otherwise, the suspended components will enter an infinite re-render loop, thus hampering performance. | ||
| In the example above, the suspension handle is preserved by being moved into a closure and passed into `on_load_user_complete`. | ||
| When the hypothetical user will be loaded, the closure will be called, thus calling `handle.resume()` and re-rendering the components associated with the suspension context. | ||
|
|
There was a problem hiding this comment.
:::
An additional pair of colons are needed at the end of the admonitions.
ranile
requested changes
Sep 23, 2023
| 2. Dropping the handle. | ||
|
|
||
| :::danger | ||
| The suspension handle must be stored until it's time to update components, i.e. with newly received data; |
There was a problem hiding this comment.
There must be a new line after this. See the link docs about using admonitions with prettier
futursolo
approved these changes
Sep 23, 2023
futursolo
approved these changes
Sep 23, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Added a mention of the requirement to store the suspension handle to the
Yew Docs on suspenseFixes #2571
Checklist