Skip to content

Commit ef49e2b

Browse files
MartinS-gitedda
andauthored
feat(ui): adds illustrations into UX documentation (#1489)
* feat(ui): adds illustrations into UX documentation * fix(ui):fixes issues with images and reworkes section modals and overflow menu --------- Co-authored-by: Esther Schmitz <edda@users.noreply.github.com>
1 parent a9bcdbd commit ef49e2b

10 files changed

Lines changed: 4669 additions & 10 deletions

docs/ux/images/Alternative_Second-Level_Navigations.svg

Lines changed: 636 additions & 0 deletions
Loading

docs/ux/images/Layout_Fundamentals-Anatomy.svg

Lines changed: 490 additions & 0 deletions
Loading

docs/ux/images/Layout_Fundamentals-Footer.svg

Lines changed: 983 additions & 0 deletions
Loading

docs/ux/images/Side_Navigation_as_Top_Level_Navigation.svg

Lines changed: 655 additions & 0 deletions
Loading

docs/ux/images/Site_Navigation.svg

Lines changed: 1303 additions & 0 deletions
Loading

docs/ux/images/Switching_Between_Embedded_Apps.svg

Lines changed: 593 additions & 0 deletions
Loading

docs/ux/layout-fundamentals.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
As a bare minimum, a Juno application will comprise of a page header, a main content area, and a page footer.
66

7-
[illustration 1]
7+
![Layout Fundamentals - Anatomy](images/Layout_Fundamentals-Anatomy.svg)
88

99
The page footer will always be at the bottom of the viewport as a minimum (i.e. if the page content requires less than viewport height), or at the very bottom of the content.
1010

11-
[illustration 2 – do/don't]
11+
![Layout Fundamentals - Footer](images/Layout_Fundamentals-Footer.svg)
1212

1313
All but the most basic applications will require some means of navigation. As a standard rule, the top level navigation will be a side navigation left of the content area.
1414

15-
[illustration 3]
15+
![Layout Fundamentals - SideNavigation](images/Side_Navigation_as_Top_Level_Navigation.svg)

docs/ux/legacy-application-layout.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ In some applications built with earlier versions of Juno, the top level navigati
66

77
**Using a horizontal header navigation as top level navigation is non-compliant and strongly discouraged.**
88

9+
![Layout Fundamentals - SideNavigation](images/Site_Navigation.svg)
10+
911
Ideally, all applications should upgrade to a more recent version of Juno and adapt current layout rules, however this is not feasible in all cases.
1012

1113
Support for this type of navigation could be dropped with any new major release of Juno at any time.

docs/ux/navigation-fundamentals.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@
66

77
Juno applications will use a side navigation as their top level navigation, with only very few and rare exceptions for legacy applications. A side navigation may be flat with no sub-levels for apps with a simpler structure. For applications with a more complex or deeper navigational structure, the Juno side navigation can contain entries with child elements, or host groups of elements with or without a title. In general, we do not recommended to use more than three levels.
88

9-
[illustration, same as layout-fundamentals ill. 2, do]
9+
![Side Navigation](images/Side_Navigation_as_Top_Level_Navigation.svg)
1010

1111
## Alternative Second-Level Navigations
1212

1313
In cases where using a second or third level in the Juno SideNavigation is not feasible, a second-level top navigation above the content, that visibly is a child of the currently selected top level navigation entry, may be used.
1414

15-
[illustration]
15+
![Second-Level Navigations](images/Alternative_Second-Level_Navigations.svg)
1616

1717
## Switching Between Embedded Apps
1818

19-
In order to switch between embedded applications, even if not a "navigation" in the strict, technical sense of the term, we allow for using a navigation-like element, as switching between applications in such a scenario will be indistinguishable from an actual navigation for a user.
19+
In order to switch between embedded applications, even if not a "navigation" in the strict, technical sense of the term, we allow for using a navigation-like element `A`, as switching between applications `B` in such a scenario will be indistinguishable from an actual navigation for a user.
2020

21-
[illustration]
21+
![Switching Between Embedded Apps](images/Switching_Between_Embedded_Apps.svg)

docs/ux/popup-and-overflow-menus.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,9 @@ An established Popup menu pattern used in many user interfaces is the OverflowMe
1515
Use an OverflowMenu when:
1616

1717
- The options or actions in the menu are associated with or targeted at a specific item
18-
- there is not enough space to show the available options inline / as-is.
19-
- there are more than 2-3 options available for the item the options are associated with
2018

2119
Do NOT use an overflow item when:
2220

23-
- There is only one action (unless there really is no other way of placing that option)
2421
- It is impossible for a user to establish what item or UI element the menu and its options refer to
2522

2623
When using a PopupMenu, always make sure:

0 commit comments

Comments
 (0)