Project

General

Profile

Actions

Feature #27218

closed

mgr/dashboard: Style guide to give a the UI an overall look and feel

Added by Volker Theile over 5 years ago. Updated about 3 years ago.

Status:
Resolved
Priority:
Normal
Assignee:
Category:
General
Target version:
% Done:

0%

Source:
Tags:
Backport:
Reviewed:
Affected Versions:
Pull request ID:

Description

Currently there is a wild mix of workflows spread across the whole UI how things, e.g. invalid form field input or successful actions, are handled.

For example the 'Block> Images > Add RBD' dialog does not check if the entered name already exists while typing it. This shouldn't be a problem nowadays. If you enter an already used name and press 'Create RBD', the error message, that the name already exists, is displayed as notification. IMHO such messages shouldn't displayed via notification, instead they should be displayed in the form. As a user i expect that the 'Name' input field is now marked as red and a meaningful info message like 'Name is already used' is shown below the invalid form field.

The 'Object Gateway > Users > Add' form is an example how it should be done.

Some dialogs display a notification on successful actions. IMHO notifications are only useful for erroneous actions. The user realizes a successful action via the UI activity, e.g. after a RBD image is successfully created the list view is displayed afterwards. On error, the add dialog is still shown.

Topics to be discussed for a style guide to give a the UI an overall look and feel:

  • Mark invalid form fields as red and show a meaningful error message
  • Do NOT use notifications for form validation messages
  • Use async validation during typing wherever possible
  • Do NOT use notifications on successful actions
  • Define how to type menu entries and breadcumbs (Every word starts in uppercase or only the first one, e.g. 'User Management' vs. 'User management').
  • Use read-only inputs fields in forms to display not editable text.
  • ...

Files

add-user-embedded.png (38.1 KB) add-user-embedded.png Patrick Seidensal, 09/07/2018 09:31 AM
confirmation-dialog.png (19.1 KB) confirmation-dialog.png Patrick Seidensal, 09/07/2018 09:31 AM
custom-dialog-osd-flags.png (86.8 KB) custom-dialog-osd-flags.png Patrick Seidensal, 09/07/2018 09:31 AM

Related issues 6 (3 open3 closed)

Related to Dashboard - Documentation #24210: mgr/dashboard: Implement and document UX design workflow and guidelinesNew

Actions
Related to Dashboard - Cleanup #35688: mgr/dashboard: Community branding & styling recommendationsNew

Actions
Related to Dashboard - Cleanup #36070: mgr/dashboard: Use a unified quoting style (double quotes) across all UI elements (e.g. notifications)ResolvedIshan Rai

Actions
Related to Dashboard - Cleanup #33606: mgr/dashboard: Use ModalComponent in all modalsClosed

Actions
Related to Dashboard - Bug #34312: mgr/dashboard: Style guide for frontend/Angular coding conventionsNew

Actions
Related to Dashboard - Feature #36607: mgr/dashboard: Display description on mouse hoverResolvedIshan Rai

Actions
Actions

Also available in: Atom PDF