govuk_tech_docs 4.4.0 → 5.0.1

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

@@ -3,5 +3,6 @@
 @import "image-url";
 @import "px-to-em";
 @import "px-to-rem";
+@import "rebrand";
 
 /*# sourceMappingURL=_index.scss.map */

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

@@ -0,0 +1,65 @@
+////
+/// @group tools
+////
+
+/// Wraps rebranded properties in the feature flag selector
+///
+/// @example scss - Wrap a block of multiple properties
+///   .foo {
+///     border-width: 1px;
+///     border-colour: #fff;
+///
+///     @include _govuk-rebrand() {
+///       border-width: 10px;
+///       border-colour: #000;
+///     }
+///   }
+///
+/// @example scss - Wrap a single property
+///   .foo {
+///     @include _govuk-rebrand("background-color", $from: #fff, $to: #000)
+///   }
+///
+///
+/// @param {String} $property - The name of the property being rebranded
+/// @param {String} $from - The original value of the property
+/// @param {String} $to - The rebranded value of the property
+/// @throw if `$property` is set but `$from` or `$to` are missing
+/// @access private
+@mixin _govuk-rebrand($property: null, $from: null, $to: null) {
+  @if $property {
+    @if not $from {
+      @error "`_govuk-rebrand` needs the original value, `$from`";
+    }
+
+    @if not $to {
+      @error "`_govuk-rebrand` needs the rebranded value, `$to`";
+    }
+
+    #{$property}: #{$from};
+
+    @include _govuk-rebrand-wrapper {
+      #{$property}: #{$to};
+    }
+  } @else {
+    @include _govuk-rebrand-wrapper {
+      @content;
+    }
+  }
+}
+
+@mixin _govuk-rebrand-wrapper() {
+  $selector: "#{&}";
+
+  @if $selector == ".govuk-template" {
+    @at-root .govuk-template--rebranded {
+      @content;
+    }
+  } @else {
+    .govuk-template--rebranded & {
+      @content;
+    }
+  }
+}
+
+/*# sourceMappingURL=_rebrand.scss.map */

data/node_modules/govuk-frontend/dist/govuk-prototype-kit/functions.js

@@ -0,0 +1,25 @@
+const { addFunction } = require('govuk-prototype-kit').views
+const config = require('govuk-prototype-kit/lib/config.js').getConfig()
+
+/**
+ * Adds a global function to the nunjucks env of prototypes to define the state
+ * of `govukRebrand`.
+ *
+ * Only applies the rebrand if the following is present in a user's prototype config:
+ *
+ * "plugins": {
+ *  "govuk-frontend": {
+ *    "rebrand": true
+ *  }
+ * }
+ *
+ * Steps through each required param to check that they're present, then returns
+ * the state of `rebrand`. If any of the params aren't present or `rebrand` is
+ * falsey, return a falsey value.
+ *
+ * We're finicky about checking each param because, besides the fact that we don't
+ * know if each param might be present, `getConfig` by default swallows the error
+ * if ./app/config.json isn't present so this makes sure that a user's prototype
+ * still runs even if their config doesn't exist for some reason.
+ */
+addFunction('govukRebrand', () => config?.plugins?.['govuk-frontend']?.rebrand)

data/package-lock.json

