Add callback for page changes in instructions plugin #3190
Merged
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.
A new parameter
page_change_callback
is added to plugin instructions. This function is called every time a page change occurs and receives one single argument which is the index of the current page, starting from0
.I am really in favor of this parameter because we often are in the need of acquiring the current page number and make corresponding changes. For example, we might want to hide button previous on the first page and change the label of button forward to "start experiment" on the last page. We can do this without the
page_change_callback
parameter naturally, but not as convenient as with the parameter.Normally, with a plugin that does not have "page change", we can achieve this with the
on_finish
parameter. But given that the instructions plugin is a special one with page change, I think a resembling parameter ought to be added, hence thepage_change_callback
.