docs: render cycle #1087
Merged
docs: render cycle #1087
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
mofojed
requested changes
Jan 22, 2025
|
|
||
| ### Initial Render | ||
|
|
||
| When your component first mounts, it triggers an initial render. It is rendered with it's props and initial state. |
There was a problem hiding this comment.
We should probably detail what "mounts" means.
We're talking about when the component is opened by a user, or viewed in a dashboard.
| After you trigger a render, `deephaven.ui` encodes your components as JSON which is sent from the server to the web client UI. The client decodes the JSON into a document which is rendered by React. | ||
|
|
||
| - On initial render, `deephaven.ui` will encode the root component. | ||
| - For subsequent renders, `deephaven.ui` will encode the component whose state update triggered the render. |
There was a problem hiding this comment.
This isn't actually true yet - we're still re-encoding everything and sending it.
I needed to update Steven's pending change and get it over the line: #1069
There was a problem hiding this comment.
Should I remove this part of the doc for now?
There was a problem hiding this comment.
Yea I think just remove these bullet points for now.
|
|
||
| ## Step 2: `deephaven.ui` renders your components | ||
|
|
||
| After you trigger a render, `deephaven.ui` encodes your components as JSON which is sent from the server to the web client UI. The client decodes the JSON into a document which is rendered by React. |
There was a problem hiding this comment.
I think this needs to be worded a bit differently, we should mention this is the part where it runs the component functions and then it encodes it.
mofojed
approved these changes
Jan 23, 2025
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.
https://deephaven.atlassian.net/browse/DOC-357