govuk_tech_docs 3.2.1 → 3.3.0

data/node_modules/govuk-frontend/govuk/overrides/_spacing.scss

@@ -2,6 +2,8 @@
 /// @group overrides
 ////
 
+// stylelint-disable declaration-no-important
+
 /// Directions for spacing
 ///
 /// @type Map
@@ -14,25 +16,27 @@ $_spacing-directions: (
   "left"
 ) !default;
 
-/// Spacing override classes
+/// Generate responsive spacing override classes
 ///
 /// Generate spacing override classes for the given property (e.g. margin)
-/// for each point in the spacing scale.
+/// for each point in the responsive spacing scale.
 ///
 /// @param {String} $property - Property to add spacing to (e.g. 'margin')
 ///
-/// @example scss
-///   .govuk-\!-margin-0 {
-///      margin: 0;
-///   }
+/// @example css
+///  .govuk-\!-margin-4 {
+///    margin: 15px !important;
+///  }
 ///
-///  .govuk-\!-margin-top-1 {
-///     margin-top: [whatever spacing point 1 is...]
-///   }
+///  @media (min-width: 40.0625em) {
+///    .govuk-\!-margin-4 {
+///      margin: 20px !important;
+///    }
+///  }
 ///
 /// @access private
 
-@mixin _govuk-generate-spacing-overrides($property) {
+@mixin _govuk-generate-responsive-spacing-overrides($property) {
   // For each point in the spacing scale (defined in settings), create an
   // override that affects all directions...
   @each $scale-point, $scale-map in $govuk-spacing-responsive-scale {
@@ -52,7 +56,47 @@ $_spacing-directions: (
   }
 }
 
+/// Generate static spacing override classes
+///
+/// Generate spacing override classes for the given property (e.g. margin)
+/// for each point in the non-responsive spacing scale.
+///
+/// The classes in the format govuk-#{$property}-static-#{$spacing-point}
+/// and govuk-\!-#{$property}-#{$direction}-static-#{$spacing-point} are deprecated.
+/// For example: govuk-!-margin-static-2 or govuk-!-margin-top-static-2
+///
+/// Use classes in the format .govuk-\!-static-#{$property}-#{$spacing-point}
+/// and .govuk-\!-static-#{$property}-#{$direction}-#{$spacing-point} instead.
+/// For example: govuk-!-static-margin-2 or govuk-!-static-margin-top-2
+///
+/// @param {String} $property - Property to add spacing to (e.g. 'margin')
+///
+/// @example css
+///   .govuk-\!-static-margin-4 {
+///      margin: 20px !important;
+///   }
+///
+/// @access private
+@mixin _govuk-generate-static-spacing-overrides($property) {
+  @each $spacing-point in map-keys($govuk-spacing-points) {
+    .govuk-\!-#{$property}-static-#{$spacing-point},
+    .govuk-\!-static-#{$property}-#{$spacing-point} {
+      #{$property}: govuk-spacing($spacing-point) !important;
+    }
+
+    @each $direction in $_spacing-directions {
+      .govuk-\!-#{$property}-#{$direction}-static-#{$spacing-point},
+      .govuk-\!-static-#{$property}-#{$direction}-#{$spacing-point} {
+        #{$property}-#{$direction}: govuk-spacing($spacing-point) !important;
+      }
+    }
+  }
+}
+
 @include govuk-exports("govuk/overrides/spacing") {
-  @include _govuk-generate-spacing-overrides("margin");
-  @include _govuk-generate-spacing-overrides("padding");
+  @include _govuk-generate-responsive-spacing-overrides("margin");
+  @include _govuk-generate-responsive-spacing-overrides("padding");
+
+  @include _govuk-generate-static-spacing-overrides("margin");
+  @include _govuk-generate-static-spacing-overrides("padding");
 }

data/node_modules/govuk-frontend/govuk/settings/_all.scss

@@ -3,6 +3,7 @@
 
 @import "assets";
 
+@import "warnings";
 @import "compatibility";
 @import "global-styles";
 @import "ie8";

data/node_modules/govuk-frontend/govuk/settings/_colours-palette.scss

@@ -15,6 +15,8 @@
 ///
 /// @type Boolean
 /// @access public
