feat: add support to change spinner text using event updates #2944
Conversation
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
added 4 commits
October 19, 2022 14:04
This change allows to print event texts that will be removed when the spinner stops or when another event status update text is printed.
This is required so the event updates are cleared once another event update is received or when the spinner stops.
aljo242
reviewed
Oct 24, 2022
aljo242
reviewed
Oct 24, 2022
lumtis
reviewed
Oct 24, 2022
Co-authored-by: Alex Johnson <[email protected]> Co-authored-by: Lucas Bertrand <[email protected]>
lumtis
previously approved these changes
Oct 24, 2022
aljo242
reviewed
Oct 28, 2022
aljo242
previously approved these changes
Oct 28, 2022
Contributor
aljo242
left a comment
There was a problem hiding this comment.
LGTM - just fix changelog and we can merge
aljo242
approved these changes
Oct 28, 2022
Jchicode
pushed a commit
to Jchicode/cli
that referenced
this pull request
Aug 9, 2023
…2944) * refactor: change `StartSpinner` option to receive an optional text * feat: add progress update support for events and session print loop This change allows to print event texts that will be removed when the spinner stops or when another event status update text is printed. * refactor: add `ProgressUpdate` to some of the events This is required so the event updates are cleared once another event update is received or when the spinner stops. * refactor: rename event progress options * feat: add `cliui.StartSpinnerWithText` option to session * test: add test for event update * chore: update changelog * chore: updated some network commands to use progress update * chore: review corrections Co-authored-by: Alex Johnson <[email protected]> Co-authored-by: Lucas Bertrand <[email protected]> * chore: update changelog Co-authored-by: Alex Johnson <[email protected]> Co-authored-by: Lucas Bertrand <[email protected]>
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 PR adds spinner progress update to events for proper spinner interactions.
A spinner has a text next to the spinning animation which communicates the current status or progress. Once the spinner is started it can be updated to display a new text or stopped by using event options when sending the events though the event bus. There are three status update options:
The spinner and its current text are removed when a finish event is received thought the event bus and replaced by the finished event text.
Text that should not be removed must be printed directly using the
Sessioninstance, sent thought the event bus without theProgressStartorProgressUpdateoptions, or sent using a finish event.The PR also adds the new session option
StartSpinnerWithTextto start the spinner with a custom text to avoid an extra call tosession.StartSpinner()right after the session is created.