UI elements audit

Last modified by Vincent Massol on 2024/11/19 16:15

 XWiki
 Requirements
 Idea
 

Description

  

What is an element, actually?

An element, or at least an element that is considered to be added to this audit, is one that:

  • provides important information to the user
  • is used as it is by any user that doesn't add custom code to it
  • has its general look the same for any user that doesn't add custom code to it
  • enables an action to the user 
  • has a certain shape or structure
  • is not a simple text or link

Small elements 

Success

Defining small size elements:

Taking the primary button (example: Save & View button) as the main size unit, a small sized element is one that:

  • has its height smaller than the button
  • and
  • has its width smaller than the width of the button
Name or use

Look in Iceberg

150% zoom

 

Color variables that affect itClasses that affect itComments

Like button

1692367307210-793.png   

Tags list, tag &...

Add tag button

1692367422804-563.png   

Edit paragraph button

1692367532524-819.png   

Comment Tools buttons

1692368495714-146.png   

Previous and Next Page icon

1692369132087-805.png   

Nav Bar Icons

1692369791483-472.png   

Navigation tree Current Page

1694081407382-638.png125% zoom   

Rating stars

1694087129637-203.png   

Seen notification button

1694091930817-676.png   

See details on notification button

1694091979496-743.png   

Medium Elements 

Success

Defining medium size elements:

Taking the primary button (example: Save & View button) as the main size unit, a medium sized element is one that:

  • has its height always staying in between 1 and 2 x the height of the button
  • or
  • has its width always staying in between 1 and 3 x the width of the button
Name or use

Look in Iceberg

150% zoom

Color variables that affect itClasses that affect itComments

Edit & create button

1692366570936-310.png

 

 #contentmenu, pull-right, actionmenu, btn-group, btn, btn-default, fa fa-pencil,  

In Content Menu -

Dropdown Toggle & Options Button

1692366632789-612.png #contentmenu, pull-right, actionmenu,, btn-group, btn, btn-default, dropdown-toggle, 

Search bar

in nav bar, next to the search button

1692367688911-456.png  different from the search bar in Global Administration

Breadcrumb

1692368129707-777.png   

Comment Avatar Image

1694082455263-862.png   

Text fields

1692368886424-464.png   

Search bar from Global Adminstration

1694084577056-184.png  different from the search bar from the navbar

Administration Categories Panels

normal:1694084695098-901.png

clicked:1694084830301-255.png

 

   

Icon for Administration categories Panels

1694086962512-162.png   

Panel

1692367777051-949.png   

Info, warning, success, error box

1692369371199-407.png  

 

Special case:

While they can definitely stretch much more than the bounds defined in the beginning of this section, their usual use case is signaling something important. This is usually pretty short.

 

Notifications settings

1694091777626-644.png   

Notification Action indicator icon

1694091891415-320.png   

Large elements 

Success

Defining large size elements:

A large size element is one that ocupies a large portion of the screen vertically and horizontally. More specifically, a large size element:

Name or use

Look in Iceberg

100% zoom

Color variables that affect itClasses that affect itImportant dimensions Comments

Main content Area

anything you write    

Document Footer

1694081454609-663.png    

Doc Extra Section (for example Comments)

1694082091232-916.png

the yellow outline is what 

    

Color variables

Usage for less obvious variables

@body-bg - side columns background color

1692372005843-527.png

@xwiki-page-content-bg - main content's background color

1692371671019-402.png

@brand-primary

@brand-success

@brand-info

@brand-warning

@brand-danger

@font-family-base

@font-family-sans-serif

@font-family-serif

@font-family-monospace

@font-size-base

@table-bg

@table-bg-hover

@table-border-color

Values on themes

 IcebergCeruleanCharcoalCosmoCyborgDarklyFlatlyGardenJournalKittyLumenMarinaPaperSandstonereadableSimplexSlateSpaceLabYeti
@text-color#333333                  
@body-bg#fafafa                  
@xwiki-page-content-bg#ffffff                  
@link-color#3173b5                  
@brand-primary
 
                  
@brand-success#56b881                  
@brand-info#3bb2d0                  
@brand-warning
 
                  
@brand-danger
 
                  
@headings-color#333333                  
@component-active-color@list-group-link-hover-color                  
@component-active-bg@list-group-hover-bg                  

@font-family-base

Open Sans, sans-serif                  
@font-family-sans-serif
 
                  
@font-family-serif
 
                  
@font-family-monospace
 
                  
@font-size-base                   
@table-bg                   
@table-bg-hover                   
@table-border-color                   
@btn-font-weight                   
@btn-default-color                   
@btn-default-bg                   
@btn-primary-color                   
@btn-primary-bg                   

 Themes comments & issues

 IcebergCeruleanCharcoalCosmoCyborgDarklyFlatlyGardenJournalKittyLumenMarinaPaperReadableSandstoneSimplexSlateSpaceLabUnitedYeti
 main  very nice some elements are too white for how dark it is  very nice nice, but needs more contrast  very nice pretty okaysome elements are too white for how dark it ispretty okaypretty okay 

 


 

Get Connected