Feature Wiki

Information about planned and released features

Tabs

Make « Add to Favourites » an AJAX Call

Page Overview

[Hide]

1 Initial Problem

ILIAS 6 is reloading the entire page when a user just wants to add a single item to the list of 'Favourites'. This should be done more economically.

2 Conceptual Summary

  • Adding an item to (and removing it from) the list of 'Favourites' should be implemented as an asynchronous AJAX call without reloading the entire page.
  • The success message should no longer be prompted at the page head but be an overlay (similar to the message already used by the ILIAS page editor). Probably, this UI element needs to be added to the Kitchen Sink.

3 User Interface Modifications

3.1 List of Affected Views

  • All container with ListGUI
  • Dashboard » Favourites
  • Favourites

3.2 User Interface Details

Success message for adding an object to 'Favourites' or removing it from there has to be removed.

Overlay to notify user about having added object to 'Favourites' or having removed it needs to be implemented (and probably added to Kitchen Sink). Unlike already existing overlay in page editor where user has to confirm or cancel action, this UI element vanishs automatically after two seconds. No confirmation required.

3.3 New User Interface Concepts

No new user interface concept.

4 Technical Information

{The maintainer has to provide necessary technical information, e.g. dependencies on other ILIAS components, necessary modifications in general services/architecture, potential security or performance issues.}

5 Privacy Information

No personal data will be stored. ILIAS just stores user's favourites – as already done.

6 Security Implications

{ Does the feature include any special security relevant changes, e.g. the introducion of new endpoints or other new possible attack vectors. If yes, please explain these implications and include a commitment to deliver a written security concept as part of the feature development. This concept will need an additional approvement by the JourFixe. }

7 Contact

8 Funding

If you are interest in funding this feature, please add your name and institution to this list.

9 Discussion

Amstutz, Timon [amstutz], 30.03.2020: I fully support the idea of not having an ajax request after this action. However, I yet fail to see how the UI element would look like. The following questions:

  • Where should it appear?
  • How should it look like?
  • For what type of actions should this be re-used.
Note that those are roughly the things we expect to be defined for a UI Component. There are several options:
  • Introduce temporary Message Boxes (the thing we currently use, but loaded and removed per js/ajax).
  • Toast like things (the thing that appears on the top right corner.
  • ...
IMO we can accept the general idea here, but with the ceveat, that this can only be implemented, if we find a UI component, that is accepted by the JF. Since this could turnout to be such a commenly used component in future with rather high impact on the UI, I can imagine, that the discussion could be a) very important for us, b) not very easy ;-).

JourFixe, ILIAS [jourfixe], 30 MAR 2020 : We highly appreciate this suggestion and schedule the feature for ILIAS 7. We still need to discuss the user interface for notifying the user about the added or removed favourite. This solution should go into the KS and be usable for similar use cases. Final solution will be presented on the page.

JourFixe, ILIAS [jourfixe], 22 MAR 2021 : We still would like to have this feature and re-schedule it for ILIAS 8. KS discussion for this UI element still needs to be done.

10 Implementation

{The maintainer has to give a description of the final implementation and add screenshots if possible.}

Test Cases

Test cases completed at {date} by {user}

  • {Test case number linked to Testrail} : {test case title}

Approval

Approved at {date} by {user}.

Last edited: 22. Mar 2021, 16:17, Kunkel, Matthias [mkunkel]