docs: Using Hooks#1056
Merged
Merged
Conversation
|
|
||
| ## Built-in Hooks | ||
|
|
||
| `Deephaven.ui` has a large number of built-in hooks to help with the development of components. The full documenation for these can be found in the `Hooks` section of the documentation. |
Contributor
Author
There was a problem hiding this comment.
There is no md file for hooks. It is in sidebar.json. Is there a way to link to this? I want to link users the section of the docs where they can access all the use_hook.md files.
Member
There was a problem hiding this comment.
There is an overview file for hooks actually that would be appropriate. ../hooks/overview.md.
Co-authored-by: margaretkennedy <82049573+margaretkennedy@users.noreply.github.com>
mofojed
requested changes
Dec 5, 2024
Comment on lines
+150
to
+151
| - Custom hooks may call other hooks | ||
| - Custom hooks follow the same rules as built-in hooks. |
Member
There was a problem hiding this comment.
Not sure how to word this better but it's worded kind of oddly right now.
Hooks can call other hooks, but usage of hooks within hooks follows the same rules as using hooks within components.
Co-authored-by: Mike Bender <mikebender@deephaven.io>
dsmmcken
reviewed
Dec 6, 2024
|
|
||
| See the [`use_state`](../hooks/use_state.md) documentation for more detailed information. | ||
|
|
||
| ### Use Memo Hook |
Contributor
There was a problem hiding this comment.
Worth including details that table operations should typically be memoized with use_memo?
Contributor
Author
There was a problem hiding this comment.
I am going to put that in docs for "working with tables".
dsmmcken
requested changes
Dec 6, 2024
mofojed
previously approved these changes
Dec 6, 2024
Co-authored-by: margaretkennedy <82049573+margaretkennedy@users.noreply.github.com>
margaretkennedy
previously approved these changes
Dec 9, 2024
jjbrosnan
reviewed
Dec 10, 2024
| @@ -0,0 +1,194 @@ | |||
| # Using Hooks | |||
Contributor
There was a problem hiding this comment.
Avoid words ending with ing in titles.
jjbrosnan
reviewed
Dec 10, 2024
|
|
||
| The `use_state` hook takes an optional parameter that is the initial state. It initializes to `None` if this is omitted. The hook returns two values: a state variable and a `set` function that lets you update the state and trigger a re-render. | ||
|
|
||
| See the [`use_state`](../hooks/use_state.md) documentation for more detailed information. |
Contributor
There was a problem hiding this comment.
Instead of saying See the use_whatever documentation for more detailed info, why not just link to that documentation everywhere you mention use_whatever?
jjbrosnan
reviewed
Dec 10, 2024
|
|
||
| ### Use Effect Hook | ||
|
|
||
| Call `use_effect` to synchronize a component with an external system. An effect runs when it is mounted or a dependency changes. An optional cleanup function runs when dependencies change or the component is unmounted. |
Contributor
There was a problem hiding this comment.
Link to use_effect here.
jjbrosnan
reviewed
Dec 10, 2024
|
|
||
| The `use_effect` hook takes two parameters: a callable and a list of dependencies. The callable may return a function for cleanup. | ||
|
|
||
| See the [`use_effect`](../hooks/use_effect.md) documentation for more detailed information. |
Contributor
There was a problem hiding this comment.
This isn't necessary in every section if you just link to the guide wherever you mention use_effect, use_memo, etc.
jjbrosnan
reviewed
Dec 10, 2024
|
|
||
|
|
||
| my_server = ui_server() | ||
| ``` |
Contributor
Author
There was a problem hiding this comment.
There is no related documentation for this section.
|
|
||
| The `use_callback` hook takes two parameters: a callable and a list of dependencies. It returns a memoized callback. The memoized callback is returned on subsequent renders until the dependencies change. | ||
|
|
||
| ## Rules for Hooks |
Contributor
There was a problem hiding this comment.
should rules come before the types of hooks?
Rules
Built-in
Build your own
Co-authored-by: margaretkennedy <82049573+margaretkennedy@users.noreply.github.com>
margaretkennedy
previously approved these changes
Dec 12, 2024
Contributor
margaretkennedy
left a comment
margaretkennedy
left a comment
There was a problem hiding this comment.
Two minor grammar updates
Co-authored-by: margaretkennedy <82049573+margaretkennedy@users.noreply.github.com>
margaretkennedy
previously approved these changes
Dec 16, 2024
jjbrosnan
previously approved these changes
Dec 16, 2024
dgodinez-dh
dismissed stale reviews from jjbrosnan and margaretkennedy
via
1941f88
margaretkennedy
approved these changes
Dec 16, 2024
dsmmcken
approved these changes
Dec 16, 2024
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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-205