Project

General

Profile

Actions

Story #21003

open

Improve guidelines around loading indicators and status messages

Added by Peter Amstutz 2 months ago. Updated 4 days ago.

Status:
New
Priority:
Normal
Assigned To:
Category:
Workbench2
Start date:
Due date:
% Done:

0%

Estimated time:
(Total: 0.00 h)
Story points:
-

Description

Update the GUI coding guidelines


Subtasks 1 (1 open0 closed)

Task #21012: ReviewNewPeter Amstutz

Actions
Actions #1

Updated by Peter Amstutz about 2 months ago

  • Target version changed from Development 2023-10-11 sprint to Development 2023-10-25 sprint
Actions #2

Updated by Peter Amstutz about 1 month ago

  • Target version changed from Development 2023-10-25 sprint to Development 2023-11-08 sprint
Actions #3

Updated by Peter Amstutz about 1 month ago

  • Description updated (diff)
Actions #4

Updated by Peter Amstutz 25 days ago

  • Target version changed from Development 2023-11-08 sprint to Development 2023-11-29 sprint
Actions #5

Updated by Stephen Smith 4 days ago

Here's a sample guideline for loading indicators, mostly codifies what we already have but the important things are the recent decision to not use the page spinner for background / partial page updates and a reminder not to use toasts to notify when an action is starting:

Loading indicator use-case guidelines

Page Navigation

  • Navigation between pages should be indicated using progressIndicatorActions.START_WORKING and progressIndicatorActions.STOP_WORKING
  • Only the initial load of the page or refreshes of the entire page (eg. triggered by the upper right refresh button) should use this indicator. Partial refreshes should use a more local indicator.

User Actions

  • Form submissions or user actions should be indicated by both the progressIndicatorActions.START_WORKING and by enabling the spinner on the submit button of the form (if the action takes place through a form AND if the form stays open for the duration of the action in order to show errors). If the form closes immediately then the page spinner is the only indicator.
  • Toasts should not be used to notify the user of an in-progress action but only completion / error

And here are a few places where I found toasts being used to indicate an in progress action:

  • Add/remove favorites
  • Add/remove public favorites
  • Remove process
Actions #6

Updated by Peter Amstutz 4 days ago

  • Target version changed from Development 2023-11-29 sprint to Development 2024-01-03 sprint
Actions

Also available in: Atom PDF