[dataquery] Add ability for other modules to add actions #9302
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
maximemulder
reviewed
Jul 2, 2024
Comment on lines
56
to
61
| steps.push(<ButtonElement | ||
| label={fieldLabel} | ||
| columnSize='col-sm-12' | ||
| key='fields' | ||
| onUserInput={() => props.changePage('DefineFields')} | ||
| onUserInput={() => props.changePage(Tabs.Fields)} | ||
| />); |
There was a problem hiding this comment.
This button element seems to be repeated a lot, can it be factorized ?
Comment on lines
+60
to
+66
| if (steps[Tabs.Info]) { | ||
| steps[Tabs.Info].push({ | ||
| label: widget.label, | ||
| action: func, | ||
| }); | ||
| } | ||
| break; |
There was a problem hiding this comment.
The pattern of this switch should maybe be factorized ?
Comment on lines
+36
to
+38
| if (activeTab == Tabs.Fields | ||
| || activeTab == Tabs.Filters | ||
| || activeTab == Tabs.Data) { |
There was a problem hiding this comment.
Could you use strict equality here (and in a few other places) ?
| function getCallback(name: string): (() => void) | null { | ||
| const namepieces = name.split('.').reverse(); | ||
| let level: any = window; | ||
| for (let name = namepieces.pop(); name; name = namepieces.pop()) { |
There was a problem hiding this comment.
Could you use for of here ?
| />); | ||
| break; | ||
| } | ||
|
|
||
| for (const osteps of (props.extrasteps[props.page] || [])) { |
There was a problem hiding this comment.
I'd personally put the for inside a if instead.
Comment on lines
+40
to
+41
|
|
||
|
|
There was a problem hiding this comment.
Extra line breaks (we should probably add a lint for that).
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.
This adds the ability for other modules to add custom actions to the "Next Steps" of the dataquery module. An example of an "Action" that might be added is a "Package Data Release" for the data_release module or a "Send to CBRAIN" for a theoretical CBRAIN module on the final view data page.
To add an action, the module's getWidgets must return an array of
\LORIS\dataquery\ActionWidgets to be added when called with the type argument ofdataquery:action. Each ActionWidget adds a button on a particular dataquery page which, when clicked, invokes a javascript callback that can be customized by the module.Plugin actions provided by a module are displayed in a second row underneath the "Next Steps" .