Add showBreadcrumbs option. Fixes #293

x-govuk · Jul 22, 2024 · 5481cb5 · 5481cb5
1 parent a4e6bff
commit 5481cb5
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/docs/options.md b/docs/options.md
@@ -87,6 +87,11 @@ module.exports = function(eleventyConfig) {
       { text: "string" },
       { text: "Path to SCSS file, relative to input directory, containing [GOV.UK Frontend settings](https://frontend.design-system.service.gov.uk/sass-api-reference/) (default is `{dir.input}/sass/_settings.scss`)." | markdown }
     ],
+    [
+      { text: "showBreadcrumbs" },
+      { text: "boolean" },
+      { text: "Show breadcrumb navigation (default is `true` with nested pages)." | markdown }
+    ],
     [
       { text: "stylesheets" },
       { text: "Array" },

diff --git a/layouts/base.njk b/layouts/base.njk
@@ -16,7 +16,7 @@
 {% set breadcrumbItems = collections.all | eleventyNavigationBreadcrumb(eleventyNavigation.key, { includeSelf: includeInBreadcrumbs }) | itemsFromNavigation(page.url, options) if eleventyNavigation.key %}
 {% set minimumItemsInBreadcrumbs = 0 %}
 {% set minimumItemsInBreadcrumbs = 1 if options.parentSite %}
-{% set showBreadcrumbs = breadcrumbItems | length > minimumItemsInBreadcrumbs %}
+{% set showBreadcrumbs = options.showBreadcrumbs and breadcrumbItems | length > minimumItemsInBreadcrumbs %}
 
 {# Components #}
 {% from "govuk/components/breadcrumbs/macro.njk" import govukBreadcrumbs %}