govuk_tech_docs 6.3.0.beta → 6.4.0.beta

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

@@ -2,8 +2,7 @@
 /// @group settings/typography
 ////
 @use "sass:list";
-
-@import "../tools/if";
+@use "sass:meta";
 
 // =========================================================
 // Font families
@@ -34,7 +33,7 @@ $govuk-font-family-print: sans-serif !default;
 /// @type Boolean
 /// @access public
 
-$govuk-include-default-font-face: govuk-if(list.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
@@ -52,4 +51,3 @@ $govuk-font-weight-regular: 400 !default;
 /// @access public
 $govuk-font-weight-bold: 700 !default;
 
-/*# sourceMappingURL=_typography-font.scss.map */

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

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

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

@@ -137,4 +137,3 @@ $govuk-typography-scale: (
   )
 ) !default;
 
-/*# sourceMappingURL=_typography-responsive.scss.map */

data/node_modules/govuk-frontend/dist/govuk/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/node_modules/govuk-frontend/dist/govuk/settings/_warnings.import.scss

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

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

@@ -1,7 +1,6 @@
 ////
 /// @group settings/warnings
 ////
-@use "sass:list";
 
 /// Suppressed warnings map
 ///
@@ -14,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
@@ -27,65 +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: 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}"';
-}
-
-/*# sourceMappingURL=_warnings.scss.map */

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

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

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

@@ -8,24 +8,30 @@
 /// @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 list.index($_govuk-imported-modules, $name) {
+  @if not list.index($govuk-imported-modules, $name) {
     // ... then add it to the list
-    $_govuk-imported-modules: list.append($_govuk-imported-modules, $name) !global;
+    $govuk-imported-modules: list.append($govuk-imported-modules, $name) !global;
     // ... and output the CSS for that module
     @content;
   }
@@ -33,4 +39,3 @@ $_govuk-imported-modules: () !default;
   // found in the list and so nothing will be outputted.
 }
 
-/*# sourceMappingURL=_exports.scss.map */

data/node_modules/govuk-frontend/dist/govuk/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/node_modules/govuk-frontend/dist/govuk/tools/_font-url.scss

@@ -3,6 +3,9 @@
 ////
 @use "sass:meta";
 
+@use "../settings/warnings--internal";
+@use "../settings/assets" as *;
+
 /// Font URL
 ///
 /// If a custom font-url handler is defined ($govuk-font-url-function) then
@@ -19,6 +22,12 @@
     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 {
@@ -33,4 +42,3 @@
   }
 }
 
-/*# sourceMappingURL=_font-url.scss.map */

data/node_modules/govuk-frontend/dist/govuk/tools/_if.import.scss

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

data/node_modules/govuk-frontend/dist/govuk/tools/_if.scss

@@ -21,4 +21,3 @@
   }
 }
 
-/*# sourceMappingURL=_if.scss.map */

data/node_modules/govuk-frontend/dist/govuk/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/node_modules/govuk-frontend/dist/govuk/tools/_image-url.scss

@@ -3,6 +3,9 @@
 ////
 @use "sass:meta";
 
+@use "../settings/warnings--internal";
+@use "../settings/assets" as *;
+
 /// Image URL
 ///
 /// If a custom image-url handler is defined ($govuk-image-url-function) then
@@ -19,6 +22,12 @@
     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 {
@@ -33,4 +42,3 @@
   }
 }
 
-/*# sourceMappingURL=_image-url.scss.map */

data/node_modules/govuk-frontend/dist/govuk/tools/_index.import.scss

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

data/node_modules/govuk-frontend/dist/govuk/tools/_index.scss

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

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

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

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

@@ -4,7 +4,7 @@
 
 @use "sass:math";
 
-@import "../settings/typography-responsive";
+@use "../settings/typography-responsive" as *;
 
 /// Convert pixels to em
 ///
@@ -23,4 +23,3 @@
   @return math.div($value, $context-font-size) * 1em;
 }
 
-/*# sourceMappingURL=_px-to-em.scss.map */

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

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

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

