From 77402a4efc4c8b3fbb146dbef57dfbebae709017 Mon Sep 17 00:00:00 2001 From: qsm-odoo Date: Thu, 30 Aug 2018 10:37:30 +0200 Subject: [PATCH] [REF] web_editor, *: review color theming system * web, website - Introduce gray color palettes (needed for themes migration) - Synchronize BS4 color maps with individual variables (see comments about this in the code). - Review alpha/primary, beta/secondary matching: Before this commit, we decided that the common way to define a color palette was defining primary, secondary, gamma, delta and epsilon. alpha and beta were then forced to primary and secondary without other possibility. The new system makes more sense: 1) define alpha, beta, gamma, delta and epsilon 2) primary and secondary will automatically be set to your alpha and beta (allowing to style the default UI with BS4-independant variables) 3) if you are not happy with (2), you can define primary / secondary in your color palette so that they are not automatically set to alpha / beta This commit also changes what classes the editor uses. Background colors and text colors will now use alpha/beta/gamma/delta/epsilon (not primary and secondary anymore). For buttons, all the possibilities are suggested but color duplicates are hidden (so if your primary and alpha are equal, only one button color is suggested). --- .../scss/bootstrap_overridden_frontend.scss | 3 - .../static/src/js/widgets/widgets.js | 17 +++- .../static/src/scss/bootstrap_overridden.scss | 77 +++++++++++++++---- .../scss/bootstrap_overridden_backend.scss | 4 - .../static/src/scss/web_editor.variables.scss | 12 ++- addons/web_editor/static/src/xml/editor.xml | 2 +- addons/web_editor/views/editor.xml | 5 +- .../website/static/src/js/tours/customize.js | 2 +- addons/website/static/src/js/widgets/theme.js | 32 +++++++- .../colors/user_theme_color_palette.scss | 11 ++- .../static/src/scss/secondary_variables.scss | 14 ++-- .../website/static/src/xml/website.editor.xml | 4 +- 12 files changed, 137 insertions(+), 46 deletions(-) delete mode 100644 addons/web_editor/static/src/scss/bootstrap_overridden_backend.scss diff --git a/addons/web/static/src/scss/bootstrap_overridden_frontend.scss b/addons/web/static/src/scss/bootstrap_overridden_frontend.scss index 19ced6c9d8f..e69de29bb2d 100644 --- a/addons/web/static/src/scss/bootstrap_overridden_frontend.scss +++ b/addons/web/static/src/scss/bootstrap_overridden_frontend.scss @@ -1,3 +0,0 @@ - -$black: black; -$white: white; diff --git a/addons/web_editor/static/src/js/widgets/widgets.js b/addons/web_editor/static/src/js/widgets/widgets.js index 7b02703260b..3ccba2da261 100644 --- a/addons/web_editor/static/src/js/widgets/widgets.js +++ b/addons/web_editor/static/src/js/widgets/widgets.js @@ -1164,7 +1164,7 @@ var MediaDialog = Dialog.extend({ self.$media = self.$media.parent(); self.media = self.$media[0]; tabToShow = 'video'; - } + } self.$('[href="#editor-media-' + tabToShow + '"]').tab('show'); }); @@ -1457,6 +1457,21 @@ var LinkDialog = Dialog.extend({ this.$('input[name="url"]').val(match ? match[1] : this.data.url); } + // Hide the duplicate color buttons (most of the times, primary = alpha + // and secondary = beta for example but this may depend on the theme) + this.opened().then(function () { + var colors = []; + _.each(self.$('.o_btn_preview'), function (btn) { + var $btn = $(btn); + var color = $btn.css('background-color'); + if (_.contains(colors, color)) { + $btn.remove(); + } else { + colors.push(color); + } + }); + }); + this._adaptPreview(); this.$('input:visible:first').focus(); diff --git a/addons/web_editor/static/src/scss/bootstrap_overridden.scss b/addons/web_editor/static/src/scss/bootstrap_overridden.scss index 15309f4de7f..2a0b900b10c 100644 --- a/addons/web_editor/static/src/scss/bootstrap_overridden.scss +++ b/addons/web_editor/static/src/scss/bootstrap_overridden.scss @@ -1,3 +1,5 @@ +// Hacky way to detect if its the backend or not +$-is-backend: variable-exists('primary'); // Automatically update bootstrap colors map (unused by BS itself) $-palette: nth($o-color-palettes, $o-color-palette-number); @@ -6,28 +8,75 @@ $colors: map-merge($-palette, $colors); // Automatically extend bootstrap to create theme background/text/button classes $-palette: nth($o-theme-color-palettes, $o-theme-color-palette-number); -$-main-color: map-get($-palette, 'primary'); +$-main-color: map-get($-palette, 'alpha'); $-main-color-lightness: lightness($-main-color); -$-palette: map-merge($-palette, ( - // Compatibility: alpha and beta color exist but will now always be - // equal to primary and secondary colors - alpha: $-main-color, - beta: map-get($-palette, 'secondary'), +$-palette: map-merge(( + // alpha and beta colors are used to override primary and secondary BS4 + // colors by default, so that theme colors affect the default Odoo layouts + primary: $-main-color, + secondary: map-get($-palette, 'beta'), // BS light and dark colors are not used for any BS component, just // for color utilities. By default, we set them to a very light and - // very dark version of a desaturate version of the primary color + // very dark version of a desaturate version of the primary color light: lighten(desaturate($-main-color, 40%), min(70%, max(0%, 97% - $-main-color-lightness))), // Does not increase over 97% lightness dark: darken(desaturate($-main-color, 40%), min(70%, max(0%, $-main-color-lightness - 10%))), // Does not lower under 10% lightness -)); +), $-palette); +@if $-is-backend { + $-palette: map-remove($-palette, 'primary', 'secondary', 'success', 'info', 'warning', 'danger', 'light', 'dark'); +} $theme-colors: () !default; $theme-colors: map-merge($-palette, $theme-colors); // Extend grays with transparent ones (for some reason, BS4 create black-50 and -// white-50 but does not allow overridding that with variables). Also add black -// and white ones too as they were also not added by BS4... +// white-50 but does not allow overridding that with variables), also use the +// theme gray palette (which is supposed to at least declare white and black). +$-palette: nth($o-gray-color-palettes, $o-gray-color-palette-number); +$-palette: map-merge($o-transparent-grays, $-palette); +@if $-is-backend { + $-palette: map-remove($-palette, '100', '200', '300', '400', '500', '600', '700', '800', '900'); +} $grays: () !default; -$grays: map-merge(map-merge($o-transparent-grays, ( - black: $black, // Note: those two needs to be redefined before bootstrap, - white: $white, // otherwise they do not exist yet -)), $grays); +$grays: map-merge($-palette, $grays); + +// Bootstrap use standard variables to define individual colors which are then +// placed into a map which is then used to get the value of each individual +// color. As BS4 allows to extend the map a priori to define our own colors, +// it does not take care of making the standard variables match the values in +// the user's map. The problem is that, at least for grays, bootstrap uses the +// standard variables in its _variables.scss file, so if: +// +// User file: +// $grays: ( +// '100': blue, +// ); +// +// BS4: +// $gray-100: gray !default; +// $grays: () !default; +// $grays: map-merge(( +// '100': $gray-100, +// ), $grays); +// +// -> Here gray('100') is blue but $gray-100 is still gray... so BS4 is not +// correctly generated as BS4 uses $gray-100 in _variables.scss +$primary: theme-color('primary') !default; +$secondary: theme-color('secondary') !default; +$success: theme-color('success') !default; +$info: theme-color('info') !default; +$warning: theme-color('warning') !default; +$danger: theme-color('danger') !default; +$light: theme-color('light') !default; +$dark: theme-color('dark') !default; + +$white: gray('white') !default; +$gray-100: gray('100') !default; +$gray-200: gray('200') !default; +$gray-300: gray('300') !default; +$gray-400: gray('400') !default; +$gray-500: gray('500') !default; +$gray-600: gray('600') !default; +$gray-700: gray('700') !default; +$gray-800: gray('800') !default; +$gray-900: gray('900') !default; +$black: gray('black') !default; diff --git a/addons/web_editor/static/src/scss/bootstrap_overridden_backend.scss b/addons/web_editor/static/src/scss/bootstrap_overridden_backend.scss deleted file mode 100644 index 114d49c8dd4..00000000000 --- a/addons/web_editor/static/src/scss/bootstrap_overridden_backend.scss +++ /dev/null @@ -1,4 +0,0 @@ - -// Hacky way to prevent our web_editor/website themes to affect the backend UI but -// still allow to define extra colors for backend HTML editors -$theme-colors: map-remove($theme-colors, 'primary', 'secondary', 'success', 'info', 'warning', 'danger', 'light', 'dark'); diff --git a/addons/web_editor/static/src/scss/web_editor.variables.scss b/addons/web_editor/static/src/scss/web_editor.variables.scss index eff996bea20..730041fbb5f 100644 --- a/addons/web_editor/static/src/scss/web_editor.variables.scss +++ b/addons/web_editor/static/src/scss/web_editor.variables.scss @@ -230,8 +230,8 @@ $o-color-palette-number: 1; // Theme colors $o-theme-color-palettes: ( ( - primary: $o-enterprise-primary-color, - secondary: $o-enterprise-color, + alpha: $o-enterprise-primary-color, + beta: $o-enterprise-color, gamma: #5C5B80, delta: #5B899E, epsilon: #E46F78, @@ -248,7 +248,13 @@ $o-transparent-grays: ( white-50: rgba(white, 0.5), white-75: rgba(white, 0.75), ) !default; - +$o-gray-color-palettes: ( + ( + 'white': #FFFFFF, // Those two will enforce the creation of bg-white + 'black': #000000, // and bg-black classes. + ), +) !default; +$o-gray-color-palette-number: 1; // Translations $o-we-content-to-translate-color: rgb(255, 255, 90) !default; diff --git a/addons/web_editor/static/src/xml/editor.xml b/addons/web_editor/static/src/xml/editor.xml index b3d1763ca71..fe51450dac9 100644 --- a/addons/web_editor/static/src/xml/editor.xml +++ b/addons/web_editor/static/src/xml/editor.xml @@ -278,7 +278,7 @@ - +