Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a spinner or overlay when mutations are triggered #342

Open
kinow opened this issue Dec 19, 2019 · 3 comments
Open

Add a spinner or overlay when mutations are triggered #342

kinow opened this issue Dec 19, 2019 · 3 comments
Milestone

Comments

@kinow
Copy link
Member

kinow commented Dec 19, 2019

Describe exactly what you would like to see in an upcoming release

At the moment, when a user clicks on hold, release, or stop Toolbar buttons, there is no visual feedback to the user in the UI. Users are still able to see what is going on by inspecting browser network, or workflow logs.

But we should add a way to tell users to not worry, that the mutation was executed successfully - or not.

Additional context

Related to #87 I think. @oliver-sanders I thought in a few alternatives:

  • disable the button, and replace the icon by a spinning circle
  • disable the button, and add an overlay on top of the Toolbar (Toolbar gets greyed out, and comes back to normal once the transaction is done)
  • disable the button, and add an overlay on the whole page or on the content area (i.e. leave GScan as-is so users can switch? not sure if that'd work - what happens when user navigates back?)

Any other ideas? This could be applied to other parts of the design, such as tooltip buttons like Trigger/Reset/Hold/Remove/etc.

Pull requests welcome!

@oliver-sanders
Copy link
Member

oliver-sanders commented Dec 19, 2019

I think disable the button, add a pop-up/overlay.

Once Cylc Flow returns subscription IDs for mutations we will be able to track the progress of requests. In the design document under the "Api On The Fly" section there is an overview of how this could look. The idea being that once a mutation is triggered a pop-up/overlay appears with a spinner displaying the status of the mutation. The overlay could have a "minimise" option which allows the overlay to be minimised into the "commands" box (the "reload", "poll" and "kill" commands could take a while to complete).

So if you tried to stop the suite (even if via the button on the toolbar) you should get the overlay. Messages should appear something like this:

  • submitted request
  • request received
  • waiting for active tasks to stop
  • shutting down
  • done

@kinow
Copy link
Member Author

kinow commented Dec 19, 2019

Oh, I see the "command queued" in the api on the fly example.

So if you tried to stop the suite (even if via the button on the toolbar) you should get the overlay. Messages should appear something like this

On the sketches, there is a message next to the "Control" button (Toolbar). Is that where these messages should go?

@oliver-sanders
Copy link
Member

oliver-sanders commented Dec 19, 2019

Yeah, that was the idea.

This is all blue-skies and subject to some thought and design.

Idea is to:

  • Make it clear to the user that an action has been requested.
  • Keep them up-to date of the request's progress.
  • Not prevent them from working whilst the request is in-progress if the request takes a while to return.

So a pop-up/overlay is great but we might need to minimise it in a way where the user can return to it later.

(FYI we should do something similar with the CLI too)

@MetRonnie MetRonnie added this to the 2.0 milestone Feb 7, 2022
@oliver-sanders oliver-sanders modified the milestones: 2.0.0, Pending Jun 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants