@justeat/fozzie-colour-palette - npm Package Compare versions

Comparing version 1.4.0 to 2.0.0

CHANGELOG.md

@@ -7,2 +7,12 @@ # Changelog
 
+v2.0.0
+------------------------------
+*Sept 7, 2018*
+
+### Changed
+- Menulog theming updated (breaking change).
+  The Menulog colours are now specified as a mixin that is called as part of individual modules if the $theme variable is set to 'ml'.  This is so that each project importing fozzie modules only has to specify the theme variable once and each module will take care of it's own colour/variable overrides.
+- Menulog Colour Scheme has been updated in line with the global UI palette provided by AU design team.
+
+
 v1.4.0
@@ -9,0 +19,0 @@ ------------------------------

package.json

 {
   "name": "@justeat/fozzie-colour-palette",
   "description": "Brand colour palette for projects at Just Eat",
-  "version": "1.4.0",
+  "version": "2.0.0",
   "files": [
@@ -21,4 +21,4 @@ "src"
   "devDependencies": {
-    "@justeat/gulp-build-fozzie": "^7.19.0",
-    "danger": "^3.7.18"
+    "@justeat/gulp-build-fozzie": "^7.26.0",
+    "danger": "^3.9.0"
   },
@@ -25,0 +25,0 @@ "scripts": {

readme.md

@@ -36,1 +36,42 @@ # Fozzie Colour Palette
 It’s recommended that you hook onto and use the variable abstractions such as `$color-text` and `$color-link-default` where it makes sense to, rather than directly onto the colour variables.  That way your project will require less re-factoring should the colour palette ever get a major overhaul in the future and certain colours get replaced and/or renamed.
+
+
+## Available Colour Schemes
+
+The `fozzie-colour-palette` allows for the definition of platform specific colour schemes.  The colour schemes currently available are:
+
+### Just Eat Default Colour Scheme
+
+To apply the default Just Eat colour scheme, simply import this module like so:
+
+```scss
+  @import 'fozzie-colour-palette';
+```
+
+If you are already importing the [base `fozzie` module](https://www.npmjs.com/package/@justeat/fozzie) there will be no need to import `fozzie-colour-palette` as this is baked in by default to that module.  The default colour scheme will therefore automatically be setup when importing the base `fozzie` module.
+
+
+###  Menulog Colour Scheme
+
+To apply the Menulog colour palette, you need to import the default colour scheme, and then call the `applyScheme-menulog` mixin, which provides a set of theme overrides.
+
+To do this, define a `$theme` variable  and set it to `'ml'`.  Then conditionally call the Menulog colour scheme mixin:
+
+```scss
+  $theme: 'ml';
+
+  @import 'fozzie-colour-palette';
+
+  @if ($theme == 'ml') {
+      @include applyScheme-menulog;
+  }
+```
+
+If you are using the base `fozzie` module, simply setting the `$theme: 'ml';` before importing the `fozzie` module will automatically take care of this step for you:
+
+```scss
+  $theme: 'ml';
+
+  @import 'fozzie'; // this will now load in the fozzie-colour-palette module with Menulog overrides
+```
+

No alert changes

Improved metrics

Total package byte prevSize

14755

increased by0.94%

Number of lines in readme file

77

increased by113.89%

No dependency changes