Note: This bug is displayed in read-only format because the product is no longer active in Red Hat Bugzilla.

Bug 1553902

Summary: [RFE] Update UI plugin API to reflect current UI design
Product: [oVirt] ovirt-engine Reporter: Vojtech Szocs <vszocs>
Component: Frontend.WebAdminAssignee: Alexander Wels <awels>
Status: CLOSED CURRENTRELEASE QA Contact: Pavel Novotny <pnovotny>
Severity: low Docs Contact:
Priority: medium    
Version: futureCC: apinnick, awels, bugs, gshereme, lsvaty, tjelinek
Target Milestone: ovirt-4.3.0Keywords: CodeChange, FutureFeature
Target Release: 4.3.0Flags: rule-engine: ovirt-4.3?
rule-engine: planning_ack?
rule-engine: devel_ack+
lsvaty: testing_ack+
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: ovirt-engine-4.3.0_alpha Doc Type: Enhancement
Doc Text:
The current release of the User Interface Plugin API supports the updated Administration Portal design with the following changes: - Custom secondary menu items can be added to the vertical navigation menu. - Some functions have been renamed for consistency with the new Administration Portal design. A deprecation notice is displayed when the old names are used. - Some functions no longer support the `alignRight` parameter because the tabs are aligned horizontally, flowing from left to right.
 Story Points: ---
Clone Of: Environment:
Last Closed: 2019-03-26 07:17:47 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: UX RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Attachments:
Description Flags
UI plugin to test changes none

Description Vojtech Szocs 2018-03-09 20:18:49 UTC 
WebAdmin UI plugin API should be updated to reflect the current UI design.

1. add functions to deal with nav menu items:
   a) add new primary item that doesn't hold any secondary items (=> adds new place)
   b) add new primary item that is supposed to hold secondary items (visible only if there's at least one secondary item contained within)
   c) add new secondary item into the given primary item; support existing/core primary items as well as ones created via 1.b) (=> adds new place)

2. reconcile function names/signatures to be consistent and meaningful by adding new functions
   - replace "tab" with "place" where appropriate

3. for existing functions that are deprecated by 2.
   - those should be preserved for backwards compatibility
   - calling those functions should log a warning in browser console, for example: "addMainTab is deprecated, please use xx or yy instead."

In addition, UI plugins feature page should be updated to reflect the current state.
Comment 1 Tomas Jelinek 2018-03-15 07:34:44 UTC 
*** Bug 1518907 has been marked as a duplicate of this bug. ***
Comment 2 Vojtech Szocs 2018-03-15 13:50:39 UTC 
doc-text updated, it's ready for review.
Comment 3 Alexander Wels 2018-03-15 19:05:30 UTC 
Created attachment 1408530 [details]
UI plugin to test changes
Comment 4 Pavel Novotny 2019-03-25 15:42:28 UTC 
Verified in
ovirt-engine-4.3.2.1-0.1.el7.noarch
ovirt-engine-webadmin-portal-4.3.2.1-0.1.el7.noarch

1. All regression Webadmin tests passed.

2. The test plugin in attachment 1408530 [details] loaded without problems and works properly,
i.e., the extra menu items were added using the new methods with "place" instead of "tab" in the name.

Also now there are deprecation warnings in the browser console, for example:
- "addSubTab is deprecated, please use addDetailPlace instead."
- "setTabAccessible is deprecated, please use setPlaceAccessible instead."
...
Comment 5 Sandro Bonazzola 2019-03-26 07:17:47 UTC 
This bugzilla is included in oVirt 4.3.0 release, published on February 4th 2019.

Since the problem described in this bug report should be
resolved in oVirt 4.3.0 release, it has been closed with a resolution of CURRENT RELEASE.

If the solution does not work for you, please open a new bug report.