@@ -4,7 +4,7 @@
 
 @use "sass:math";
 
-@import "../settings/typography-responsive";
+@use "../settings/typography-responsive" as *;
 
 /// Convert pixels to rem
 ///
@@ -23,4 +23,3 @@
   @return math.div($value, $govuk-root-font-size) * 1rem;
 }
 
-/*# sourceMappingURL=_px-to-rem.scss.map */

data/node_modules/govuk-frontend/dist/govuk/utilities/_clearfix.import.scss

@@ -0,0 +1,8 @@
+@use "clearfix.mixin" as mixin;
+
+@import "../tools/exports";
+
+@include govuk-exports("govuk/utilities/clearfix") {
+  @include mixin.styles;
+}
+

data/node_modules/govuk-frontend/dist/govuk/utilities/_clearfix.mixin.scss

@@ -0,0 +1,10 @@
+@use "../base";
+@use "../helpers/clearfix" as *;
+
+/// @access private
+@mixin styles {
+  .govuk-clearfix {
+    @include govuk-clearfix;
+  }
+}
+

data/node_modules/govuk-frontend/dist/govuk/utilities/_clearfix.scss

@@ -1,10 +1,4 @@
-@import "../tools/exports";
-@import "../helpers/clearfix";
+@use "clearfix.mixin" as clearfix;
 
-@include govuk-exports("govuk/utilities/clearfix") {
-  .govuk-clearfix {
-    @include govuk-clearfix;
-  }
-}
+@include clearfix.styles;
 
-/*# sourceMappingURL=_clearfix.scss.map */

data/node_modules/govuk-frontend/dist/govuk/utilities/_index.import.scss

@@ -0,0 +1,3 @@
+@import "clearfix";
+@import "visually-hidden";
+

data/node_modules/govuk-frontend/dist/govuk/utilities/_index.scss

@@ -1,5 +1,3 @@
-@import "../tools/exports";
-@import "clearfix";
-@import "visually-hidden";
+@use "clearfix";
+@use "visually-hidden";
 
-/*# sourceMappingURL=_index.scss.map */

data/node_modules/govuk-frontend/dist/govuk/utilities/_visually-hidden.import.scss

@@ -0,0 +1,8 @@
+@use "visually-hidden.mixin" as mixin;
+
+@import "../tools/exports";
+
+@include govuk-exports("govuk/utilities/visually-hidden") {
+  @include mixin.styles;
+}
+

data/node_modules/govuk-frontend/dist/govuk/utilities/_visually-hidden.mixin.scss

@@ -0,0 +1,14 @@
+@use "../base";
+@use "../helpers/visually-hidden" as *;
+
+/// @access private
+@mixin styles {
+  .govuk-visually-hidden {
+    @include govuk-visually-hidden;
+  }
+
+  .govuk-visually-hidden-focusable {
+    @include govuk-visually-hidden-focusable;
+  }
+}
+

data/node_modules/govuk-frontend/dist/govuk/utilities/_visually-hidden.scss

@@ -1,14 +1,4 @@
-@import "../tools/exports";
-@import "../helpers/visually-hidden";
+@use "visually-hidden.mixin" as visually-hidden;
 
-@include govuk-exports("govuk/utilities/visually-hidden") {
-  .govuk-visually-hidden {
-    @include govuk-visually-hidden;
-  }
+@include visually-hidden.styles;
 
-  .govuk-visually-hidden-focusable {
-    @include govuk-visually-hidden-focusable;
-  }
-}
-
-/*# sourceMappingURL=_visually-hidden.scss.map */

data/node_modules/govuk-frontend/dist/govuk-prototype-kit/init.scss

@@ -1,4 +1,4 @@
-@import "../govuk/tools/if";
+@use "../govuk/tools/if" as *;
 
 $govuk-prototype-kit-major-version: 0 !default;
 
@@ -10,6 +10,5 @@ $govuk-assets-path: govuk-if(
 
 $govuk-global-styles: true !default;
 
-@import "../govuk/index";
+@import "../govuk";
 
-/*# sourceMappingURL=init.scss.map */