govuk_tech_docs 6.3.0.beta → 6.3.0

data/node_modules/govuk-frontend/dist/govuk/settings/_colours-legacy-functional.scss

@@ -0,0 +1,188 @@
+////
+/// @group settings/colours
+////
+@use "../helpers/colour" as *;
+// =============================================================================
+// Legacy variables
+//
+// To help migrate to `govuk-functional-colour`, we're keeping the variables
+// which were previously storing the functional colours. This should reduce
+// breakage as teams upgrade
+// =============================================================================
+
+/// Brand colour
+///
+/// @type Colour
+/// @access public
+/// @deprecated
+///   Variables for applied colours are deprecated. Please use the `govuk-functional-colour`
+///   function instead: `govuk-functional-colour(brand)`.
+$govuk-brand-colour: govuk-functional-colour(brand);
+
+/// Text colour
+///
+/// @type Colour
+/// @access public
+/// @deprecated
+///   Variables for applied colours are deprecated. Please use the `govuk-functional-colour`
+///   function instead: `govuk-functional-colour(text)`.
+$govuk-text-colour: govuk-functional-colour(text);
+
+/// Template background colour
+///
+/// Used by components that want to give the illusion of extending
+/// the template background (such as the footer and cookie banner).
+///
+/// @type Colour
+/// @access public
+/// @deprecated
+///   Variables for applied colours are deprecated. Please use the `govuk-functional-colour`
+///   function instead: `govuk-functional-colour(template-background)`.
+$govuk-template-background-colour: govuk-functional-colour(template-background);
+
+/// Body background colour
+///
+/// @type Colour
+/// @access public
+/// @deprecated
+///   Variables for applied colours are deprecated. Please use the `govuk-functional-colour`
+///   function instead: `govuk-functional-colour(body-background)`.
+$govuk-body-background-colour: govuk-functional-colour(body-background);
+
+/// Text colour for print media
+///
+/// Use 'true black' to avoid printers using colour ink to print body text
+///
+/// @type Colour
+/// @access public
+/// @deprecated
+///   Variables for applied colours are deprecated. Please use the `govuk-functional-colour`
+///   function instead: `govuk-functional-colour(print-text)`.
+$govuk-print-text-colour: govuk-functional-colour(print-text);
+
+/// Secondary text colour
+///
+/// Used in for example 'muted' text and help text.
+///
+/// @type Colour
+/// @access public
+/// @deprecated
+///   Variables for applied colours are deprecated. Please use the `govuk-functional-colour`
+///   function instead: `govuk-functional-colour(secondary-text)`.
+$govuk-secondary-text-colour: govuk-functional-colour(secondary-text);
+
+/// Focus colour
+///
+/// Used for outline (and background, where appropriate) when interactive
+/// elements (links, form controls) have keyboard focus.
+///
+/// @type Colour
+/// @access public
+/// @deprecated
+///   Variables for applied colours are deprecated. Please use the `govuk-functional-colour`
+///   function instead: `govuk-functional-colour(focus)`.
+$govuk-focus-colour: govuk-functional-colour(focus);
+
+/// Focused text colour
+///
+/// Ensure that the contrast between the text and background colour passes
+/// WCAG Level AA contrast requirements.
+///
+/// @type Colour
+/// @access public
+/// @deprecated
+///   Variables for applied colours are deprecated. Please use the `govuk-functional-colour`
+///   function instead: `govuk-functional-colour(focus-text)`.
+$govuk-focus-text-colour: govuk-functional-colour(focus-text);
+
+/// Error colour
+///
+/// Used to highlight error messages and form controls in an error state
+///
+/// @type Colour
+/// @access public
+/// @deprecated
+///   Variables for applied colours are deprecated. Please use the `govuk-functional-colour`
+///   function instead: `govuk-functional-colour(error)`.
+$govuk-error-colour: govuk-functional-colour(error);
+
+/// Success colour
+///
+/// Used to highlight success messages and banners
+///
+/// @type Colour
+/// @access public
+/// @deprecated
+///   Variables for applied colours are deprecated. Please use the `govuk-functional-colour`
+///   function instead: `govuk-functional-colour(success)`.
+$govuk-success-colour: govuk-functional-colour(success);
+
+/// Border colour
+///
+/// Used in for example borders, separators, rules and keylines.
+///
+/// @type Colour
+/// @access public
+/// @deprecated
+///   Variables for applied colours are deprecated. Please use the `govuk-functional-colour`
+///   function instead: `govuk-functional-colour(border)`.
+$govuk-border-colour: govuk-functional-colour(border);
+
+/// Input border colour
+///
+/// Used for form inputs and controls
+///
+/// @type Colour
+/// @access public
+/// @deprecated
+///   Variables for applied colours are deprecated. Please use the `govuk-functional-colour`
+///   function instead: `govuk-functional-colour(input-border)`.
+$govuk-input-border-colour: govuk-functional-colour(input-border);
+
+/// Input hover colour
+///
+/// Used for hover states on form controls
+///
+/// @type Colour
+/// @access public
+/// @deprecated
+///   Variables for applied colours are deprecated. Please use the `govuk-functional-colour`
+///   function instead: `govuk-functional-colour(hover)`.
+$govuk-hover-colour: govuk-functional-colour(hover);
+
+/// Link colour
+///
+/// @type Colour
+/// @access public
+/// @deprecated
+///   Variables for applied colours are deprecated. Please use the `govuk-functional-colour`
+///   function instead: `govuk-functional-colour(link)`.
+$govuk-link-colour: govuk-functional-colour(link);
+
+/// Visited link colour
+///
+/// @type Colour
+/// @access public
+/// @deprecated
+///   Variables for applied colours are deprecated. Please use the `govuk-functional-colour`
+///   function instead: `govuk-functional-colour(link-visited)`.
+$govuk-link-visited-colour: govuk-functional-colour(link-visited);
+
+/// Link hover colour
+///
+/// @type Colour
+/// @access public
+/// @deprecated
+///   Variables for applied colours are deprecated. Please use the `govuk-functional-colour`
+///   function instead: `govuk-functional-colour(link-hover)`.
+$govuk-link-hover-colour: govuk-functional-colour(link-hover);
+
+/// Active link colour
+///
+/// @type Colour
+/// @access public
+/// @deprecated
+///   Variables for applied colours are deprecated. Please use the `govuk-functional-colour`
+///   function instead: `govuk-functional-colour(link-active)`.
+$govuk-link-active-colour: govuk-functional-colour(link-active);
+

