Abstract
Themeing and Styling need to be improved, especially the stylesheets are quite a mess as of 5.0-alpha2. Project structure needs to be reviewed to properly modularize styling and widgets, so that apps/views can be properly extended. We expect this concept to lead to proper themeing and styling guidelines, as well as reorganizing and cleaning up the stylesheets.
This concept also belongs to the following user story.
1. Themeing
Problem
- We don't have true themeing so far, only fields in dialogs have decent styles
- If I add a TextField and a Button in my app, they should also have the Magnolia style
- Stylesheets are a real mess
- They're not properly modularized
- Some rules don't belong to the right stylesheet
- Widget styles and app styles are also mixed up inside these stylesheets
- Some style rules are simply duplicated across several stylesheets (forms vs. dialogs)
- All vaadin standard UI components should look visually integrated into magnolia
- Styling could be applied in a more light-weight way
Proposal
- We use SASS
- We cannot specify multiple themes in the
@Theme
annotation- But we can add
@include
SASS rules to use themes as mixins
- But we can add
- We have a MagnoliaThemeUI demo vaadin application that features UI components from vaadin, for theme development
- is this acceptable within the magnolia_ui project? (ui-theme packaged as war)
- We start theme again, picking minimal rules from the existing CSS into new SASS stylesheets
- We inherit the base theme
- We start with standard vaadin fields
- Then we try to give proper Magnolia themeing to other standard vaadin widgets, e.g. error messages, loading indicators
- Maybe we can cleanup our widgets a bit
Decision
-
2. Project structure and Widgetset
Problem
- It is hard to relate widget java classes - where style names are set - to their actual CSS rules
- All stylesheets even for widgets are in the theme directory, which is not necessarly bad but should be reviewed
- We want these styles to remain dynamically loaded (not processed at GWT compilation time) so that it's easy to develop them
- We need to review the pattern for applying desktop vs. tablet styles as well
- Package structure of the common-widgets project could be clearer
- Naming of widget classes is inconsistent
- Reevaluate usage of "v-" prefix in style names for magnolia widgets, this is not consistent right now
- As Sasha pointed out, there may also be room for Optimizing the WidgetSet
Proposal
- We align on vaadin7 package structure (client/server/shared)
- We align naming of widget classes
- we try to use *Widget / *Connector consistently
- we drop client-side naming *View / *ViewImpl
- we leave the v- prefix for standard vaadin component style names, we use m- prefix for magnolia widget styles
- we don't use any prefix for application views
- We add the magnolia-ui-theme project
- we start taking vaadin field styles from widgetset to here, using properly modularized SASS files
- We try to draw a meaningful separation for "shell-only" widgets
Decision
-
3. Extensibility
Problem
- An app developers cannot define styles for her own app in its own module
- It is not clearly specified how an app developer would add a custom widget to her app
- There is no guideline either on how an app developer would add her own icons for her app and actions
Proposal
- We cannot use
@Theme
annotation for third party apps because theme is set on admincentral - We use CSSInject to dynamically load an
@import
rule which references a CSS stylesheet- optionally we try to reference a SASS one
Decision
-
Suggestion box
- The magnolia theme application could ultimately switch between expected screenshot and actual fields, to help on browser support
- Structure (base directory magnolia_ui):
- magnolia-ui-admincentral
- @Theme("admincentral")
AdminCentralUI - themes
- admincentral
- include magnolia
- admincentral
- @Theme("admincentral")
- magnolia-ui-theme
- @Theme("magnolia-theme-ui")
MagnoliaThemeUI - themes
- magnolia
- include base
- include magnolia-widgets-base
- magnolia-theme-ui
- include magnolia
- magnolia
- @Theme("magnolia-theme-ui")
- magnolia-ui-widgetset
- themes
- magnolia-widgets-base
- themes
- magnolia-ui-admincentral
Overview
Content Tools