defra_ruby_template 5.11.1 → 6.4.0

data/vendor/assets/stylesheets/settings/_typography-font.scss

@@ -1,6 +1,8 @@
 ////
 /// @group settings/typography
 ////
+@use "sass:list";
+@use "sass:meta";
 
 // =========================================================
 // Font families
@@ -31,7 +33,7 @@ $govuk-font-family-print: sans-serif !default;
 /// @type Boolean
 /// @access public
 
-$govuk-include-default-font-face: if(index($govuk-font-family, "GDS Transport"), true, false) !default;
+$govuk-include-default-font-face: (list.index($govuk-font-family, "GDS Transport") != null) !default;
 
 // =========================================================
 // Font weights
@@ -49,4 +51,3 @@ $govuk-font-weight-regular: 400 !default;
 /// @access public
 $govuk-font-weight-bold: 700 !default;
 
-/*# sourceMappingURL=_typography-font.scss.map */

data/vendor/assets/stylesheets/settings/_typography-responsive.import.scss

@@ -0,0 +1,2 @@
+@forward "typography-responsive";
+

data/vendor/assets/stylesheets/settings/_typography-responsive.scss

@@ -16,151 +16,20 @@
 
 $govuk-root-font-size: 16px !default;
 
-/// Feature flag for new typography scale
-///
-/// When set to true, $govuk-typography-scale will use the new font map instead
-/// of the current/old one as well as apply changes in components to account
-/// for the updated scale.
-///
-/// Should be removed in 6.0.
+/// Responsive typography font map
 ///
-/// @type Boolean
-/// @access public
-
-$govuk-new-typography-scale: false !default;
-
-/// The font map for the old typography scale
+/// This is used to generate responsive typography that adapts according to the
+/// breakpoints.
 ///
-/// @type Map
+/// Font size and font weight can be defined for each breakpoint. You can define
+/// different behaviour on tablet and desktop. The 'null' breakpoint is for
+/// mobile.
 ///
-/// @prop {Number} $point.$breakpoint.font-size - Font size for `$point` at `$breakpoint`
-/// @prop {Number} $point.$breakpoint.line-height - Line height for `$point` at `$breakpoint`
-/// @prop {Number} $point.print.font-size - Font size for `$point` when printing
-/// @prop {Number} $point.print.line-height - Line height for `$point` when printing
+/// Line-heights will automatically be converted from pixel measurements into
+/// relative values. For example, with a font-size of 16px and a line-height of
+/// 24px, the line-height will be converted to 1.5 before output.
 ///
-/// @access private
-
-$_govuk-typography-scale-legacy: (
-  80: (
-    null: (
-      font-size: 53px,
-      line-height: 55px
-    ),
-    tablet: (
-      font-size: 80px,
-      line-height: 80px
-    ),
-    print: (
-      font-size: 53pt,
-      line-height: 1.1
-    )
-  ),
-  48: (
-    null: (
-      font-size: 32px,
-      line-height: 35px
-    ),
-    tablet: (
-      font-size: 48px,
-      line-height: 50px
-    ),
-    print: (
-      font-size: 32pt,
-      line-height: 1.15
-    )
-  ),
-  36: (
-    null: (
-      font-size: 24px,
-      line-height: 25px
-    ),
-    tablet: (
-      font-size: 36px,
-      line-height: 40px
-    ),
-    print: (
-      font-size: 24pt,
-      line-height: 1.05
-    )
-  ),
-  27: (
-    null: (
-      font-size: 18px,
-      line-height: 20px
-    ),
-    tablet: (
-      font-size: 27px,
-      line-height: 30px
-    ),
-    print: (
-      font-size: 18pt,
-      line-height: 1.15
-    )
-  ),
-  24: (
-    null: (
-      font-size: 18px,
-      line-height: 20px
-    ),
-    tablet: (
-      font-size: 24px,
-      line-height: 30px
-    ),
-    print: (
-      font-size: 18pt,
-      line-height: 1.15
-    )
-  ),
-  19: (
-    null: (
-      font-size: 16px,
-      line-height: 20px
-    ),
-    tablet: (
-      font-size: 19px,
-      line-height: 25px
-    ),
-    print: (
-      font-size: 14pt,
-      line-height: 1.15
-    )
-  ),
-  16: (
-    null: (
-      font-size: 14px,
-      line-height: 16px
-    ),
-    tablet: (
-      font-size: 16px,
-      line-height: 20px
-    ),
-    print: (
-      font-size: 14pt,
-      line-height: 1.2
-    )
-  ),
-  14: (
-    null: (
-      font-size: 12px,
-      line-height: 15px
-    ),
-    tablet: (
-      font-size: 14px,
-      line-height: 20px
-    ),
-    print: (
-      font-size: 12pt,
-      line-height: 1.2
-    ),
-    deprecation: (
-      key: "govuk-typography-scale-14",
-      message: "14 on the type scale is deprecated and will be removed as " +
-        "a possible option in the next major version."
-    )
-  )
-);
-
-/// The font map for the new typography scale
+/// You can also specify a separate font size and line height for print media.
 ///
 /// @type Map
 ///
