govuk_tech_docs 5.2.1 → 6.0.0.beta

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

@@ -0,0 +1,366 @@
+////
+/// @group settings/colours
+////
+
+@import "../helpers/colour";
+
+/// Default definitions of the functional colours
+///
+/// @type Map
+///
+/// @see {variable} $govuk-functional-colours
+///
+/// @access public
+$govuk-default-functional-colours: (
+  (
+    "brand": (
+      name: "blue"
+    ),
+    "text": (
+      name: "black"
+    ),
+    // The background colour of the template. This is intended to be the same
+    // as `surface-background` for the purposes of making the Footer and Cookie
+    // banner components merge seamlessly with the template.
+    "template-background": (
+        name: "blue",
+        variant: "tint-95"
+      ),
+    "body-background": (
+      name: "white"
+    ),
+    // Use 'true black' to avoid printers using colour ink to print body text
+    "print-text": #000000,
+    // Used in for example 'muted' text and help text.
+    "secondary-text": (
+        name: "black",
+        variant: "tint-25"
+      ),
+    // Used for outline (and background, where appropriate) when interactive
+    // elements (links, form controls) have keyboard focus.
+    "focus": (
+        name: "yellow"
+      ),
+    // Ensure that the contrast between the text and background colour passes
+    // WCAG Level AA contrast requirements.
+    "focus-text": (
+        name: "black"
+      ),
+    // Used to highlight error messages and form controls in an error state
+    "error": (
+        name: "red"
+      ),
+    // Used to highlight success messages and banners
+    "success": (
+        name: "green"
+      ),
+    // Used in for example borders, separators, rules and keylines.
+    "border": (
+        name: "black",
+        variant: "tint-80"
+      ),
+    // Used for form inputs and controls
+    "input-border": (
+        name: "black"
+      ),
+    // Used for hover states on form controls
+    "hover": (
+        name: "black",
+        variant: "tint-80"
+      ),
+    // Standard links (on white)
+    "link": (
+        name: "blue",
+        variant: "shade-10"
+      ),
+    "link-visited": (
+      name: "purple"
+    ),
+    "link-hover": (
+      name: "blue",
+      variant: "shade-50"
+    ),
+    "link-active": (
+      name: "black"
+    ),
+    // 'Surfaces' are our name for components that have different colour
+    // palettes to typical page content. This is the generic surface.
+    "surface-background": (
+        name: "blue",
+        variant: "tint-95"
+      ),
+    "surface-text": (
+      name: "black"
+    ),
+    "surface-border": (
+      name: "blue",
+      variant: "tint-50"
+    )
+  )
+);
+
+/// Functional colours for the GOV.UK palette.
+///
+/// Each functional colour is represented by a name (for example `'brand'`) to
+/// which the map associates either:
+///
+///   - a Sass colour (like `#1d70b8`)
+///   - a Sass map with a `name` and an optional `variant` properties, referring
+///     to one of the colours in the colour palette (like `(name: 'blue',
+///     variant: 'primary')`). `variant` defaults to `'primary'` if omitted.
+///
+/// Use the `govuk-functional-colour` function to access these colours.
+///
+/// Customise functional colours by defining $govuk-functional-colours with a
+/// map of the colours that you want to change before importing GOV.UK Frontend.
+/// These will then be merged with the default colours. You can only redefine
+/// existing colours.
+///
+/// @example scss – Redefining functional colours by setting them before import
+///
+///   // These will be merged with the default functional colours
+///   $govuk-functional-colours: (
+///     // set the 'brand' colour to the 'primary' variant of 'purple'
+///     brand: (name: 'purple'),
+///     // set the 'template-background' colour to the 'tint-95' variant of 'purple'
+///     template-background: (name: 'purple', variant: 'tint-95'),
+///     // set the 'text' colour to an arbitrary colour `#221133`
+///     text: #221133
+///   );
+///
+/// @see {function} govuk-functional-colour
+///
+/// @type Map
+///
+/// @access public
+$govuk-functional-colours: $govuk-default-functional-colours !default;
+$govuk-functional-colours: _govuk-define-functional-colours(
+  $govuk-functional-colours,
+  $defaults: $govuk-default-functional-colours
+);
+
+// =============================================================================
+// 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
+// =============================================================================
+
+// Because the file may be imported multiple times, subsequent imports will see
+// the legacy variable and warn when they shouldn't so we need to track those
+$_govuk-deprecated-applied-colour-variables: () !default;
+
+/// Warn if a given legacy applied colour variable is set
+///
+/// @param {String} Name of variable to check
+/// @access private
+@mixin _warn-if-applied-colour-variable-set($functional-colour-name) {
+  @if not index($_govuk-deprecated-applied-colour-variables, $functional-colour-name) {
+    @if variable-exists("govuk-#{$functional-colour-name}-colour") {
+      $deprecation-message: "Setting \`$govuk-#{$functional-colour-name}-colour\` no longer has any effect. Use \`$govuk-functional-colours: (#{$functional-colour-name}: <NEW_COLOUR_VALUE>);\` instead.";
+
+      @include _warning("applied-colour-variables", $deprecation-message);
+    }
+
+    $_govuk-deprecated-applied-colour-variables: append(
+      $_govuk-deprecated-applied-colour-variables,
+      $functional-colour-name
+    ) !global;
+  }
+}
+
+@include _warn-if-applied-colour-variable-set(brand);
+/// 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);
+
+@include _warn-if-applied-colour-variable-set(text);
+/// 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);
+
+@include _warn-if-applied-colour-variable-set(template-background);
+/// 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);
+
+@include _warn-if-applied-colour-variable-set(body-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);
+
+@include _warn-if-applied-colour-variable-set(print-text);
+/// 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);
+
+@include _warn-if-applied-colour-variable-set(secondary-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);
+
+@include _warn-if-applied-colour-variable-set(focus);
+/// 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);
+
+@include _warn-if-applied-colour-variable-set(focus-text);
+/// 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);
+
+@include _warn-if-applied-colour-variable-set(error);
+/// 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);
+
+@include _warn-if-applied-colour-variable-set(success);
+/// 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(error)`.
+$govuk-success-colour: govuk-functional-colour(success);
+
+@include _warn-if-applied-colour-variable-set(border);
+/// 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);
+
+@include _warn-if-applied-colour-variable-set(input-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);
+
+@include _warn-if-applied-colour-variable-set(hover);
+/// 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);
+
+@include _warn-if-applied-colour-variable-set(link);
+/// 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);
+
+@include _warn-if-applied-colour-variable-set(link-visited);
+/// 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);
+
+@include _warn-if-applied-colour-variable-set(link-hover);
+/// 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);
+
+@include _warn-if-applied-colour-variable-set(link-active);
+/// 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);
+
+/*# sourceMappingURL=_colours-functional.scss.map */

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