data/node_modules/govuk-frontend/dist/govuk/settings/_colours-organisations.import.scss

@@ -0,0 +1,2 @@
+@forward "colours-organisations";
+

data/node_modules/govuk-frontend/dist/govuk/settings/_colours-organisations.scss

@@ -1,4 +1,4 @@
-@import "../settings/warnings";
+@use "warnings--internal";
 
 ////
 /// @group settings/colours
@@ -115,22 +115,3 @@ $govuk-colours-organisations: (
   )
 ) !default;
 
-/// Organisation colour aliases
-///
-/// Some organisations have been renamed within our code over time. Here we
-/// map the prior key to the new equivalent key.
-///
-/// Note: This is for internal renames only. If a department has changed name
-/// or brand colour in a machinery of government change, it should be added to
-/// $govuk-colours-organisations as a new entry with any superseded
-/// organisations marked deprecated.
-///
-/// @type Map
-///
-/// @access private
-
-$_govuk-colours-organisations-aliases: (
-  "department-for-business-and-trade": "department-for-business-trade"
-);
-
-/*# sourceMappingURL=_colours-organisations.scss.map */

data/node_modules/govuk-frontend/dist/govuk/settings/{_colours-palette.scss → _colours-palette--internal.scss}

@@ -11,7 +11,7 @@
 ///
 /// @access private
 