@@ -169,9 +38,9 @@ $_govuk-typography-scale-legacy: (
 /// @prop {Number} $point.print.font-size - Font size for `$point` when printing
 /// @prop {Number} $point.print.line-height - Line height for `$point` when printing
 ///
-/// @access private
+/// @access public
 
-$_govuk-typography-scale-modern: (
+$govuk-typography-scale: (
   80: (
     null: (
       font-size: 53px,
@@ -265,53 +134,6 @@ $_govuk-typography-scale-modern: (
       font-size: 14pt,
       line-height: 1.2
     )
-  ),
-  14: (
-    // Stay at 14/20 at all sizes (consider deprecating this size)
-    null: (
-        font-size: 14px,
-        line-height: 20px
-      ),
-    print: (
-      font-size: 12pt,
-      line-height: 1.2
-    ),
-    deprecation: (
-      key: "govuk-typography-scale-14",
-      message: "14 on the type scale is deprecated and will be removed as " +
-        "a possible option in the next major version."
-    )
   )
-);
-
-/// Responsive typography font map
-///
-/// This is used to generate responsive typography that adapts according to the
-/// breakpoints.
-///
-/// Font size and font weight can be defined for each breakpoint. You can define
-/// different behaviour on tablet and desktop. The 'null' breakpoint is for
-/// mobile.
-///
-/// Line-heights will automatically be converted from pixel measurements into
-/// relative values. For example, with a font-size of 16px and a line-height of
-/// 24px, the line-height will be converted to 1.5 before output.
-///
-/// You can also specify a separate font size and line height for print media.
-///
-/// @type Map
-///
-/// @prop {Number} $point.$breakpoint.font-size - Font size for `$point` at `$breakpoint`
-/// @prop {Number} $point.$breakpoint.line-height - Line height for `$point` at `$breakpoint`
-/// @prop {Number} $point.print.font-size - Font size for `$point` when printing
-/// @prop {Number} $point.print.line-height - Line height for `$point` when printing
-///
-/// @access public
-
-$govuk-typography-scale: if(
-  $govuk-new-typography-scale,
-  $_govuk-typography-scale-modern,
-  $_govuk-typography-scale-legacy
 ) !default;
 
-/*# sourceMappingURL=_typography-responsive.scss.map */

data/vendor/assets/stylesheets/settings/_warnings--internal.scss

@@ -0,0 +1,69 @@
+////
+/// @group settings.internal
+////
+
+@use "sass:list";
+
+@use "warnings" as *;
+
+/// 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 (unless $silence-further-warnings is false)
+///
+/// @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`
+/// @param {Boolean} $silence-further-warnings - Whether to silence future
+/// warnings that use the same $key
+/// @access private
+
+@mixin warning($key, $message, $silence-further-warnings: true) {
+  @if should-warn($key) {
+    @warn warning-text($key, $message);
+
+    @if $silence-further-warnings {
+      $govuk-suppressed-warnings: list.append($govuk-suppressed-warnings, $key) !global;
+    }
+  }
+}
+
+/// Logs a deprecation warning that the given component's `<COMPONENT_NAME>.scss` file is deprecated
+///
+/// @param {string} $component-name - The name of component, as it appears in the folder gathering its files
+/// @access private
+@mixin component-scss-file-warning($component-name) {
+  $component-path: "<PATH_TO_GOVUK_FRONTEND>/components/#{$component-name}";
+
+  $message: "Importing `#{$component-path}/#{$component-name}` is deprecated." + " Import `#{$component-path}` instead.";
+
+  @include warning("component-scss-files", $message, $silence-further-warnings: false);
+}
+
+/// Check whether a key is present in the suppressed warnings list.
+///
+/// @param {String} $key - The key to be checked against `$govuk-suppressed-warnings`.
+/// @access private
+
+@function should-warn($key) {
+  @return list.index($govuk-suppressed-warnings, $key) == null;
+}
+
+/// Format a warning by appending information on how to suppress it.
+///
+/// @param {String} $key - The key needed to suppress the warning.
+/// @param {String} $message - The warning text.
+/// @access private
+
+@function warning-text($key, $message) {
+  @return $message + " To silence this warning, update $govuk-suppressed-warnings " + 'with key: "#{$key}"';
+}
+

data/vendor/assets/stylesheets/settings/_warnings.import.scss

@@ -0,0 +1,2 @@
+@forward "warnings";
+

data/vendor/assets/stylesheets/settings/_warnings.scss

@@ -13,12 +13,15 @@
 /// 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
+/// @example scss Suppressing a warning message
+///
+///   // Prevent the following warning message to appear:
+///   // '$deprecated-feature is no longer supported. To silence this warning, update
+///   // $govuk-suppressed-warnings with key: "warning-key"'
+///   @use "node_modules/govuk-frontend/dist/govuk" as * with (
+///     $govuk-suppressed-warnings: (
+///       warning-key
+///     )
 ///   );
 ///
 /// @type List
@@ -26,53 +29,3 @@
 
 $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 (unless $silence-further-warnings is false)
-///
-/// @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`
-/// @param {Boolean} $silence-further-warnings - Whether to silence future
-/// warnings that use the same $key
-/// @access private
-
-@mixin _warning($key, $message, $silence-further-warnings: true) {
-  @if _should-warn($key) {
-    @warn _warning-text($key, $message);
-
-    @if $silence-further-warnings {
-      $govuk-suppressed-warnings: append($govuk-suppressed-warnings, $key) !global;
-    }
-  }
-}
-
-/// Check whether a key is present in the suppressed warnings list.
-///
-/// @param {String} $key - The key to be checked against `$govuk-suppressed-warnings`.
-/// @access private
-
-@function _should-warn($key) {
-  @return index($govuk-suppressed-warnings, $key) == null;
-}
-
-/// Format a warning by appending information on how to suppress it.
-///
-/// @param {String} $key - The key needed to suppress the warning.
-/// @param {String} $message - The warning text.
-/// @access private
-
-@function _warning-text($key, $message) {
-  @return $message + " To silence this warning, update $govuk-suppressed-warnings " + 'with key: "#{$key}"';
-}
-
-/*# sourceMappingURL=_warnings.scss.map */

data/vendor/assets/stylesheets/tools/_exports.import.scss

@@ -0,0 +1,2 @@
+@forward "exports";
+

data/vendor/assets/stylesheets/tools/_exports.scss

@@ -1,30 +1,37 @@
 ////
 /// @group tools
 ////
+@use "sass:list";
 
 /// List of modules which have already been exported
 ///
 /// @type List
 /// @access private
 
-$_govuk-imported-modules: () !default;
+$govuk-imported-modules: () !default;
 
 /// Export module
 ///
 /// Ensure that the modules of CSS that we define throughout Frontend are only
 /// included in the generated CSS once, no matter how many times they are
-/// imported across the individual components.
+/// imported across the individual components with `@import`.
+///
+/// If you include your stylesheets as Sass modules with `@use` or `@forward`
+/// Sass already ensures the CSS for the module is only output once without having
+/// to use `govuk-exports`.
+///
+/// `govuk-exports` can also prevent a mixin from outputting CSS multiple times.
 ///
 /// @param {String} $name - Name of module - must be unique within the codebase
 /// @content The passed content will only be outputted if a module of the same
-///   $name has not already been outputted
+///   $name has not already been outputted. Use only with `@import`, not `@use`.
 /// @access public
 
 @mixin govuk-exports($name) {
   // If the mixin is not in the list of modules already exported...
-  @if not index($_govuk-imported-modules, $name) {
+  @if not list.index($govuk-imported-modules, $name) {
     // ... then add it to the list
-    $_govuk-imported-modules: append($_govuk-imported-modules, $name) !global;
+    $govuk-imported-modules: list.append($govuk-imported-modules, $name) !global;
     // ... and output the CSS for that module
     @content;
   }
@@ -32,4 +39,3 @@ $_govuk-imported-modules: () !default;
   // found in the list and so nothing will be outputted.
 }
 
-/*# sourceMappingURL=_exports.scss.map */

data/vendor/assets/stylesheets/tools/_font-url.import.scss

@@ -0,0 +1,31 @@
+@use "sass:meta";
+
+// If `$govuk-font-url-function` or `$govuk-image-url-function` are configured as a string
+// we need to resolve them to a function in this import-only file. The file included by `@forward`
+// will be loaded as a module and will be isolated from the code that `@import`s this file
+// and where the function is available
+@forward "../settings" with (
+  $govuk-font-url-function: meta.variable-exists("govuk-font-url-function") and
+    (
+      (meta.type-of($govuk-font-url-function) == "string" and meta.get-function($govuk-font-url-function)) or
+        $govuk-font-url-function
+    ),
+  $govuk-image-url-function: meta.variable-exists("govuk-image-url-function") and
+    (
+      (meta.type-of($govuk-image-url-function) == "string" and meta.get-function($govuk-image-url-function)) or
+        $govuk-image-url-function
+    )
+);
+
+@forward "font-url";
+
+@use "../settings/warnings--internal";
+
+@if meta.variable-exists("govuk-font-url-function") and meta.type-of($govuk-font-url-function) == "string" {
+  @include warnings--internal.warning(
+    "font-url-string",
+    "Passing a string to $govuk-font-url-function is deprecated. " +
+      "Pass a function using meta.get-function(...) instead."
+  );
+}
+

data/vendor/assets/stylesheets/tools/_font-url.scss

@@ -1,6 +1,10 @@
 ////
 /// @group tools/assets
 ////
+@use "sass:meta";
+
+@use "../settings/warnings--internal";
+@use "../settings/assets" as *;
 
 /// Font URL
 ///
@@ -14,15 +18,27 @@
 
 @function govuk-font-url($filename) {
   // prettier-ignore
-  $use-custom-function: variable-exists("govuk-font-url-function")
-    and $govuk-font-url-function
-    and function-exists($govuk-font-url-function);
+  $custom-function: meta.variable-exists("govuk-font-url-function")
+    and $govuk-font-url-function;
+
+  @if meta.type-of($custom-function) == "string" {
+    @if warnings--internal.should-warn("font-url-string") {
+      @warn warnings--internal.warning-text("font-url-string",
+      "Passing a string to $govuk-font-url-function is deprecated. "
+          + "Pass a function using meta.get-function(...) instead.");
+    }
+
+    @if meta.function-exists($custom-function) {
+      $custom-function: meta.get-function($custom-function);
+    } @else {
+      $custom-function: null;
+    }
+  }
 
-  @if $use-custom-function {
-    @return call(get-function($govuk-font-url-function), $filename);
+  @if $custom-function {
+    @return meta.call($custom-function, $filename);
   } @else {
     @return url($govuk-fonts-path + $filename);
   }
 }
 
-/*# sourceMappingURL=_font-url.scss.map */

data/vendor/assets/stylesheets/tools/_if.import.scss

@@ -0,0 +1,2 @@
+@forward "if";
+

data/vendor/assets/stylesheets/tools/_if.scss

@@ -0,0 +1,23 @@
+////
+/// @group tools/if
+////
+
+/// Inline `if` function
+///
+/// Replicates the syntax of the original Sass `if` function
+/// to support Sass `>=1.79 <1.95`. Defaults `$if-false` to `null`
+/// when not set.
+///
+/// @param {Boolean} $condition - The condition
+/// @param {any} $if-true - The value if the condition is met
+/// @param {any} $if-false [null] - The value if the condition is not met, defaults to `null`.
+/// @returns {any} `$if-true` if the condition is met, `$if-false` otherwise.
+/// @access public
+@function govuk-if($condition, $if-true, $if-false: null) {
+  @if $condition {
+    @return $if-true;
+  } @else {
+    @return $if-false;
+  }
+}
+

data/vendor/assets/stylesheets/tools/_image-url.import.scss

@@ -0,0 +1,31 @@
+@use "sass:meta";
+
+// If `$govuk-font-url-function` or `$govuk-image-url-function` are configured as a string
+// we need to resolve them to a function in this import-only file. The file included by `@forward`
+// will be loaded as a module and will be isolated from the code that `@import`s this file
+// and where the function is available
+@forward "../settings" with (
+  $govuk-font-url-function: meta.variable-exists("govuk-font-url-function") and
+    (
+      (meta.type-of($govuk-font-url-function) == "string" and meta.get-function($govuk-font-url-function)) or
+        $govuk-font-url-function
+    ),
+  $govuk-image-url-function: meta.variable-exists("govuk-image-url-function") and
+    (
+      (meta.type-of($govuk-image-url-function) == "string" and meta.get-function($govuk-image-url-function)) or
+        $govuk-image-url-function
+    )
+);
+
+@forward "image-url";
+
+@use "../settings/warnings--internal";
+
+@if meta.variable-exists("govuk-image-url-function") and meta.type-of($govuk-image-url-function) == "string" {
+  @include warnings--internal.warning(
+    "image-url-string",
+    "Passing a string to $govuk-image-url-function is deprecated. " +
+      "Pass a function using meta.get-function(...) instead."
+  );
+}
+

data/vendor/assets/stylesheets/tools/_image-url.scss

@@ -1,6 +1,10 @@
 ////
 /// @group tools/assets
 ////
+@use "sass:meta";
+
+@use "../settings/warnings--internal";
+@use "../settings/assets" as *;
 
 /// Image URL
 ///
@@ -14,15 +18,27 @@
 
 @function govuk-image-url($filename) {
   // prettier-ignore
-  $use-custom-function: variable-exists("govuk-image-url-function")
-    and $govuk-image-url-function
-    and function-exists($govuk-image-url-function);
+  $custom-function: meta.variable-exists("govuk-image-url-function")
+    and $govuk-image-url-function;
+
+  @if meta.type-of($custom-function) == "string" {
+    @if warnings--internal.should-warn("image-url-string") {
+      @warn warnings--internal.warning-text("image-url-string",
+      "Passing a string to $govuk-image-url-function is deprecated. "
+          + "Pass a function using meta.get-function(...) instead.");
+    }
+
+    @if meta.function-exists($custom-function) {
+      $custom-function: meta.get-function($custom-function);
+    } @else {
+      $custom-function: null;
+    }
+  }
 
-  @if $use-custom-function {
-    @return call(get-function($govuk-image-url-function), $filename);
+  @if $custom-function {
+    @return meta.call($custom-function, $filename);
   } @else {
     @return url($govuk-images-path + $filename);
   }
 }
 
-/*# sourceMappingURL=_image-url.scss.map */

data/vendor/assets/stylesheets/tools/_index.import.scss

@@ -0,0 +1,2 @@
+@forward "index";
+

data/vendor/assets/stylesheets/tools/_index.scss

@@ -1,8 +1,7 @@
-@import "exports";
-@import "font-url";
-@import "image-url";
-@import "px-to-em";
-@import "px-to-rem";
-@import "rebrand";
+@forward "exports";
+@forward "font-url";
+@forward "if";
+@forward "image-url";
+@forward "px-to-em";
+@forward "px-to-rem";
 
-/*# sourceMappingURL=_index.scss.map */

data/vendor/assets/stylesheets/tools/_px-to-em.import.scss

@@ -0,0 +1,2 @@
+@forward "px-to-em";
+