@@ -4,20 +4,7 @@
 /// @group settings/colours
 ////
 
-/// Feature flag for updated organisation list and colours
-///
-/// When set to true, $govuk-colours-organisations will use the new
-/// organisation list and colour selection.
-///
-/// Should be removed in 6.0.
-///
-/// @type Boolean
-/// @access public
-/// @deprecated Using new organisation colours will become the default in Frontend v6.0.
-
-$govuk-new-organisation-colours: false !default;
-
-/// Current organisation colours
+/// Organisation colour palette
 ///
 /// @type Map
 ///
@@ -27,12 +14,12 @@ $govuk-new-organisation-colours: false !default;
 ///   white, to be used for copy and meet the AAA (large text) and AA (smaller
 ///   copy) WCAG guidelines.
 /// @prop $organisation.deprecation-message - Marks this organisation as
-///   deprecated (usually because it has ceased to exist). Value is the
-///   deprecation message output to the terminal when compiling.
+///   deprecated (usually because it has ceased to exist). The value is the
+///   deprecation message output to the terminal when compiling Sass.
 ///
-/// @access private
+/// @access public
 
-$_govuk-organisation-colours: (
+$govuk-colours-organisations: (
   "attorney-generals-office": (
     colour: #a91c8e
   ),
@@ -46,61 +33,20 @@ $_govuk-organisation-colours: (
     colour: #e52d13,
     contrast-safe: #e02c13
   ),
-  "department-for-business-energy-industrial-strategy": (
-    colour: #003479,
-    deprecation-message:
-      "`department-for-business-energy-industrial-strategy` was dissolved in 2023. It was replaced by `department-for-business-trade`, `department-for-energy-security-net-zero` and `department-science-innovation-technology`."
-  ),
-  "department-for-business-innovation-skills": (
-    colour: #003479,
-    deprecation-message:
-      "`department-for-business-innovation-skills` became `department-for-business-energy-industrial-strategy` in 2016. As of 2023, it is equivalent to `department-for-business-trade` or `department-science-innovation-technology`."
-  ),
-  "department-for-communities-local-government": (
-    colour: #009999,
-    contrast-safe: #008080,
-    deprecation-message:
-      "`department-for-communities-local-government` became `ministry-of-housing-communities-local-government` in 2018."
-  ),
   "department-for-culture-media-sport": (
     colour: #ed1588,
     contrast-safe: #d6177a
   ),
-  "department-for-digital-culture-media-sport": (
-    colour: #d40072,
-    deprecation-message:
-      "`department-for-digital-culture-media-sport` became `department-for-culture-media-sport` in 2023."
-  ),
   "department-for-education": (
     colour: #003764
   ),
   "department-for-energy-security-net-zero": (
-    colour: #00a33b,
-    contrast-safe: #00852f
+    colour: #003479
   ),
   "department-for-environment-food-rural-affairs": (
     colour: #00a33b,
     contrast-safe: #008531
   ),
-  "department-for-exiting-the-european-union": (
-    colour: #009fe3,
-    contrast-safe: #007db6,
-    deprecation-message: "`department-for-exiting-the-european-union` was dissolved in 2020."
-  ),
-  "department-for-international-development": (
-    colour: #002878,
-    deprecation-message:
-      "`department-for-international-development` was merged into `foreign-commonwealth-development-office` in 2020."
-  ),
-  "department-for-international-trade": (
-    colour: #cf102d,
-    deprecation-message: "`department-for-international-trade` was merged into `department-for-business-trade` in 2023."
-  ),
-  "department-for-levelling-up-housing-communities": (
-    colour: #012169,
-    deprecation-message:
-      "`department-for-levelling-up-housing-communities` was renamed to `ministry-of-housing-communities-local-government` in 2024."
-  ),
   "department-for-science-innovation-technology": (
     colour: #00f8f8,
     contrast-safe: #008180
@@ -112,37 +58,18 @@ $_govuk-organisation-colours: (
     colour: #00bcb5,
     contrast-safe: #00857e
   ),
-  "department-of-energy-climate-change": (
-    colour: #009ddb,
-    contrast-safe: #007db3,
-    deprecation-message:
-      "`department-of-energy-climate-change` was merged into `department-for-business-energy-industrial-strategy` in 2016. As of 2023, it is equivalent to `department-for-energy-security-net-zero`."
-  ),
-  "department-of-health": (
-    colour: #00ad93,
-    contrast-safe: #008573,
-    deprecation-message: "`department-of-health` became `department-of-health-social-care` in 2018."
-  ),
   "department-of-health-social-care": (
     colour: #00a990,
     contrast-safe: #008674
   ),
-  "foreign-commonwealth-office": (
-    colour: #003e74,
-    deprecation-message: "`foreign-commonwealth-office` became `foreign-commonwealth-development-office` in 2018."
-  ),
   "foreign-commonwealth-development-office": (
     colour: #012069
   ),
-  "government-equalities-office": (
-    colour: #0056b8,
-    deprecation-message: "`government-equalities-office` is deprecated. Use `cabinet-office` instead."
-  ),
   "hm-government": (
     colour: #266ebc
   ),
   "hm-revenue-customs": (
-    colour: #008476
+    colour: #008670
   ),
   "hm-treasury": (
     colour: #b2292e
@@ -171,14 +98,6 @@ $_govuk-organisation-colours: (
   "office-of-the-leader-of-the-house-of-lords": (
     colour: #9c182f
   ),
-  "office-of-the-secretary-of-state-for-scotland": (
-    colour: #00205c,
-    deprecation-message: "`office-of-the-secretary-of-state-for-scotland` was renamed to `scotland-office` in 2024."
-  ),
-  "office-of-the-secretary-of-state-for-wales": (
-    colour: #a8353a,
-    deprecation-message: "`office-of-the-secretary-of-state-for-wales` was renamed to `wales-office` in 2024."
-  ),
   "prime-ministers-office-10-downing-street": (
     colour: #0b0c0c
   ),
@@ -191,173 +110,10 @@ $_govuk-organisation-colours: (
   "uk-export-finance": (
     colour: #cf102d
   ),
-  "uk-trade-investment": (
-    colour: #c80651,
-    deprecation-message:
-      "`uk-trade-investment` became `department-for-international-trade` in 2016. As of 2023, it is equivalent to `department-for-business-trade`."
-  ),
   "wales-office": (
     colour: #a33038
   )
-);
-
-/// Legacy organisation colours
-///
-/// These are the colours included with Frontend prior to 5.3.0. They will be
-/// removed in a future major version of Frontend.
-///
-/// @type Map
-///
-/// @prop $organisation.colour - Colour for the given `$organisation`
-/// @prop $organisation.colour-websafe - Optional alternative shade of the
-///   organisation colour. Despite the name, is not guaranteed to be websafe
-///   nor provide better contrast than the base colour.
-///
-/// @access private
-/// @deprecated Migrate to using the new organisation colour palette instead.
-
-$_govuk-legacy-organisation-colours: (
-  "attorney-generals-office": (
-    colour: #9f1888,
-    colour-websafe: #a03a88
-  ),
-  "cabinet-office": (
-    colour: #005abb,
-    colour-websafe: #347da4
-  ),
-  "civil-service": (
-    colour: #af292e
-  ),
-  "department-for-business-innovation-skills": (
-    colour: #003479,
-    colour-websafe: #347da4
-  ),
-  "department-for-communities-local-government": (
-    colour: #009999,
-    colour-websafe: #37836e
-  ),
-  "department-for-culture-media-sport": (
-    colour: #d40072,
-    colour-websafe: #a03155
-  ),
-  "department-for-education": (
-    colour: #003a69,
-    colour-websafe: #347ca9
-  ),
-  "department-for-environment-food-rural-affairs": (
-    colour: #00a33b,
-    colour-websafe: #008938
-  ),
-  "department-for-international-development": (
-    colour: #002878,
-    colour-websafe: #405e9a
-  ),
-  "department-for-international-trade": (
-    colour: #cf102d,
-    colour-websafe: #005ea5
-  ),
-  "department-for-business-trade": (
-    colour: #cf102d,
-    colour-websafe: #005ea5
-  ),
-  "department-for-levelling-up-housing-communities": (
-    colour: #012169
-  ),
-  "department-for-transport": (
-    colour: #006c56,
-    colour-websafe: #398373
-  ),
-  "department-for-work-pensions": (
-    colour: #00beb7,
-    colour-websafe: #37807b
-  ),
-  "department-of-energy-climate-change": (
-    colour: #009ddb,
-    colour-websafe: #2b7cac
-  ),
-  "department-of-health": (
-    colour: #00ad93,
-    colour-websafe: #39836e
-  ),
-  "foreign-commonwealth-development-office": (
-    colour: #012169
-  ),
-  "foreign-commonwealth-office": (
-    colour: #003e74,
-    colour-websafe: #406e97
-  ),
-  "government-equalities-office": (
-    colour: #9325b2
-  ),
-  "hm-government": (
-    colour: #0076c0,
-    colour-websafe: #347da4
-  ),
-  "hm-revenue-customs": (
-    colour: #009390,
-    colour-websafe: #008670
-  ),
-  "hm-treasury": (
-    colour: #af292e,
-    colour-websafe: #832322
-  ),
-  "home-office": (
-    colour: #9325b2,
-    colour-websafe: #9440b2
-  ),
-  "ministry-of-defence": (
-    colour: #4d2942,
-    colour-websafe: #5a5c92
-  ),
-  "ministry-of-justice": (
-    colour: #231f20,
-    colour-websafe: #5a5c92
-  ),
-  "northern-ireland-office": (
-    colour: #002663,
-    colour-websafe: #3e598c
-  ),
-  "office-of-the-advocate-general-for-scotland": (
-    colour: #002663,
-    colour-websafe: #005ea5
-  ),
-  "office-of-the-leader-of-the-house-of-commons": (
-    colour: #317023,
-    colour-websafe: #005f8f
-  ),
-  "office-of-the-leader-of-the-house-of-lords": (
-    colour: #9c132e,
-    colour-websafe: #c2395d
-  ),
-  "scotland-office": (
-    colour: #002663,
-    colour-websafe: #405c8a
-  ),
-  "uk-export-finance": (
-    colour: #005747,
-    colour-websafe: #005ea5
-  ),
-  "uk-trade-investment": (
-    colour: #c80651,
-    colour-websafe: #005ea5
-  ),
-  "wales-office": (
-    colour: #a33038,
-    colour-websafe: #7a242a
-  )
-);
-
-/// Set public organisation colours variable to one of the two maps.
-/// Users can also pass their own map to this to override it entirely.
-///
-/// @type Map
-/// @access public
-
-$govuk-colours-organisations: $_govuk-legacy-organisation-colours !default;
-
-@if $govuk-new-organisation-colours and $govuk-colours-organisations == $_govuk-legacy-organisation-colours {
-  $govuk-colours-organisations: $_govuk-organisation-colours;
-}
+) !default;
 
 /// Organisation colour aliases
 ///
@@ -374,9 +130,7 @@ $govuk-colours-organisations: $_govuk-legacy-organisation-colours !default;
 /// @access private
 
 $_govuk-colours-organisations-aliases: (
-  "department-for-business-and-trade": "department-for-business-trade",
-  "department-for-communities-and-local-government": "department-for-communities-local-government",
-  "department-for-levelling-up-housing-and-communities": "department-for-levelling-up-housing-communities"
+  "department-for-business-and-trade": "department-for-business-trade"
 );
 
 /*# sourceMappingURL=_colours-organisations.scss.map */