-$_govuk-palette: (
+$govuk-palette: (
   "blue": (
     "primary": #1d70b8,
     "tint-25": #5694ca,
@@ -112,7 +112,7 @@ $_govuk-palette: (
 ///   the brand colours were introduced
 ///
 /// @access private
-$_govuk-pre-brand-colours: (
+$govuk-pre-brand-colours: (
   "light-pink": "magenta" "tint-50",
   "pink": "magenta" "primary",
   "light-green": "green" "tint-25",
@@ -126,4 +126,3 @@ $_govuk-pre-brand-colours: (
   "light-grey": "black" "tint-95"
 );
 
-/*# sourceMappingURL=_colours-palette.scss.map */

data/node_modules/govuk-frontend/dist/govuk/settings/_custom-properties.import.scss

@@ -0,0 +1,2 @@
+@forward "custom-properties";
+

data/node_modules/govuk-frontend/dist/govuk/settings/_custom-properties.scss

@@ -15,4 +15,3 @@
 
 $govuk-output-custom-properties: true !default;
 
-/*# sourceMappingURL=_custom-properties.scss.map */

data/node_modules/govuk-frontend/dist/govuk/settings/_global-styles.import.scss

@@ -0,0 +1,2 @@
+@forward "global-styles";
+

data/node_modules/govuk-frontend/dist/govuk/settings/_global-styles.scss

@@ -12,4 +12,3 @@
 
 $govuk-global-styles: false !default;
 
-/*# sourceMappingURL=_global-styles.scss.map */

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

@@ -0,0 +1,24 @@
+// The order we import settings in is important, as some settings files rely on
+// others
+
+@import "assets";
+
+@import "warnings";
+@import "global-styles";
+
+@import "custom-properties";
+
+@import "media-queries";
+
+@import "colours-organisations";
+@import "colours-functional";
+@import "colours-legacy-functional";
+
+@import "spacing";
+@import "measurements";
+
+@import "typography-font";
+@import "typography-responsive";
+
+@import "links";
+

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

@@ -1,25 +1,24 @@
 // The order we import settings in is important, as some settings files rely on
 // others
 
-@import "assets";
+@forward "assets";
 
-@import "warnings";
-@import "global-styles";
+@forward "warnings";
+@forward "global-styles";
 
-@import "custom-properties";
+@forward "custom-properties";
 
-@import "media-queries";
+@forward "media-queries";
 
-@import "colours-palette";
-@import "colours-organisations";
-@import "colours-functional";
+@forward "colours-organisations";
+@forward "colours-functional";
+@forward "colours-legacy-functional";
 
-@import "spacing";
-@import "measurements";
+@forward "spacing";
+@forward "measurements";
 
-@import "typography-font";
-@import "typography-responsive";
+@forward "typography-font";
+@forward "typography-responsive";
 
-@import "links";
+@forward "links";
 
-/*# sourceMappingURL=_index.scss.map */

data/node_modules/govuk-frontend/dist/govuk/settings/_links.import.scss

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

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

@@ -47,4 +47,3 @@ $govuk-link-underline-offset: 0.1578em !default;
 
 $govuk-link-hover-underline-thickness: string.unquote("max(3px, .1875rem, .12em)") !default;
 
-/*# sourceMappingURL=_links.scss.map */

data/node_modules/govuk-frontend/dist/govuk/settings/_measurements.import.scss

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

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

@@ -1,3 +1,5 @@
+@use "sass:math";
+
 ////
 /// @group settings/layout
 ////
@@ -11,8 +13,6 @@
 /// @type Number
 /// @access public
 
-@use "sass:math";
-
 $govuk-page-width: 960px !default;
 
 /// Map of grid column widths
@@ -96,4 +96,3 @@ $govuk-focus-width: 3px !default;
 
 $govuk-hover-width: 10px !default;
 
-/*# sourceMappingURL=_measurements.scss.map */

data/node_modules/govuk-frontend/dist/govuk/settings/_media-queries.import.scss

@@ -0,0 +1,2 @@
+@forward "media-queries";
+

data/node_modules/govuk-frontend/dist/govuk/settings/_media-queries.scss

@@ -13,4 +13,3 @@ $govuk-breakpoints: (
   desktop: 769px
 ) !default;
 
-/*# sourceMappingURL=_media-queries.scss.map */

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

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

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

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

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

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

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,13 +8,19 @@
 /// @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
@@ -23,9 +29,9 @@ $_govuk-imported-modules: () !default;
 
 @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 */