docs: Add architecture document #949
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
Member
mofojed
commented
Oct 22, 2024
•
mofojed
commented
- Provide details about the overall high-level architecture of deephaven.ui
- Diagram a couple work flows
- Fixes General deephaven.ui docs (Architecture) #954
- Provide details about the overall high-level architecture of deephaven.ui - Diagram a couple work flows
- It's now in it's own file
dsmmcken
reviewed
Oct 22, 2024
Co-authored-by: margaretkennedy <[email protected]>
mattrunyon
reviewed
Oct 24, 2024
dsmmcken
requested changes
Nov 4, 2024
mattrunyon
reviewed
Nov 4, 2024
Co-authored-by: Matthew Runyon <[email protected]>
dsmmcken
previously approved these changes
Nov 6, 2024
|
|
||
| ### Render context | ||
|
|
||
| Each component renders in its own render context, which helps keep track of state and side effects. While rendering components, "hooks" are used to manage state and other side effects. The magic part of hooks is they work based on the order they are called within a component. When a component is rendered, a new context is set, replacing the existing context. When the component is done rendering, the context is reset to the previous context. This allows for nested components to have their own state and side effects, and for the parent component to manage the state of the child components, re-using the same context when re-rendering a child component. |
There was a problem hiding this comment.
should you define hooks more explicitly before discussing their magic?
There was a problem hiding this comment.
Hmm they likely deserve their own instructional page, in the hooks folder. Right now I have pages for specific hooks (use_state, use_effect, use_memo) but having a top level hooks pages similar to the React docs would be handy.
I'll capture this as part of #996
Co-authored-by: margaretkennedy <[email protected]>
margaretkennedy
approved these changes
Nov 7, 2024
dsmmcken
approved these changes
Nov 7, 2024
mattrunyon
approved these changes
Nov 7, 2024
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.