@@ -7,7 +7,7 @@
       "name": "tech-docs-gem",
       "license": "MIT",
       "dependencies": {
-        "govuk-frontend": "~5.9.0"
+        "govuk-frontend": "~5.11.0"
       },
       "devDependencies": {
         "jasmine-browser-runner": "^2.5.0",
@@ -1663,9 +1663,9 @@
       }
     },
     "node_modules/govuk-frontend": {
-      "version": "5.9.0",
-      "resolved": "https://registry.npmjs.org/govuk-frontend/-/govuk-frontend-5.9.0.tgz",
-      "integrity": "sha512-8NzmyoDtRFYyHs413DfNPR8Zo6qw6Q02Mruxml/Yfy+EueaOI/JZ4gVM8d0pqzJmTiMcJuHhvxqYEgBRmqeoyA==",
+      "version": "5.11.0",
+      "resolved": "https://registry.npmjs.org/govuk-frontend/-/govuk-frontend-5.11.0.tgz",
+      "integrity": "sha512-RYZDEF1J6nVw5XauQGH+91qplExgHUXfXII7dtIme6I4u3eSvU59yZ0/EFKEwRgTslSqlhJODOnAi5rnQFU5Gw==",
       "license": "MIT",
       "engines": {
         "node": ">= 4.2.0"
@@ -5546,9 +5546,9 @@
       "dev": true
     },
     "govuk-frontend": {
-      "version": "5.9.0",
-      "resolved": "https://registry.npmjs.org/govuk-frontend/-/govuk-frontend-5.9.0.tgz",
-      "integrity": "sha512-8NzmyoDtRFYyHs413DfNPR8Zo6qw6Q02Mruxml/Yfy+EueaOI/JZ4gVM8d0pqzJmTiMcJuHhvxqYEgBRmqeoyA=="
+      "version": "5.11.0",
+      "resolved": "https://registry.npmjs.org/govuk-frontend/-/govuk-frontend-5.11.0.tgz",
+      "integrity": "sha512-RYZDEF1J6nVw5XauQGH+91qplExgHUXfXII7dtIme6I4u3eSvU59yZ0/EFKEwRgTslSqlhJODOnAi5rnQFU5Gw=="
     },
     "graceful-fs": {
       "version": "4.2.6",

data/package.json

@@ -8,7 +8,7 @@
     "test-server": "jasmine-browser-runner serve --config=spec/javascripts/support/jasmine-browser.mjs"
   },
   "dependencies": {
-    "govuk-frontend": "~5.9.0"
+    "govuk-frontend": "~5.11.0"
   },
   "devDependencies": {
     "jasmine-browser-runner": "^2.5.0",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: govuk_tech_docs
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 5.0.1
 platform: ruby
 authors:
 - Government Digital Service
@@ -489,6 +489,7 @@ files:
 - lib/source/layouts/layout.erb
 - lib/source/search/index.html.erb
 - lib/source/stylesheets/manifest.css
+- node_modules/govuk-frontend/dist/govuk-prototype-kit/functions.js
 - node_modules/govuk-frontend/dist/govuk-prototype-kit/init.js
 - node_modules/govuk-frontend/dist/govuk-prototype-kit/init.scss
 - node_modules/govuk-frontend/dist/govuk/_base.scss
@@ -509,6 +510,14 @@ files:
 - node_modules/govuk-frontend/dist/govuk/assets/images/govuk-icon-mask.svg
 - node_modules/govuk-frontend/dist/govuk/assets/images/govuk-opengraph-image.png
 - node_modules/govuk-frontend/dist/govuk/assets/manifest.json
+- node_modules/govuk-frontend/dist/govuk/assets/rebrand/images/favicon.ico
+- node_modules/govuk-frontend/dist/govuk/assets/rebrand/images/favicon.svg
+- node_modules/govuk-frontend/dist/govuk/assets/rebrand/images/govuk-crest.svg
+- node_modules/govuk-frontend/dist/govuk/assets/rebrand/images/govuk-icon-180.png
+- node_modules/govuk-frontend/dist/govuk/assets/rebrand/images/govuk-icon-192.png
+- node_modules/govuk-frontend/dist/govuk/assets/rebrand/images/govuk-icon-512.png
+- node_modules/govuk-frontend/dist/govuk/assets/rebrand/images/govuk-icon-mask.svg
+- node_modules/govuk-frontend/dist/govuk/assets/rebrand/images/govuk-opengraph-image.png
 - node_modules/govuk-frontend/dist/govuk/common/closest-attribute-value.mjs
 - node_modules/govuk-frontend/dist/govuk/common/configuration.mjs
 - node_modules/govuk-frontend/dist/govuk/common/govuk-frontend-version.mjs
@@ -693,6 +702,7 @@ files:
 - node_modules/govuk-frontend/dist/govuk/tools/_index.scss
 - node_modules/govuk-frontend/dist/govuk/tools/_px-to-em.scss
 - node_modules/govuk-frontend/dist/govuk/tools/_px-to-rem.scss
+- node_modules/govuk-frontend/dist/govuk/tools/_rebrand.scss
 - node_modules/govuk-frontend/dist/govuk/utilities/_all.scss
 - node_modules/govuk-frontend/dist/govuk/utilities/_clearfix.scss
 - node_modules/govuk-frontend/dist/govuk/utilities/_index.scss