docs: ui.combo_box #718
Merged
docs: ui.combo_box #718
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
AkshatJawne
commented
Aug 8, 2024
bmingles
reviewed
Aug 9, 2024
bmingles
reviewed
Aug 9, 2024
bmingles
reviewed
Aug 9, 2024
bmingles
reviewed
Aug 9, 2024
bmingles
reviewed
Aug 9, 2024
bmingles
reviewed
Aug 9, 2024
AkshatJawne
commented
Aug 9, 2024
jnumainville
reviewed
Aug 9, 2024
| ## API Reference | ||
|
|
||
| ```{eval-rst} | ||
| .. dhautofunction:: deephaven.ui.combo_box |
There was a problem hiding this comment.
Since I see you have a new dhautofunction here, please either
- Create the docs locally and verify they are created correctly (the easiest way to do this is via
tools/plugin_builder.py, check out the readme and let me know if you have problems). - Wait until fix: Prevent pushing broken docs to main #719 is merged then merge main in to this branch so the docs will be checked automatically
Thanks
bmingles
reviewed
Aug 13, 2024
bmingles
reviewed
Aug 14, 2024
bmingles
reviewed
Aug 14, 2024
| @@ -323,27 +327,37 @@ my_combo_box_event_example = ui_combo_box_event_example() | |||
|
|
|||
| ## Control | |||
|
|
|||
| When a combo box has multiple controlled properties (e.g., `input_value`, `selected_key`), updates to one property do not automatically update the others. Each interaction triggers only its specific event handler. For instance, typing in the input field will only trigger the `on_input_change`, not the `on_selection_change`. | |||
| Each interaction done in the ComboBox will only trigger its associated event handler. For instance, typing in the input field will only trigger the `on_input_change`, not the `on_change`. | |||
There was a problem hiding this comment.
This is true for typing, but it contradicts earlier docs when user selects a value, that does actually fire on_input_change.
bmingles
requested changes
Aug 14, 2024
dsmmcken
requested changes
Aug 15, 2024
dsmmcken
reviewed
Aug 16, 2024
dsmmcken
requested changes
Aug 16, 2024
dsmmcken
previously approved these changes
Aug 19, 2024
Co-authored-by: margaretkennedy <[email protected]>
margaretkennedy
approved these changes
Aug 19, 2024
dsmmcken
approved these changes
Aug 19, 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.
Closes #687