+/// @deprecated Will be removed in v5.0 with the rest of the compatibility mode
+/// suite of tools and settings
 
 $govuk-use-legacy-palette: if(
   (
@@ -26,6 +28,16 @@ $govuk-use-legacy-palette: if(
   false
 ) !default;
 
+// Only show the deprecation warning if user is setting $govuk-use-legacy-palette
+// manually instead of automatically via compatibility variables
+@if $govuk-use-legacy-palette == true and
+  $govuk-compatibility-govukfrontendtoolkit == false and
+  $govuk-compatibility-govuktemplate == false and
+  $govuk-compatibility-govukelements == false {
+  @include _warning(legacy-palette, "$govuk-use-legacy-palette is deprecated. " +
+  "Only the modern colour palette will be supported from v5.0.");
+}
+
 /// Modern colour palette
 ///
 /// This exists only because you cannot easily set a !default variable

data/node_modules/govuk-frontend/govuk/settings/_compatibility.scss

@@ -23,9 +23,17 @@
 ///
 /// @type Boolean
 /// @access public
+/// @deprecated Will be removed in v5.0 with the rest of the compatibility mode
+/// suite of tools and settings
 
 $govuk-compatibility-govukfrontendtoolkit: false !default;
 
+@if $govuk-compatibility-govukfrontendtoolkit == true {
+  @include _warning("compatibility-mode", "$govuk-compatibility-govukfrontendtoolkit " +
+  "is deprecated. From version 5.0, GOV.UK Frontend will remove compatibility " +
+  "with the legacy library govuk_frontend_toolkit.");
+}
+
 /// Compatibility Mode: alphagov/govuk_template
 ///
 /// Enabling this will:
@@ -41,9 +49,17 @@ $govuk-compatibility-govukfrontendtoolkit: false !default;
 ///
 /// @type Boolean
 /// @access public
+/// @deprecated Will be removed in v5.0 with the rest of the compatibility mode
+/// suite of tools and settings
 
 $govuk-compatibility-govuktemplate: false !default;
 
+@if $govuk-compatibility-govuktemplate == true {
+  @include _warning("compatibility-mode", "$govuk-compatibility-govuktemplate " +
+  "is deprecated. From version 5.0, GOV.UK Frontend will remove " +
+  "compatibility with the legacy library govuk_template.");
+}
+
 /// Compatibility Mode: alphagov/govuk_elements
 ///
 /// Enabling this will:
@@ -56,9 +72,17 @@ $govuk-compatibility-govuktemplate: false !default;
 ///
 /// @type Boolean
 /// @access public
+/// @deprecated Will be removed in v5.0 with the rest of the compatibility mode
+/// suite of tools and settings
 
 $govuk-compatibility-govukelements: false !default;
 
+@if $govuk-compatibility-govukelements == true {
+  @include _warning("compatibility-mode", "$govuk-compatibility-govukelements " +
+  "is deprecated. From version 5.0, GOV.UK Frontend will remove compatibility " +
+  "with the legacy library govuk_elements.");
+}
+
 /// Compatibility Product Map
 ///
 /// Maps product names to their settings that we can use to lookup states from
@@ -66,6 +90,8 @@ $govuk-compatibility-govukelements: false !default;
 ///
 /// @type Map
 /// @access private
+/// @deprecated Will be removed in v5.0 with the rest of the compatibility mode
+/// suite of tools and settings
 
 $_govuk-compatibility: (
   govuk_frontend_toolkit: $govuk-compatibility-govukfrontendtoolkit,

data/node_modules/govuk-frontend/govuk/settings/_spacing.scss

@@ -38,20 +38,16 @@ $govuk-spacing-points: (
 
 $govuk-spacing-responsive-scale: (
   0: (
-    null: 0,
-    tablet: 0
+    null: 0
   ),
   1: (
-    null: 5px,
-    tablet: 5px
+    null: 5px
   ),
   2: (
-    null: 10px,
-    tablet: 10px
+    null: 10px
   ),
   3: (
-    null: 15px,
-    tablet: 15px
+    null: 15px
   ),
   4: (
     null: 15px,

data/node_modules/govuk-frontend/govuk/settings/_typography-font.scss

@@ -13,6 +13,8 @@
 ///
 /// @type Boolean
 /// @access public
+/// @deprecated Will be removed in v5.0 with the rest of the compatibility mode
+/// suite of tools and settings
 
 $govuk-use-legacy-font: if(
   (
@@ -24,6 +26,17 @@ $govuk-use-legacy-font: if(
   false
 ) !default;
 
+// Only show the deprecation warning if user is setting $govuk-use-legacy-font
+// manually instead of automatically via compatibility variables
+@if $govuk-use-legacy-font == true and
+  $govuk-compatibility-govukfrontendtoolkit == false and
+  $govuk-compatibility-govuktemplate == false and
+  $govuk-compatibility-govukelements == false {
+  @include _warning(legacy-font, "$govuk-use-legacy-font is deprecated. " +
+  "From version 5.0, GOV.UK Frontend will only support the included version " +
+  "of GDS Transport.");
+}
+
 // =========================================================
 // Font families
 // =========================================================
@@ -43,6 +56,8 @@ $govuk-font-family: if(
 ///
 /// @type List
 /// @access public
+/// @deprecated Will be removed in v5.0 with the rest of the compatibility mode
+/// suite of tools and settings
 
 $govuk-font-family-tabular: if(
   $govuk-use-legacy-font,
@@ -50,6 +65,14 @@ $govuk-font-family-tabular: if(
   false
 ) !default;
 
+// Only show the deprecation warning if user is setting $govuk-font-family-tabular
+// manually instead of automatically via $govuk-use-legacy-font
+@if $govuk-font-family-tabular != false and $govuk-use-legacy-font == false {
+  @include _warning(tabular-font-face, "$govuk-font-family-tabular is deprecated. " +
+  "From version 5.0, GOV.UK Frontend will not support using a separate " +
+  "font-face for tabular numbers.");
+}
+
 /// Font families to use for print media
 ///
 /// We recommend that you use system fonts when printing. This will avoid issues

data/node_modules/govuk-frontend/govuk/settings/_typography-responsive.scss

@@ -13,6 +13,8 @@
 ///
 /// @type Boolean
 /// @access public
+/// @deprecated Will be removed in v5.0 with the rest of the compatibility mode
+/// suite of tools and settings
 
 $govuk-typography-use-rem: if(
   (
@@ -24,6 +26,16 @@ $govuk-typography-use-rem: if(
   true
 ) !default;
 
+// Only show the deprecation warning if user is setting $govuk-typography-use-rem
+// manually instead of automatically via compatibility variables
+@if $govuk-typography-use-rem == false and
+  $govuk-compatibility-govukfrontendtoolkit == false and
+  $govuk-compatibility-govuktemplate == false and
+  $govuk-compatibility-govukelements == false {
+  @include _warning(allow-not-using-rem, "$govuk-typography-use-rem is deprecated. " +
+  "From version 5.0, GOV.UK Frontend will not support disabling rem font sizes.");
+}
+
 /// Root font size
 ///
 /// This is used to calculate rem sizes for the typography, and should match the

data/node_modules/govuk-frontend/govuk/settings/_warnings.scss

@@ -0,0 +1,53 @@
+////
+/// @group settings/warnings
+////
+
+/// Suppressed warnings map
+///
+/// This map is used to determine which deprecation warnings to **not** show
+/// to users when compiling sass. This is in place for codebases that do not
+/// have the necessary capacity to upgrade and remove the deprecation,
+/// particularly if the deprecation is significant. For example, removal of
+/// compatibility with legacy libraries such as govuk_elements.
+///
+/// You can add to this map and define which warnings to suppress by appending to
+/// it using the warning key, found in the warning message. For example:
+///
+/// @example scss:
+///   // warning message:
+///   //  $foobar is no longer supported. To silence this warning, update
+///   //  $govuk-suppressed-warnings with key: "foobar"
+///   $govuk-suppressed-warnings: (
+///     foobar
+///   );
+///
+/// @type List
+/// @access public
+
+$govuk-suppressed-warnings: () !default;
+
+/// Warnings
+///
+/// Acts as a wrapper for the built in `@warn` sass function
+///
+/// We use this instead of using `@warn` for 3 reasons:
+///
+/// - To check if a warning is being suppressed through `$govuk-suppressed-warnings`,
+/// in which case we don't call `@warn` and printing the warning to the user
+/// - To format the passed warning `$message` with the warning key at the end
+/// - To prevent duplicate warnings by adding the passed `$key` to
+/// `$govuk-suppressed-warnings` after `@warn` is called to ensure it only runs
+/// once per sass compilation
+///
+/// @param {String} $key - The key to be checked against `$govuk-suppressed-warnings`
+/// and then passed to it to prevent multiple of the same warning.
+/// @param {String} $message - The message to use when calling `@warn`
+/// @access private
+
+@mixin _warning($key, $message) {
+  @if not index($govuk-suppressed-warnings, $key) {
+    @warn $message + " To silence this warning, update $govuk-suppressed-warnings " +
+      "with key: \"#{$key}\"";
+    $govuk-suppressed-warnings: append($govuk-suppressed-warnings, $key) !global;
+  }
+}

data/node_modules/govuk-frontend/govuk/tools/_compatibility.scss

@@ -2,6 +2,20 @@
 /// @group tools/compatibility-mode
 ////
 
+/// Temporary private version of govuk-compatibility to avoid deprecation warnings
+///
+/// @access private
+
+@mixin _govuk-compatibility($product) {
+  @if map-has-key($_govuk-compatibility, $product) {
+    @if map-get($_govuk-compatibility, $product) == true {
+      @content;
+    }
+  } @else {
+    @error "Non existent product '#{$product}'";
+  }
+}
+
 /// Conditional Compatibility Mixin
 ///
 /// Selectively output a block (available to the mixin as @content) if a given
@@ -24,13 +38,13 @@
 ///   this product
 /// @throw Errors if product name is not recognised
 /// @access public
+/// @deprecated Will be removed in v5.0 with the rest of the compatibility mode
+/// suite of tools and settings
 
 @mixin govuk-compatibility($product) {
-  @if map-has-key($_govuk-compatibility, $product) {
-    @if map-get($_govuk-compatibility, $product) == true {
-      @content;
-    }
-  } @else {
-    @error "Non existent product '#{$product}'";
+  @include _warning(compatibility-helper, "govuk-compatibility is deprecated. " +
+  "From version 5.0, GOV.UK Frontend will not support compatibility mode.");
+  @include _govuk-compatibility($product) {
+    @content;
   }
 }

data/node_modules/govuk-frontend/govuk/tools/_exports.scss

@@ -22,7 +22,7 @@ $_govuk-imported-modules: () !default;
 
 @mixin govuk-exports($name) {
   // If the mixin is not in the list of modules already exported...
-  @if (index($_govuk-imported-modules, $name) == null) {
+  @if not index($_govuk-imported-modules, $name) {
     // ... then add it to the list
     $_govuk-imported-modules: append($_govuk-imported-modules, $name) !global;
     // ... and output the CSS for that module

data/node_modules/govuk-frontend/govuk/tools/_font-url.scss

@@ -17,7 +17,7 @@
     and $govuk-font-url-function
     and function-exists($govuk-font-url-function);
 
-  @if ($use-custom-function) {
+  @if $use-custom-function {
     @return call(get-function($govuk-font-url-function), $filename);
   } @else {
     @return url($govuk-fonts-path + $filename);

data/node_modules/govuk-frontend/govuk/tools/_image-url.scss

@@ -17,7 +17,7 @@
     and $govuk-image-url-function
     and function-exists($govuk-image-url-function);
 
-  @if ($use-custom-function) {
+  @if $use-custom-function {
     @return call(get-function($govuk-image-url-function), $filename);
   } @else {
     @return url($govuk-images-path + $filename);

data/node_modules/govuk-frontend/govuk/tools/_px-to-em.scss

@@ -10,10 +10,10 @@
 /// @access public
 
 @function govuk-em($value, $context-font-size) {
-  @if (unitless($value)) {
+  @if unitless($value) {
     $value: $value * 1px;
   }
-  @if (unitless($context-font-size)) {
+  @if unitless($context-font-size) {
     $context-font-size: $context-font-size * 1px;
   }
   @return $value / $context-font-size * 1em;

data/node_modules/govuk-frontend/govuk/tools/_px-to-rem.scss

@@ -12,7 +12,7 @@
 /// @access public
 
 @function govuk-px-to-rem($value) {
-  @if (unitless($value)) {
+  @if unitless($value) {
     $value: $value * 1px;
   }
 

data/node_modules/govuk-frontend/govuk/vendor/polyfills/Date/now.js

@@ -0,0 +1,21 @@
+(function (global, factory) {
+	typeof exports === 'object' && typeof module !== 'undefined' ? factory() :
+	typeof define === 'function' && define.amd ? define('GOVUKFrontend', factory) :
+	(factory());
+}(this, (function () { 'use strict';
+
+(function(undefined) {
+
+    // Detection from https://github.com/Financial-Times/polyfill-library/blob/v3.111.0/polyfills/Date/now/detect.js
+    var detect = ('Date' in self && 'now' in self.Date && 'getTime' in self.Date.prototype);
+
+    if (detect) return
+
+    // Polyfill from https://polyfill.io/v3/polyfill.js?version=3.111.0&features=Date.now&flags=always
+    Date.now = function () {
+        return new Date().getTime();
+    };
+
+}).call('object' === typeof window && window || 'object' === typeof self && self || 'object' === typeof global && global || {});
+
+})));